mvpa.measures.pls

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

Classes

PLS

class mvpa.measures.pls.PLS(num_permutations=200, num_bootstraps=100, **kwargs)

Bases: mvpa.measures.base.FeaturewiseDatasetMeasure

No documentation found. Sorry!

Note

Available state variables:

• base_sensitivities: Stores basic sensitivities if the sensitivity relies on combining multiple ones
• null_prob+: State variable
• null_t: State variable
• raw_result: Computed results before applying any transformation algorithm

(States enabled by default are listed with +)

See also

Please refer to the documentation of the base class for more information:

FeaturewiseDatasetMeasure

Initialize instance of PLS

Parameters:

• enable_states (None or list of basestring) – Names of the state variables which should be enabled additionally to default ones
• disable_states (None or list of basestring) – Names of the state variables which should be disabled
• combiner (Functor) – The combiner is only applied if the computed featurewise dataset measure is more than one-dimensional. This is different from a transformer, which is always applied. By default, the sum of absolute values along the second axis is computed.

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 PLS documentation.

Full API documentation of PLS in module mvpa.measures.pls.

TaskPLS

class mvpa.measures.pls.TaskPLS(num_permutations=200, num_bootstraps=100, **kwargs)

Bases: mvpa.measures.pls.PLS

No documentation found. Sorry!

Note

Available state variables:

• base_sensitivities: Stores basic sensitivities if the sensitivity relies on combining multiple ones
• null_prob+: State variable
• null_t: State variable
• raw_result: Computed results before applying any transformation algorithm

(States enabled by default are listed with +)

See also

Please refer to the documentation of the base class for more information:

PLS

Initialize instance of PLS

Parameters:

• enable_states (None or list of basestring) – Names of the state variables which should be enabled additionally to default ones
• disable_states (None or list of basestring) – Names of the state variables which should be disabled
• combiner (Functor) – The combiner is only applied if the computed featurewise dataset measure is more than one-dimensional. This is different from a transformer, which is always applied. By default, the sum of absolute values along the second axis is computed.

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 TaskPLS documentation.

Full API documentation of TaskPLS in module mvpa.measures.pls.