Package mvpa :: Package mappers :: Module metric :: Class MetricMapper
[hide private]
[frames] | no frames]

Class MetricMapper

source code


Mapper which has information about the metrics of the dataspace it is
    mapping.
    

Constructor information for `MetricMapper` class
________________________________________________

Cheap initialisation.

        'metric' is a subclass of Metric.
        


Documentation for base classes of `MetricMapper`
=================================================

Documentation for class `Mapper`
--------------------------------

Interface to provide mapping between two spaces: in and out.
    Methods are prefixed correspondingly. forward/reverse operate
    on the entire dataset. get(In|Out)Id[s] operate per element::

              forward
        in   ---------> out
             <--------/
               reverse

    Subclasses should define 'dsshape' and 'nfeatures' properties that point to
    `getInShape` and `getOutSize` respectively. This cannot be
    done in the baseclass as standard Python properties would still point to
    the baseclass methods.
    

Constructor information for `Mapper` class
__________________________________________

Does nothing.

Documentation for class `Metric`
--------------------------------

Abstract class for any finder.

    Classes subclasses from this class show know about structure of
    the data and thus be able to provide information about the
    neighbors.
    At least one of the methods (getNeighbors, getNeighbor) has to be
    overriden in the derived class.
    NOTE: derived #2 from derived class #1 has to override all methods
    which were overrident in class #1
    

Instance Methods [hide private]
 
__init__(self, metric)
Cheap initialisation.
source code
 
getMetric(self)
To make pylint happy
source code
 
setMetric(self, metric)
To make pylint happy
source code

Inherited from base.Mapper: __call__, forward, getInShape, getInSize, getOutShape, getOutSize, reverse, selectOut, train

Inherited from datasets.metric.Metric: getNeighbor, getNeighbors

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables [hide private]
  __doc__ = enhancedDocString('MetricMapper', locals(), Mapper, ...

Inherited from base.Mapper: nfeatures

Properties [hide private]
  metric
To make pylint happy

Inherited from object: __class__

Method Details [hide private]

__init__(self, metric)
(Constructor)

source code 

Cheap initialisation.

'metric' is a subclass of Metric.

Overrides: object.__init__

Class Variable Details [hide private]

__doc__

Value:
enhancedDocString('MetricMapper', locals(), Mapper, Metric)

Property Details [hide private]

metric

To make pylint happy
Get Method:
getMetric(self) - To make pylint happy
Set Method:
setMetric(self, metric) - To make pylint happy