topo :: command :: pylabplots :: PylabPlotCommand :: Class PylabPlotCommand

Class PylabPlotCommand

                           object --+        
                                    |        
    param.parameterized.Parameterized --+    
                                        |    
param.parameterized.ParameterizedFunction --+
                                            |
                                           PylabPlotCommand

Known Subclasses:

Parameterized command for plotting using Matplotlib/Pylab.

Nested Classes

[hide private]

Inherited from param.parameterized.Parameterized: __metaclass__

Instance Methods

[hide private]

_set_windowtitle(self, title)
Helper function to set the title (if not None) of this PyLab plot window.

source code

_generate_figure(self, p)
Helper function to display a figure on screen or save to a file.

source code

Inherited from param.parameterized.ParameterizedFunction: __call__, __reduce__, script_repr

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

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

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Class Methods

[hide private]

Inherited from param.parameterized.ParameterizedFunction: instance

Inherited from param.parameterized.Parameterized: params, print_param_defaults

Static Methods

[hide private]

Inherited from param.parameterized.ParameterizedFunction: __new__

Class Variables

[hide private]

file_dpi = param.Number(default= 100.0, bounds= (0, None), sof...
Default DPI when rendering to a bitmap.

file_format = param.String(default= "png", doc= ...
Which image format to use when saving images.

filename = param.String(default= None, doc= ...
Optional base of the filename to use when saving images; if None the plot will be displayed interactively.

filename_suffix = param.String(default= "", doc= ...
Optional suffix to be used for disambiguation of the filename.

title = param.String(default= None, doc= ...
Optional title to be used when displaying the plot interactively.

__abstract = True
bool(x) -> bool

name = <param.parameterized.String object at 0xb23b87c>
String identifier for this object.

Inherited from param.parameterized.Parameterized: print_level

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

_generate_figure(self, p)

source code

Helper function to display a figure on screen or save to a file.

p should be a ParamOverrides instance containing the current set of parameters.

Class Variable Details

[hide private]

file_dpi

Default DPI when rendering to a bitmap. The nominal size * the dpi gives the final image size in pixels. E.g.: 4"x4" image * 80 dpi ==> 320x320 pixel image.

Value:

param.Number(default= 100.0, bounds= (0, None), softbounds= (0, 1000), doc= """
        Default DPI when rendering to a bitmap.  
        The nominal size * the dpi gives the final image size in pixels.  
        E.g.: 4"x4" image * 80 dpi ==> 320x320 pixel image.""")

file_format

Which image format to use when saving images. The output can be png, ps, pdf, svg, or any other format supported by Matplotlib.

Value:

param.String(default= "png", doc= """
        Which image format to use when saving images.
        The output can be png, ps, pdf, svg, or any other format
        supported by Matplotlib.""")

filename

Optional base of the filename to use when saving images; if None the plot will be displayed interactively.

The actual name is constructed from the filename base plus the suffix plus the current simulator time plus the file_format.

Value:

param.String(default= None, doc= """
        Optional base of the filename to use when saving images;
        if None the plot will be displayed interactively.
        
        The actual name is constructed from the filename base plus the
        suffix plus the current simulator time plus the file_format.""")

filename_suffix

Optional suffix to be used for disambiguation of the filename.

Value:

param.String(default= "", doc= """
        Optional suffix to be used for disambiguation of the filename.""")

title

Optional title to be used when displaying the plot interactively.

Value:

param.String(default= None, doc= """
        Optional title to be used when displaying the plot interactively.""")

__abstract

bool(x) -> bool

Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

Value:

True