Package mvpa :: Package mappers :: Module zscore :: Class ZScoreMapper
[hide private]
[frames] | no frames]

Class ZScoreMapper

source code


Mapper to project data into standardized values (z-scores).

After the mapper has been instantiated, it has to be train first.

Since it tries to reuse ProjectionMapper, invariant features will simply be assigned a std == 1, which would be equivalent to not standardizing them at all. This is similar to not touching them at all, so similar to what zscore function currently does

Instance Methods [hide private]
 
__init__(self, baselinelabels=None, **kwargs)
Initialize ZScoreMapper
source code
 
_train(self, dataset)
Determine the diagonal matrix with coefficients for standartization
source code

Inherited from base.ProjectionMapper: forward, getInSize, getOutSize, reverse, selectOut, train

Inherited from base.ProjectionMapper (private): _computeRecon, _demeanData, _getRecon

Inherited from base.Mapper: __call__, __repr__, getInId, getMetric, getNeighbor, getNeighborIn, getNeighbors, isValidInId, isValidOutId, setMetric

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  __doc__ = enhancedDocString('ZScoreMapper', locals(), Projecti...

Inherited from base.ProjectionMapper: _DEV__doc__, proj, recon

Inherited from base.Mapper: metric, nfeatures

Instance Variables [hide private]

Inherited from base.ProjectionMapper (private): _demean, _offset_in, _offset_out, _proj, _recon

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, baselinelabels=None, **kwargs)
(Constructor)

source code 
Initialize ZScoreMapper
Parameters:
  • baselinelabels (None or list of int or string) - Used to compute mean and variance TODO: not in effect now and need to be adherent to all `ProjectionMapper`s
Overrides: object.__init__

_train(self, dataset)

source code 
Determine the diagonal matrix with coefficients for standartization
Overrides: base.ProjectionMapper._train

Class Variable Details [hide private]

__doc__

Value:
enhancedDocString('ZScoreMapper', locals(), ProjectionMapper)