pyclustering  0.10.1 pyclustring is a Python, C++ data mining library.
pyclustering.cluster.syncnet.syncnet_analyser Class Reference

Performs analysis of output dynamic of the oscillatory network syncnet to extract information about cluster allocation. More...

Inheritance diagram for pyclustering.cluster.syncnet.syncnet_analyser:
Collaboration diagram for pyclustering.cluster.syncnet.syncnet_analyser:

Public Member Functions

def __init__ (self, phase, time, pointer_sync_analyser)
Constructor of the analyser. More...

def __del__ (self)
Desctructor of the analyser.

def allocate_clusters (self, eps=0.01, indexes=None, iteration=None)
Returns list of clusters in line with state of oscillators (phases). More...

def get_cluster_encoding (self)
Returns clustering result representation type that indicate how clusters are encoded. More...

Public Member Functions inherited from pyclustering.nnet.sync.sync_dynamic
def output (self)
(list) Returns output dynamic of the Sync network (phase coordinates of each oscillator in the network) during simulation.

def time (self)
(list) Returns sampling times when dynamic is measured during simulation.

def __len__ (self)
Returns number of simulation steps that are stored in dynamic. More...

def __getitem__ (self, index)
Indexing of the dynamic.

def allocate_sync_ensembles (self, tolerance=0.01, indexes=None, iteration=None)
Allocate clusters in line with ensembles of synchronous oscillators where each synchronous ensemble corresponds to only one cluster. More...

def allocate_phase_matrix (self, grid_width=None, grid_height=None, iteration=None)
Returns 2D matrix of phase values of oscillators at the specified iteration of simulation. More...

def allocate_correlation_matrix (self, iteration=None)
Allocate correlation matrix between oscillators at the specified step of simulation. More...

def calculate_order_parameter (self, start_iteration=None, stop_iteration=None)
Calculates level of global synchorization (order parameter). More...

def calculate_local_order_parameter (self, oscillatory_network, start_iteration=None, stop_iteration=None)
Calculates local order parameter. More...

Detailed Description

Performs analysis of output dynamic of the oscillatory network syncnet to extract information about cluster allocation.

Definition at line 30 of file syncnet.py.

◆ __init__()

 def pyclustering.cluster.syncnet.syncnet_analyser.__init__ ( self, phase, time, pointer_sync_analyser )

Constructor of the analyser.

Parameters
 [in] phase (list): Output dynamic of the oscillatory network, where one iteration consists of all phases of oscillators. [in] time (list): Simulation time. [in] pointer_sync_analyser (POINTER): Pointer to CCORE analyser, if specified then other arguments can be omitted.

Reimplemented from pyclustering.nnet.sync.sync_dynamic.

Definition at line 36 of file syncnet.py.

◆ allocate_clusters()

 def pyclustering.cluster.syncnet.syncnet_analyser.allocate_clusters ( self, eps = 0.01, indexes = None, iteration = None )

Returns list of clusters in line with state of oscillators (phases).

Parameters
 [in] eps (double): Tolerance that defines the maximum difference between phases of oscillators that belong to one cluster. [in] indexes (list): List of real object indexes and it should be equal to amount of oscillators (in case of 'None' - indexes are in range [0; amount_oscillators]). [in] iteration (uint): Iteration of simulation that should be used for allocation.
Returns
(list) List of clusters, for example [ [cluster1], [cluster2], ... ].)

Definition at line 59 of file syncnet.py.

◆ get_cluster_encoding()

 def pyclustering.cluster.syncnet.syncnet_analyser.get_cluster_encoding ( self )

Returns clustering result representation type that indicate how clusters are encoded.

Returns
(type_encoding) Clustering result representation.