Table Of Contents

Previous topic

mvpa.misc.io.meg

Next topic

mvpa.misc.plot

This Page

Quick search

mvpa.misc.param

Parameter representation

The comprehensive API documentation for this module, including all technical details, is available in the Epydoc-generated API reference for mvpa.misc.param (for developers).

Classes

KernelParameter

class mvpa.misc.param.KernelParameter(default, name=None, doc=None, **kwargs)

Bases: mvpa.misc.param.Parameter

Just that it is different beast

Specify a parameter by its default value and optionally an arbitrary number of additional parameters.

TODO: :Parameters: for Parameter

See also

Derived classes might provide additional methods via their base classes. Please refer to the list of base classes (if it exists) at the begining of the KernelParameter documentation.

Full API documentation of KernelParameter in module mvpa.misc.param.

Parameter

class mvpa.misc.param.Parameter(default, name=None, doc=None, **kwargs)

Bases: mvpa.misc.state.CollectableAttribute

This class shall serve as a representation of a parameter.

It might be useful if a little more information than the pure parameter value is required (or even only useful).

Each parameter must have a value. However additional property can be passed to the constructor and will be stored in the object.

BIG ASSUMPTION: stored values are not mutable, ie nobody should do

cls.parameter1[:] = ...

or we wouldn’t know that it was changed

Here is a list of possible property names:

min - minimum value max - maximum value step - increment/decrement stepsize

Specify a parameter by its default value and optionally an arbitrary number of additional parameters.

TODO: :Parameters: for Parameter

default
equalDefault
Returns True if current value is equal to default one
isDefault
Returns True if current value is bound to default one
resetvalue()
Reset value to the default
setDefault(value)
value

See also

Derived classes might provide additional methods via their base classes. Please refer to the list of base classes (if it exists) at the begining of the Parameter documentation.

Full API documentation of Parameter in module mvpa.misc.param.