Package topo :: Package analysis :: Module featureresponses :: Class MeasureResponseCommand

[frames] | no frames]

Class MeasureResponseCommand

source code

Parameterized command for presenting input patterns and measuring responses.

Nested Classes

[hide private]

Inherited from param.parameterized.Parameterized: __metaclass__

Instance Methods

[hide private]

__call__(self, **params)
Measure the response to the specified pattern and store the data in each sheet.

source code

_feature_list(self, p)
Return the list of features to vary; must be implemented by each subclass.

source code

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

Inherited from param.parameterized.Parameterized: __getstate__, __init__, __repr__, __setstate__, 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]

scale = param.Number(default= 1.0, softbounds= (0.0, 2.0), doc...
Multiplicative strength of input pattern.

offset = param.Number(default= 0.0, softbounds= (-1.0, 1.0), d...
Additive offset to input pattern.

display = param.Boolean(default= False, doc= ...
Whether to update a GUI display (if any) during the map measurement.

weighted_average = param.Boolean(default= True, doc= ...
Whether to compute results using a weighted average, or just discrete values.

pattern_presenter = param.Callable(default= None, instantiate=...
Callable object that will present a parameter-controlled pattern to a set of Sheets.

static_parameters = param.List(class_= str, default= ["scale",...
List of names of parameters of this class to pass to the pattern_presenter as static parameters, i.e.

subplot = param.String("", doc= """Name of map to register as ...
Name of map to register as a subplot, if any.

apply_output_fns = param.Boolean(default= None, doc= ...
If non-None, pattern_presenter.apply_output_fns will be set to this value.

duration = param.Number(default= None, doc= ...
If non-None, pattern_presenter.duration will be set to this value.

sheet_views_prefix = param.String(default= "", doc= ...
Optional prefix to add to the name under which results are stored in sheet_views.

generator_sheets = param.List(default= [], doc= ...
pattern_presenter.generator_sheets will be set to this value.

__abstract = True
bool(x) -> bool

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

Inherited from param.parameterized.Parameterized: print_level

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

call(self, **params)
(Call operator)

source code

Measure the response to the specified pattern and store the data in each sheet.

Overrides: param.parameterized.ParameterizedFunction.__call__

Class Variable Details

[hide private]

scale

Multiplicative strength of input pattern.

Value:

param.Number(default= 1.0, softbounds= (0.0, 2.0), doc= """
        Multiplicative strength of input pattern.""")

offset

Additive offset to input pattern.

Value:

param.Number(default= 0.0, softbounds= (-1.0, 1.0), doc= """
        Additive offset to input pattern.""")

display

Whether to update a GUI display (if any) during the map measurement.

Value:

param.Boolean(default= False, doc= """
        Whether to update a GUI display (if any) during the map measurement.""")

weighted_average

Whether to compute results using a weighted average, or just discrete values. A weighted average can give more precise results, without being limited to a set of discrete values, but the results can have systematic biases due to the averaging, especially for non-cyclic parameters.

Value:

param.Boolean(default= True, doc= """
        Whether to compute results using a weighted average, or just
        discrete values.  A weighted average can give more precise
        results, without being limited to a set of discrete values,
        but the results can have systematic biases due to the
        averaging, especially for non-cyclic parameters.""")

pattern_presenter

Callable object that will present a parameter-controlled pattern to a set of Sheets. Needs to be supplied by a subclass or in the call. The attributes duration and apply_output_fns (if non-None) will be set on this object, and it should respect those if possible.

Value:

param.Callable(default= None, instantiate= True, doc= """
        Callable object that will present a parameter-controlled pattern to a
        set of Sheets.  Needs to be supplied by a subclass or in the call.
        The attributes duration and apply_output_fns (if non-None) will
        be set on this object, and it should respect those if possible.""")

static_parameters

List of names of parameters of this class to pass to the pattern_presenter as static parameters, i.e. values that will be fixed to a single value during measurement.

Value:

param.List(class_= str, default= ["scale", "offset"], doc= """
        List of names of parameters of this class to pass to the
        pattern_presenter as static parameters, i.e. values that
        will be fixed to a single value during measurement.""")

subplot

Name of map to register as a subplot, if any.

Value:

param.String("", doc= """Name of map to register as a subplot, if any.""")

apply_output_fns

If non-None, pattern_presenter.apply_output_fns will be set to this value. Provides a simple way to set this commonly changed option of PatternPresenter.

Value:

param.Boolean(default= None, doc= """
        If non-None, pattern_presenter.apply_output_fns will be
        set to this value.  Provides a simple way to set
        this commonly changed option of PatternPresenter.""")

duration

If non-None, pattern_presenter.duration will be set to this value. Provides a simple way to set this commonly changed option of PatternPresenter.

Value:

param.Number(default= None, doc= """
        If non-None, pattern_presenter.duration will be
        set to this value.  Provides a simple way to set
        this commonly changed option of PatternPresenter.""")

sheet_views_prefix

Optional prefix to add to the name under which results are stored in sheet_views. Can be used e.g. to distinguish maps as originating from a particular GeneratorSheet.

Value:

param.String(default= "", doc= """
        Optional prefix to add to the name under which results are
        stored in sheet_views. Can be used e.g. to distinguish maps as
        originating from a particular GeneratorSheet.""")

generator_sheets

pattern_presenter.generator_sheets will be set to this value. The default value of [] results in all GeneratorSheets being used.

Value:

param.List(default= [], doc= """
        pattern_presenter.generator_sheets will be set to this value.
        The default value of [] results in all GeneratorSheets being
        used.""")

__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

Class MeasureResponseCommand

__call__(self, **params) (Call operator)

scale

offset

display

weighted_average

pattern_presenter

static_parameters

subplot

apply_output_fns

duration

sheet_views_prefix

generator_sheets

__abstract

call(self, **params)
(Call operator)