Package topo :: Package misc :: Module trace :: Class TraceGroup

Class TraceGroup

A group of data traces to be plotted together.

A TraceGroup defines a set of associated data traces and allows them to be plotted on stacked, aligned axes. The constructor takes a DataRecorder object as a data source, and a list of Trace objects that indicate the traces to plot. The trace specifications are stored in the attribute self.traces, which can be modified at any time.

Nested Classes

[hide private]

Inherited from param.parameterized.Parameterized: __metaclass__

Instance Methods

[hide private]

__init__(self, recorder, traces=[], **params)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature source code

plot(self, times=(None, None))
Plot the traces. 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_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__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Class Methods

[hide private]

Inherited from param.parameterized.Parameterized: params, print_param_defaults

Class Variables

[hide private]

hspace = param.Number(default= 0.6, doc= ...
Height spacing adjustment between plots.

time_axis_relative = param.Boolean(default= False, doc= ...
Whether to plot the time-axis tic values relative to the start of the plotted time range, or in absolute values.

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

Inherited from param.parameterized.Parameterized: print_level

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, recorder, traces=`[]`, **params)
(Constructor)

source code

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

Overrides: object.__init__: (inherited documentation)

plot(self, times=`(`None`,` None`)`)

source code

Plot the traces.

Requires MatPlotLib (aka pylab).

Plots the traces specified in self.traces, over the timespan specified by times. times = (start_time,end_time); if either start_time or end_time is None, it is assumed to extend to the beginning or end of the timeseries, respectively.

Class Variable Details

[hide private]

hspace

Height spacing adjustment between plots. Larger values produce more space.

Value:

param.Number(default= 0.6, doc= """
       Height spacing adjustment between plots.  Larger values
       produce more space.""")

time_axis_relative

Whether to plot the time-axis tic values relative to the start of the plotted time range, or in absolute values.

Value:

param.Boolean(default= False, doc= """
       Whether to plot the time-axis tic values relative to the start
       of the plotted time range, or in absolute values.""")

Class TraceGroup

__init__(self, recorder, traces=[], **params) (Constructor)

plot(self, times=(None, None))

hspace

time_axis_relative

init(self, recorder, traces=`[]`, **params)
(Constructor)

plot(self, times=`(`None`,` None`)`)