To provide the most recent news and documentation www.pymvpa.org reflects the development 2.0 series (renamed 0.6 series) of PyMVPA. If you are interested in the documentation of the previous stable 0.4 series of PyMVPA, please visit v04.pymvpa.org.

mvpa2.base.state.ConditionalAttributesCollection

class mvpa2.base.state.ConditionalAttributesCollection(items=None, name=None)

Container of ConditionalAttributes for a stateful object.

Groups :

• Public Access Functions: has_key, is_enabled, is_active
• Access Implementors: listing, names, _get_enabled
• Mutators: __init__, enable, disable, _set_enabled
• R/O Properties: listing, names, items
• R/W Properties: enabled

Initialize the conditional attributes of a derived class

Parameters :

items : dict

dictionary of ca

name : str

literal description. Usually just attribute name for the collection, e.g. ‘ca’

change_temporarily(enable_ca=None, disable_ca=None, other=None)

Temporarily enable/disable needed ca for computation

Enable or disable ca which are enabled in other and listed in enable _ca. Use reset_enabled_temporarily to reset to previous state of enabled.

other can be a ClassWithCollections object or ConditionalAttributesCollection

disable(key)

Disable conditional attribute defined by key id

enable(key, value=True, missingok=False)

Enable conditional attribute given in key

enabled

Return list of enabled ca

Parameters :

nondefault : bool

Either to return also ca which are enabled simply by default

invert : bool

Would invert the meaning, ie would return disabled ca

is_active(key)

Returns True if state key is known and is enabled

is_enabled(key)

Returns True if state key is enabled

reset_changed_temporarily()

Reset to previousely stored set of enabled ca