Package topo :: Package plotting :: Module plotfilesaver :: Class PlotGroupSaver

Class PlotGroupSaver

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

Known Subclasses:

CFProjectionPlotGroupSaver

Allows a PlotGroup to be saved as a set of bitmap files on disk.

Nested Classes

[hide private]

Inherited from param.parameterized.Parameterized: __metaclass__

Instance Methods

[hide private]

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

source code

strip(self, filename)
Strip inappropriate characters from a filename.

source code

filename(self, label, **params)
Calculate a specific filename from the filename_format.

source code

save_to_disk(self, **params)

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]

file_format = param.String(default= "png", doc= ...
Bitmap image file format to use.

filename_prefix = param.String(default= "", doc= ...
Optional prefix that can be used in the filename_format command to disambiguate different simulations or conditions.

filename_suffix = param.String(default= "", doc= ...
Optional suffix that can be used in the filename_format command to disambiguate different simulations or conditions.

filename_format = param.String(default= "%(filename_prefix)s%(...
Format string to use for generating filenames for plots.

Inherited from param.parameterized.Parameterized: name, print_level

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, plotgroup, **params)
(Constructor)

source code

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

Overrides: object.__init__: (inherited documentation)

Class Variable Details

[hide private]

file_format

Bitmap image file format to use.

Value:

param.String(default= "png", doc= """
        Bitmap image file format to use.""")

filename_prefix

Optional prefix that can be used in the filename_format command to disambiguate different simulations or conditions.

Value:

param.String(default= "", doc= """
        Optional prefix that can be used in the filename_format command
        to disambiguate different simulations or conditions.""")

filename_suffix

Optional suffix that can be used in the filename_format command to disambiguate different simulations or conditions.

Value:

param.String(default= "", doc= """
        Optional suffix that can be used in the filename_format command
        to disambiguate different simulations or conditions.""")

filename_format

Format string to use for generating filenames for plots. This string will be evaluated in the context of a dictionary that defines various items commonly used when generating filenames, including:

basename:    the default sim.basename(), usually name+time()
time:        the current simulation time (topo.sim.time())
sim_name:    the name of the current simulation (topo.sim.name)
plot_label:  the label specfied in the PlotGroup for this plot
file_format: the bitmap image file format for this type of plot
plotgroup_name: the name of this PlotGroup

Value:

param.String(default= "%(filename_prefix)s%(basename)s_%(plot_label)s%(filename_su
ffix)s.%(file_format)s", doc= """
        Format string to use for generating filenames for plots.  This
        string will be evaluated in the context of a dictionary that
        defines various items commonly used when generating filenames,
        including::

          basename:    the default sim.basename(), usually name+time()
...

Class PlotGroupSaver

__init__(self, plotgroup, **params) (Constructor)

file_format

filename_prefix

filename_suffix

filename_format

init(self, plotgroup, **params)
(Constructor)