Package mvpa :: Package misc :: Module param :: Class Parameter

[hide private]
[frames] | no frames]

# Class Parameter

source code

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

Instance Methods | [hide private]

__init__(self, default, name=None, doc=None, index=None, **kwargs) Specify a parameter by its default value and optionally an arbitrary number of additional parameters. | source code

__str__(self) | source code

doc(self, indent=" ", width=70) Docstring for the parameter to be used in lists of parameters | source code

resetvalue(self) Reset value to the default | source code

_set(self, val) | source code

isDefault(self) Returns True if current value is bound to default one | source code

equalDefault(self) Returns True if current value is equal to default one | source code

setDefault(self, value) | source code

Class Variables | [hide private]

| default = `property(fget= lambda x: x.__default, fset= setDefault)`
| value = `property(fget= lambda x: x._value, fset= _set)`

Method Details | [hide private]

### __init__(self, default, name=None, doc=None, index=None, **kwargs)
(Constructor)

source code

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

TODO: :Parameters: for Parameter

### doc(self, indent=" ", width=70)

source code

Docstring for the parameter to be used in lists of parameters

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

### isDefault(self)

source code

Returns True if current value is bound to default one

Decorators:
  - `@property`

### equalDefault(self)

source code

Returns True if current value is equal to default one

Decorators:
  - `@property`