This content refers to the previous stable release of PyMVPA. Please visit www.pymvpa.org for the most recent version of PyMVPA and its documentation.

misc.param

Module: misc.param

Inheritance diagram for mvpa.misc.param:

Parameter representation

Classes

KernelParameter

class mvpa.misc.param.KernelParameter(default, name=None, doc=None, index=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

Parameter

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

Bases: mvpa.misc.attributes.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

doc(indent=' ', width=70)

Docstring for the parameter to be used in lists of parameters

Return type:string or list of strings (if indent is None)

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