Public Member Functions | List of all members
pyclustering.nnet.dynamic_visualizer.dynamic_visualizer Class Reference

Basic output dynamic visualizer. More...

Public Member Functions

def __init__ (self, canvas, x_title=None, y_title=None, x_lim=None, y_lim=None, x_labels=True, y_labels=True)
 Construct dynamic visualizer. More...
 
def set_canvas_properties (self, canvas, x_title=None, y_title=None, x_lim=None, y_lim=None, x_labels=True, y_labels=True)
 Set properties for specified canvas. More...
 
def append_dynamic (self, t, dynamic, canvas=0, color='blue')
 Append single dynamic to specified canvas (by default to the first with index '0'). More...
 
def append_dynamics (self, t, dynamics, canvas=0, separate=False, color='blue')
 Append several dynamics to canvas or canvases (defined by 'canvas' and 'separate' arguments). More...
 
def show (self, axis=None, display=True)
 Draw and show output dynamics. More...
 

Detailed Description

Basic output dynamic visualizer.

The aim of the visualizer is to displayed output dynamic of any process, for example, output dynamic of oscillatory network.

Definition at line 165 of file dynamic_visualizer.py.

Constructor & Destructor Documentation

◆ __init__()

def pyclustering.nnet.dynamic_visualizer.dynamic_visualizer.__init__ (   self,
  canvas,
  x_title = None,
  y_title = None,
  x_lim = None,
  y_lim = None,
  x_labels = True,
  y_labels = True 
)

Construct dynamic visualizer.

Default properties that are generalized in the constructor, for example, X axis title, can be changed by corresponding method: 'set_canvas_properties'.

Parameters
[in]canvas(uint): Amount of canvases that is used for visualization.
[in]x_title(string): Title for X axis of canvases, if 'None', then nothing is displayed.
[in]y_title(string): Title for Y axis of canvases, if 'None', then nothing is displayed.
[in]x_lim(list): Defines borders of X axis like [from, to], for example [0, 3.14], if 'None' then borders are calculated automatically.
[in]y_lim(list): Defines borders of Y axis like [from, to], if 'None' then borders are calculated automatically.
[in]x_labels(bool): If True then labels of X axis are displayed.
[in]y_labels(bool): If True then labels of Y axis are displayed.

Definition at line 173 of file dynamic_visualizer.py.

Member Function Documentation

◆ append_dynamic()

def pyclustering.nnet.dynamic_visualizer.dynamic_visualizer.append_dynamic (   self,
  t,
  dynamic,
  canvas = 0,
  color = 'blue' 
)

Append single dynamic to specified canvas (by default to the first with index '0').

Parameters
[in]t(list): Time points that corresponds to dynamic values and considered on a X axis.
[in]dynamic(list): Value points of dynamic that are considered on an Y axis.
[in]canvas(uint): Canvas where dynamic should be displayed.
[in]color(string): Color that is used for drawing dynamic on the canvas.

Definition at line 213 of file dynamic_visualizer.py.

◆ append_dynamics()

def pyclustering.nnet.dynamic_visualizer.dynamic_visualizer.append_dynamics (   self,
  t,
  dynamics,
  canvas = 0,
  separate = False,
  color = 'blue' 
)

Append several dynamics to canvas or canvases (defined by 'canvas' and 'separate' arguments).

Parameters
[in]t(list): Time points that corresponds to dynamic values and considered on a X axis.
[in]dynamics(list): Dynamics where each of them is considered on Y axis.
[in]canvas(uint): Index of canvas where dynamic should be displayed, in case of 'separate' representation this argument is considered as a first canvas from that displaying should be done.
[in]separate(bool|list): If 'True' then each dynamic is displayed on separate canvas, if it is defined by list, for example, [ [1, 2], [3, 4] ], then the first and the second dynamics are displayed on the canvas with index 'canvas' and the third and forth are displayed on the next 'canvas + 1' canvas.
[in]color(string): Color that is used to display output dynamic(s).

Definition at line 228 of file dynamic_visualizer.py.

◆ set_canvas_properties()

def pyclustering.nnet.dynamic_visualizer.dynamic_visualizer.set_canvas_properties (   self,
  canvas,
  x_title = None,
  y_title = None,
  x_lim = None,
  y_lim = None,
  x_labels = True,
  y_labels = True 
)

Set properties for specified canvas.

Parameters
[in]canvas(uint): Index of canvas whose properties should changed.
[in]x_title(string): Title for X axis, if 'None', then nothing is displayed.
[in]y_title(string): Title for Y axis, if 'None', then nothing is displayed.
[in]x_lim(list): Defines borders of X axis like [from, to], for example [0, 3.14], if 'None' then borders are calculated automatically.
[in]y_lim(list): Defines borders of Y axis like [from, to], if 'None' then borders are calculated automatically.
[in]x_labels(bool): If True then labels of X axis are displayed.
[in]y_labels(bool): If True then labels of Y axis are displayed.

Definition at line 195 of file dynamic_visualizer.py.

◆ show()

def pyclustering.nnet.dynamic_visualizer.dynamic_visualizer.show (   self,
  axis = None,
  display = True 
)

Draw and show output dynamics.

Parameters
[in]axis(axis): If is not 'None' then user specified axis is used to display output dynamic.
[in]display(bool): Whether output dynamic should be displayed or not, if not, then user should call 'plt.show()' by himself.

Definition at line 248 of file dynamic_visualizer.py.

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