pyclustering.nnet.dynamic_visualizer.dynamic_descr Class Reference

Output dynamic description that used to display. More...

Public Member Functions

def __init__ (self, canvas, time, dynamics, separate, color)
 Constructor of output dynamic descriptor. More...
 
def get_axis_index (self, index_dynamic)
 Returns index of canvas where specified dynamic (by index 'index_dynamic') should be displayed. More...
 

Public Attributes

 canvas
 Index of canvas where (or from which) dynamic should be displayed. More...
 
 time
 Time points. More...
 
 dynamics
 Dynamic or dynamics. More...
 
 separate
 Defines how dynamic(s) should be displayed. More...
 
 color
 Color of dynamic. More...
 

Detailed Description

Output dynamic description that used to display.

Used by 'dynamic_visualizer' class.

Definition at line 78 of file dynamic_visualizer.py.

Constructor & Destructor Documentation

◆ __init__()

def pyclustering.nnet.dynamic_visualizer.dynamic_descr.__init__ (   self,
  canvas,
  time,
  dynamics,
  separate,
  color 
)

Constructor of output dynamic descriptor.

Parameters
[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]time(list): Time points that are considered as a X axis.
[in]dynamics(list): Dynamic or dynamics that should be displayed.
[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 85 of file dynamic_visualizer.py.

Member Function Documentation

◆ get_axis_index()

def pyclustering.nnet.dynamic_visualizer.dynamic_descr.get_axis_index (   self,
  index_dynamic 
)

Returns index of canvas where specified dynamic (by index 'index_dynamic') should be displayed.

Parameters
[in]index_dynamic(uint): Index of dynamic that should be displayed.
Returns
(uint) Index of canvas.

Definition at line 117 of file dynamic_visualizer.py.

Member Data Documentation

◆ canvas

pyclustering.nnet.dynamic_visualizer.dynamic_descr.canvas

Index of canvas where (or from which) dynamic should be displayed.

Definition at line 102 of file dynamic_visualizer.py.

Referenced by pyclustering.nnet.dynamic_visualizer.dynamic_descr.get_axis_index().

◆ color

pyclustering.nnet.dynamic_visualizer.dynamic_descr.color

Color of dynamic.

Definition at line 114 of file dynamic_visualizer.py.

◆ dynamics

pyclustering.nnet.dynamic_visualizer.dynamic_descr.dynamics

Dynamic or dynamics.

Definition at line 108 of file dynamic_visualizer.py.

Referenced by pyclustering.nnet.dynamic_visualizer.dynamic_descr.get_axis_index().

◆ separate

pyclustering.nnet.dynamic_visualizer.dynamic_descr.separate

Defines how dynamic(s) should be displayed.

Definition at line 111 of file dynamic_visualizer.py.

Referenced by pyclustering.nnet.dynamic_visualizer.dynamic_descr.get_axis_index().

◆ time

pyclustering.nnet.dynamic_visualizer.dynamic_descr.time

Time points.

Definition at line 105 of file dynamic_visualizer.py.

Referenced by pyclustering.nnet.sync.sync_dynamic.__getitem__().


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