Visualizer of output dynamic of sync network (Sync). More...

Inheritance diagram for pyclustering.nnet.sync.sync_visualizer:

Static Public Member Functions
def	show_output_dynamic (sync_output_dynamic)
	Shows output dynamic (output of each oscillator) during simulation. More...

def	show_output_dynamics (sync_output_dynamics)
	Shows several output dynamics (output of each oscillator) during simulation. More...

def	show_correlation_matrix (sync_output_dynamic, iteration=None)
	Shows correlation matrix between oscillators at the specified iteration. More...

def	show_phase_matrix (sync_output_dynamic, grid_width=None, grid_height=None, iteration=None)
	Shows 2D matrix of phase values of oscillators at the specified iteration. More...

def	show_order_parameter (sync_output_dynamic, start_iteration=None, stop_iteration=None)
	Shows evolution of order parameter (level of global synchronization in the network). More...

def	show_local_order_parameter (sync_output_dynamic, oscillatory_network, start_iteration=None, stop_iteration=None)
	Shows evolution of local order parameter (level of local synchronization in the network). More...

def	animate_output_dynamic (sync_output_dynamic, animation_velocity=75, save_movie=None)
	Shows animation of output dynamic (output of each oscillator) during simulation on a circle from [0; 2pi]. More...

def	animate_correlation_matrix (sync_output_dynamic, animation_velocity=75, colormap='cool', save_movie=None)
	Shows animation of correlation matrix between oscillators during simulation. More...

def	animate_phase_matrix (sync_output_dynamic, grid_width=None, grid_height=None, animation_velocity=75, colormap='jet', save_movie=None)
	Shows animation of phase matrix between oscillators during simulation on 2D stage. More...

def	animate (sync_output_dynamic, title=None, save_movie=None)
	Shows animation of phase coordinates and animation of correlation matrix together for the Sync dynamic output on the same figure. More...

Detailed Description

Visualizer of output dynamic of sync network (Sync).

Definition at line 432 of file sync.py.

Member Function Documentation

◆ animate()

def pyclustering.nnet.sync.sync_visualizer.animate	(	sync_output_dynamic,
		title = `None`,
		save_movie = `None`
	)

static

Shows animation of phase coordinates and animation of correlation matrix together for the Sync dynamic output on the same figure.

Parameters

[in]	sync_output_dynamic	(sync_dynamic): Output dynamic of the Sync network.
[in]	title	(string): Title of the animation that is displayed on a figure if it is specified.
[in]	save_movie	(string): If it is specified then animation will be stored to file that is specified in this parameter.

Definition at line 678 of file sync.py.

◆ animate_correlation_matrix()

def pyclustering.nnet.sync.sync_visualizer.animate_correlation_matrix	(	sync_output_dynamic,
		animation_velocity = `75`,
		colormap = `'cool'`,
		save_movie = `None`
	)

static

Shows animation of correlation matrix between oscillators during simulation.

Parameters

[in]	sync_output_dynamic	(sync_dynamic): Output dynamic of the Sync network.
[in]	animation_velocity	(uint): Interval between frames in milliseconds.
[in]	colormap	(string): Name of colormap that is used by matplotlib ('gray', 'pink', 'cool', spring', etc.).
[in]	save_movie	(string): If it is specified then animation will be stored to file that is specified in this parameter.

Definition at line 585 of file sync.py.

◆ animate_output_dynamic()

def pyclustering.nnet.sync.sync_visualizer.animate_output_dynamic	(	sync_output_dynamic,
		animation_velocity = `75`,
		save_movie = `None`
	)

static

Shows animation of output dynamic (output of each oscillator) during simulation on a circle from [0; 2pi].

Parameters

[in]	sync_output_dynamic	(sync_dynamic): Output dynamic of the Sync network.
[in]	animation_velocity	(uint): Interval between frames in milliseconds.
[in]	save_movie	(string): If it is specified then animation will be stored to file that is specified in this parameter.

Definition at line 552 of file sync.py.

◆ animate_phase_matrix()

def pyclustering.nnet.sync.sync_visualizer.animate_phase_matrix	(	sync_output_dynamic,
		grid_width = `None`,
		grid_height = `None`,
		animation_velocity = `75`,
		colormap = `'jet'`,
		save_movie = `None`
	)

static

Shows animation of phase matrix between oscillators during simulation on 2D stage.

If grid_width or grid_height are not specified than phase matrix size will by calculated automatically by square root.

Parameters

[in]	sync_output_dynamic	(sync_dynamic): Output dynamic of the Sync network.
[in]	grid_width	(uint): Width of the phase matrix.
[in]	grid_height	(uint): Height of the phase matrix.
[in]	animation_velocity	(uint): Interval between frames in milliseconds.
[in]	colormap	(string): Name of colormap that is used by matplotlib ('gray', 'pink', 'cool', spring', etc.).
[in]	save_movie	(string): If it is specified then animation will be stored to file that is specified in this parameter.

Definition at line 619 of file sync.py.

◆ show_correlation_matrix()

def pyclustering.nnet.sync.sync_visualizer.show_correlation_matrix	(	sync_output_dynamic,
		iteration = `None`
	)

static

Shows correlation matrix between oscillators at the specified iteration.

Parameters

[in]	sync_output_dynamic	(sync_dynamic): Output dynamic of the Sync network.
[in]	iteration	(uint): Number of iteration of simulation for which correlation matrix should be allocated. If iteration number is not specified, the last step of simulation is used for the matrix allocation.

Definition at line 468 of file sync.py.

◆ show_local_order_parameter()

def pyclustering.nnet.sync.sync_visualizer.show_local_order_parameter	(	sync_output_dynamic,
		oscillatory_network,
		start_iteration = `None`,
		stop_iteration = `None`
	)

static

Shows evolution of local order parameter (level of local synchronization in the network).

Parameters

[in]	sync_output_dynamic	(sync_dynamic): Output dynamic of the Sync network whose evolution of global synchronization should be visualized.
[in]	oscillatory_network	(sync): Sync oscillatory network whose structure of connections is required for calculation.
[in]	start_iteration	(uint): The first iteration that is used for calculation, if 'None' then the first is used
[in]	stop_iteration	(uint): The last iteration that is used for calculation, if 'None' then the last is used.

Definition at line 531 of file sync.py.

◆ show_order_parameter()

def pyclustering.nnet.sync.sync_visualizer.show_order_parameter	(	sync_output_dynamic,
		start_iteration = `None`,
		stop_iteration = `None`
	)

static

Shows evolution of order parameter (level of global synchronization in the network).

Parameters

[in]	sync_output_dynamic	(sync_dynamic): Output dynamic of the Sync network whose evolution of global synchronization should be visualized.
[in]	start_iteration	(uint): The first iteration that is used for calculation, if 'None' then the first is used
[in]	stop_iteration	(uint): The last iteration that is used for calculation, if 'None' then the last is used.

Definition at line 510 of file sync.py.

◆ show_output_dynamic()

def pyclustering.nnet.sync.sync_visualizer.show_output_dynamic ( sync_output_dynamic )

static

Shows output dynamic (output of each oscillator) during simulation.

Parameters

[in] sync_output_dynamic (sync_dynamic): Output dynamic of the Sync network.

See also: show_output_dynamics

Definition at line 439 of file sync.py.

◆ show_output_dynamics()

def pyclustering.nnet.sync.sync_visualizer.show_output_dynamics ( sync_output_dynamics )

static

Shows several output dynamics (output of each oscillator) during simulation.

Each dynamic is presented on separate plot.

Parameters

[in] sync_output_dynamics (list): list of output dynamics 'sync_dynamic' of the Sync network.

See also: show_output_dynamic

Definition at line 453 of file sync.py.

◆ show_phase_matrix()

def pyclustering.nnet.sync.sync_visualizer.show_phase_matrix	(	sync_output_dynamic,
		grid_width = `None`,
		grid_height = `None`,
		iteration = `None`
	)

static

Shows 2D matrix of phase values of oscillators at the specified iteration.

User should ensure correct matrix sizes in line with following expression grid_width x grid_height that should be equal to amount of oscillators otherwise exception is thrown. If grid_width or grid_height are not specified than phase matrix size will by calculated automatically by square root.

Parameters

[in]	sync_output_dynamic	(sync_dynamic): Output dynamic of the Sync network whose phase matrix should be shown.
[in]	grid_width	(uint): Width of the phase matrix.
[in]	grid_height	(uint): Height of the phase matrix.
[in]	iteration	(uint): Number of iteration of simulation for which correlation matrix should be allocated. If iternation number is not specified, the last step of simulation is used for the matrix allocation.

Definition at line 487 of file sync.py.

The documentation for this class was generated from the following file:

pyclustering/nnet/sync.py

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ animate()

◆ animate_correlation_matrix()

◆ animate_output_dynamic()

◆ animate_phase_matrix()

◆ show_correlation_matrix()

◆ show_local_order_parameter()

◆ show_order_parameter()

◆ show_output_dynamic()

◆ show_output_dynamics()

◆ show_phase_matrix()