Package topo :: Package misc :: Module trace :: Class Trace

Class Trace

A specification for generating 1D traces of data from recorded timeseries.

A Trace object is a callable object that encapsulates a method for generating a 1-dimensional trace from possibly multidimensional timeseries data, along with a specification for how to plot that data, including Y-axis boundaries and plotting arguments.

Trace is an abstract class. Subclasses implement the __call__ method to define how to extract a 1D trace from a sequence of data.

Nested Classes

[hide private]

Inherited from param.parameterized.Parameterized: __metaclass__

Instance Methods

[hide private]

__call__(self, data)

source code

get_ybounds(self, ydata)

source code

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, 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]

__abstract = True
bool(x) -> bool

data_name = param.String(default= None, doc= ...
Name of the timeseries from which the trace is generated.

ybounds = param.Parameter(default= (None, None), doc= ...
The (min,max) boundaries for y axis.

ymargin = param.Number(default= 0.1, doc= ...
The fraction of the difference ymax-ymin to add to the top of the plot as padding.

plotkw = param.Dict(default= dict(linestyle= 'steps'), doc= ...
Contains the keyword arguments to pass to the plot command when plotting the trace.

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

Inherited from param.parameterized.Parameterized: print_level

Properties

[hide private]

Inherited from object: __class__

Class Variable Details

[hide private]

__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

data_name

Name of the timeseries from which the trace is generated. E.g. the connection name into a DataRecorder object.

Value:

param.String(default= None, doc= """
        Name of the timeseries from which the trace is generated.
        E.g. the connection name into a DataRecorder object.""")

ybounds

The (min,max) boundaries for y axis. If either is None, then the bound min or max of the data given, respectively.

Value:

param.Parameter(default= (None, None), doc= """
        The (min,max) boundaries for y axis.  If either is None, then
        the bound min or max of the data given, respectively.""")

ymargin

The fraction of the difference ymax-ymin to add to the top of the plot as padding.

Value:

param.Number(default= 0.1, doc= """
        The fraction of the difference ymax-ymin to add to the
        top of the plot as padding.""")

plotkw

Contains the keyword arguments to pass to the plot command when plotting the trace.

Value:

param.Dict(default= dict(linestyle= 'steps'), doc= """
        Contains the keyword arguments to pass to the plot command
        when plotting the trace.""")