Package mvpa :: Package mappers :: Module wavelet :: Class _WaveletMapper

[hide private]
[frames] | no frames]

# Class _WaveletMapper

source code

Generic class for Wavelet mappers (decomposition and packet)

Instance Methods | [hide private]

__init__(self, dim=1, wavelet='sym4', mode='per', maxlevel=None) Initialize _WaveletMapper mapper | source code

forward(self, data) Map data from the IN dataspace into OUT space. | source code

reverse(self, data) Reverse map data from OUT space into the IN space. | source code

_forward(self, *args) | source code

_reverse(self, *args) | source code

getInSize(self) Returns the number of original features. | source code

getOutSize(self) Returns the number of wavelet components. | source code

selectOut(self, outIds) Choose a subset of components... | source code

Inherited from `base.Mapper`: `__call__`, `__repr__`, `getInId`, `getMetric`, `getNeighbor`, `getNeighborIn`, `getNeighbors`, `isValidInId`, `isValidOutId`, `setMetric`, `train` Inherited from `object`: `__delattr__`, `__format__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__sizeof__`, `__str__`, `__subclasshook__`

Class Variables | [hide private]

| __doc__ = `enhancedDocString('_WaveletMapper', locals(), Mapper)`
Inherited from `base.Mapper`: `metric`, `nfeatures`

Instance Variables | [hide private]

| _dim Dimension to work along
| _maxlevel Maximal level of decomposition. None for automatic
| _wavelet Wavelet family to use
| _mode Periodization mode

Properties | [hide private]

Inherited from `object`: `__class__`

Method Details | [hide private]

### __init__(self, dim=1, wavelet='sym4', mode='per', maxlevel=None)
(Constructor)

source code

Initialize _WaveletMapper mapper

Parameters:
  - `dim` (int or tuple of int) - dimensions to work across (for now just scalar value, ie 1D transformation) is supported
  - `wavelet` (basestring) - one from the families available withing pywt package
  - `mode` (basestring) - periodization mode
  - `maxlevel` (int or None) - number of levels to use. If None - automatically selected by pywt
Overrides: object.__init__

### forward(self, data)

source code

Map data from the IN dataspace into OUT space.

Overrides: base.Mapper.forward
  (inherited documentation)

### reverse(self, data)

source code

Reverse map data from OUT space into the IN space.

Overrides: base.Mapper.reverse
  (inherited documentation)

### getInSize(self)

source code

Returns the number of original features.

Overrides: base.Mapper.getInSize

### getOutSize(self)

source code

Returns the number of wavelet components.

Overrides: base.Mapper.getOutSize

### selectOut(self, outIds)

source code

Choose a subset of components...

just use MaskMapper on top?

Parameters:
  - `outIds`, `sequence` - Subset of ids of the current feature in OUT space to keep.
Overrides: base.Mapper.selectOut