Package topo :: Package plotting :: Module plotgroup :: Class PlotGroup

Class PlotGroup

                       object --+    
                                |    
param.parameterized.Parameterized --+
                                    |
                                   PlotGroup

Known Subclasses:

SheetPlotGroup

Container that has one or more Plots and also knows how to arrange the plots and other special parameters.

Nested Classes

[hide private]

Inherited from param.parameterized.Parameterized: __metaclass__

Instance Methods

[hide private]

__init__(self, **params)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

_exec_update_command(self)

source code

_exec_plot_command(self)

source code

_plot_list(self)
Return the list of plots.

source code

make_plots(self, update=True)
Create and scale the plots, after first executing the PlotGroup's update_command (if update is True) and plot_command.

source code

_create_images(self, update)
Generate the sorted and scaled list of plots constituting the PlotGroup.

source code

scale_images(self, zoom_factor=None)
Scale the images by the given zoom factor, if appropriate; default is to do nothing.

source code

generate_labels(self)
Generate labels for the plots.

source code

_sort_plots(self)
Sort plots according to their precedence, then alphabetically.

source code

Inherited from param.parameterized.Parameterized: __getstate__, __repr__, __setstate__, __str__, debug, defaults, force_new_dynamic_value, get_param_values, get_value_generator, inspect_value, message, print_param_values, script_repr, set_dynamic_time_fn, state_pop, state_push, verbose, warning

Inherited from param.parameterized.Parameterized (private): _check_params, _instantiate_param, _set_name, _setup_params

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__

Class Methods

[hide private]

Inherited from param.parameterized.Parameterized: params, print_param_defaults

Class Variables

[hide private]

update_command = param.String(default= "", doc= ...
Command to execute before updating this plot, e.g.

plot_command = param.String(default= "", doc= ...
Command to execute when updating sheet or coordinate of unit to be plotted when the simulator time has not changed (i.e.

Inherited from param.parameterized.Parameterized: name, print_level

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, **params)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

_plot_list(self)

source code

Return the list of plots.

Re-implemented by TemplatePlotGroup to construct a list of plots as specified by the template.

Class Variable Details

[hide private]

update_command

Command to execute before updating this plot, e.g. to calculate sheet views.

The command can be any Python code, and will be evaluated in the main namespace (as if it were typed into a .ty script). The initial value is determined by the template for this plot, but various arguments can be passed, a modified version substituted, etc.

Value:

param.String(default= "", doc= """
    Command to execute before updating this plot, e.g. to calculate sheet views.
    
    The command can be any Python code, and will be evaluated in the main namespac
e
    (as if it were typed into a .ty script).  The initial value is determined by
    the template for this plot, but various arguments can be passed, a modified
    version substituted, etc.""")

plot_command


Command to execute when updating sheet or coordinate of unit to be plotted
when the simulator time has not changed (i.e. no further measurement of
responses is required).
In the case of a full-field stimulus, responses do not need to be re-measured
since the necessary values are already stored. 

The command can be any Python code, and will be evaluated in the main namespace
(as if it were typed into a .ty script).  The initial value is determined by
the template for this plot, but various arguments can be passed, a modified
   version substituted, etc.

Value:

param.String(default= "", doc= """
    Command to execute when updating sheet or coordinate of unit to be plotted
    when the simulator time has not changed (i.e. no further measurement of
    responses is required).
    In the case of a full-field stimulus, responses do not need to be re-measured
    since the necessary values are already stored. 
    
    The command can be any Python code, and will be evaluated in the main namespac
...

Class PlotGroup

__init__(self, **params) (Constructor)

_plot_list(self)

update_command

plot_command

init(self, **params)
(Constructor)