![]() |
Multivariate Pattern Analysis in Python |
Classes to control and store state information.
It was devised to provide conditional storage
The comprehensive API documentation for this module, including all technical details, is available in the Epydoc-generated API reference for mvpa.misc.state (for developers).
Bases: mvpa.misc.state.CollectableAttribute
Container which also takes care about recomputing unique values
XXX may be we could better link original attribute to additional attribute which actually stores the values (and do reverse there as well).
For now lets do it within a single class and tune up getattr
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 AttributeWithUnique documentation.
Full API documentation of AttributeWithUnique in module mvpa.misc.state.
Bases: type
Intended to collect and compose StateCollection for any child class of this metaclass
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 AttributesCollector documentation.
Full API documentation of AttributesCollector in module mvpa.misc.state.
Bases: object
Base class for objects which contain any known collection
Classes inherited from this class gain ability to access collections and their items as simple attributes. Access to collection items “internals” is done via <collection_name> attribute and interface of a corresponding Collection.
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 ClassWithCollections documentation.
Full API documentation of ClassWithCollections in module mvpa.misc.state.
Bases: object
Base class for any custom behaving attribute intended to become part of a collection.
Derived classes will have specific semantics:
Those CollectableAttributes are to be groupped into corresponding collections for each class by statecollector metaclass, ie it would be done on a class creation (ie not per each object)
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 CollectableAttribute documentation.
Full API documentation of CollectableAttribute in module mvpa.misc.state.
Bases: object
Container of some CollectableAttributes.
Groups: |
XXX Seems to be not used and duplicating functionality: _getListing (thus listing property) |
---|
Initialize the Collection
Parameters: |
|
---|
Add a new CollectableAttribute to the collection
Parameters: |
|
---|
wrong type into Collection since it might lead to problems
Also we might convert to __setitem__
Access the value by a given index.
Mimiquing regular dictionary behavior, if value cannot be obtained (i.e. if any exception is caught) return default value.
If item (or any in the present or listed) was set
Parameters: |
|
---|
str(object) -> string
Return a nice string representation of the object. If the argument is a string, the return value is the same object.
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 Collection documentation.
Full API documentation of Collection in module mvpa.misc.state.
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 DatasetAttribute documentation.
Full API documentation of DatasetAttribute in module mvpa.misc.state.
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 FeatureAttribute documentation.
Full API documentation of FeatureAttribute in module mvpa.misc.state.
Bases: mvpa.misc.state.ClassWithCollections
Classes inherited from this class intend to collect attributes within internal processing.
Subclassing Harvestable we gain ability to collect any internal data from the processing which is especially important if an object performs something in loop and discards some intermidiate possibly interesting results (like in case of CrossValidatedTransferError and states of the trained classifier or TransferError).
Initialize state of harvestable
Parameters: |
|
---|
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 Harvestable documentation.
Full API documentation of Harvestable in module mvpa.misc.state.
Bases: mvpa.misc.state.Collection
Container of Parameters for a stateful object.
Initialize the Collection
Parameters: |
|
---|
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 ParameterCollection documentation.
Full API documentation of ParameterCollection in module mvpa.misc.state.
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 SampleAttribute documentation.
Full API documentation of SampleAttribute in module mvpa.misc.state.
Bases: mvpa.misc.state.Collection
Container for data and attributes of samples (ie data/labels/chunks/...)
Initialize the Collection
Parameters: |
|
---|
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 SampleAttributesCollection documentation.
Full API documentation of SampleAttributesCollection in module mvpa.misc.state.
Bases: mvpa.misc.state.Collection
Container of StateVariables for a stateful object.
Groups: |
|
---|
Initialize the state variables of a derived class
Parameters: |
|
---|
Return list of enabled states
Parameters: |
|
---|
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 StateCollection documentation.
Full API documentation of StateCollection in module mvpa.misc.state.
Bases: mvpa.misc.state.CollectableAttribute
Simple container intended to conditionally store the 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 StateVariable documentation.
Full API documentation of StateVariable in module mvpa.misc.state.