class_docstr: !
  @brief Performs analysis of output dynamic of the hysteresis oscillatory network to extract information about clusters or color allocation.
docstr: !
  @brief Returns list of clusters in line with state of ocillators (phases).
  
  @param[in] tolerance (double): Maximum error for allocation of synchronous ensemble oscillators.
  @param[in] threshold_steps (uint): Number of steps from the end of simulation that should be analysed for ensemble allocation.
              If amount of simulation steps has been less than threshold steps than amount of steps will be reduced to amount
              of simulation steps.
  
  @remark Results can be obtained only after network simulation (graph processing by the network).
  
  @return (list) List of clusters, for example [ [cluster1], [cluster2], ... ].
  
  @see allocate_map_coloring()
docstr_tok: ["!","@","brief","Returns","list","of","clusters","in","line","with","state","of","ocillators","(","phases",")",".","@","param","[","in","]","tolerance","(","double",")",":","Maximum","error","for","allocation","of","synchronous","ensemble","oscillators",".","@","param","[","in","]","threshold_steps","(","uint",")",":","Number","of","steps","from","the","end","of","simulation","that","should","be","analysed","for","ensemble","allocation",".","If","amount","of","simulation","steps","has","been","less","than","threshold","steps","than","amount","of","steps","will","be","reduced","to","amount","of","simulation","steps",".","@","remark","Results","can","be","obtained","only","after","network","simulation","(","graph","processing","by","the","network",")",".","@","return","(","list",")","List","of","clusters",",","for","example","[","[","cluster1","]",",","[","cluster2","]",",","...","]",".","@","see","allocate_map_coloring","(",")"]
code: def allocate_clusters(self, tolerance=0.1, threshold_steps=10):
      """!
      @brief Returns list of clusters in line with state of ocillators (phases).
  
      @param[in] tolerance (double): Maximum error for allocation of synchronous ensemble oscillators.
      @param[in] threshold_steps (uint): Number of steps from the end of simulation that should be analysed for ensemble allocation.
                  If amount of simulation steps has been less than threshold steps than amount of steps will be reduced to amount
                  of simulation steps.
  
      @remark Results can be obtained only after network simulation (graph processing by the network).
  
      @return (list) List of clusters, for example [ [cluster1], [cluster2], ... ].
  
      @see allocate_map_coloring()
  
      """
      return self.allocate_sync_ensembles(
          tolerance, threshold_steps=threshold_steps
      )
  
file_path: pyclustering/pyclustering/gcolor/hysteresis.py
imports: from pyclustering.nnet.hysteresis import hysteresis_network, hysteresis_dynamic
label_desc: Use image node_id 2 for calling the hysteresis_analyser obj's underlying member method code with example usage: obj.allocate_clusters(tolerance, threshold_steps) and returns: self