Package mvpa :: Package measures :: Module ds :: Class DSMDatasetMeasure
[hide private]
[frames] | no frames]

Class DSMDatasetMeasure

source code


DSMDatasetMeasure creates a DatasetMeasure object where metric can be one of 'euclidean', 'spearman', 'pearson' or 'confusion'
Nested Classes [hide private]

Inherited from misc.state.ClassWithCollections: __metaclass__

Instance Methods [hide private]
 
__init__(self, dsmatrix, dset_metric, output_metric='spearman')
Does nothing special.
source code
 
__call__(self, dataset)
Compute measure on a given Dataset.
source code

Inherited from base.DatasetMeasure: __repr__, null_dist, transformer, untrain

Inherited from base.DatasetMeasure (private): _call, _postcall

Inherited from misc.state.ClassWithCollections: __getattribute__, __new__, __setattr__, __str__, reset

Inherited from object: __delattr__, __format__, __hash__, __reduce__, __reduce_ex__, __sizeof__, __subclasshook__

Class Variables [hide private]

Inherited from base.DatasetMeasure: __doc__, null_prob, null_t, raw_results

Inherited from misc.state.ClassWithCollections: _DEV__doc__, descr

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, dsmatrix, dset_metric, output_metric='spearman')
(Constructor)

source code 
Does nothing special.
Parameters:
  • transformer, Functor - This functor is called in __call__() to perform a final processing step on the to be returned dataset measure. If None, nothing is called
  • null_dist, instance, of, distribution, estimator - The estimated distribution is used to assign a probability for a certain value of the computed measure.
Overrides: object.__init__
(inherited documentation)

__call__(self, dataset)
(Call operator)

source code 

Compute measure on a given Dataset.

Each implementation has to handle a single arguments: the source dataset.

Returns the computed measure in some iterable (list-like) container applying transformer if such is defined

Overrides: base.DatasetMeasure.__call__
(inherited documentation)