Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

ContinuousWaveletTransform Class Reference

#include <OpenMS/TRANSFORMATIONS/RAW2PEAK/ContinuousWaveletTransform.h>

Inheritance diagram for ContinuousWaveletTransform:

ContinuousWaveletTransformNumIntegration

List of all members.


Detailed Description

This class is the base class of the continuous wavelet transformation.

Public Types

typedef std::vector
< RawDataPoint1D >
::const_iterator 
RawDataPointConstIterator
 Raw data const iterator type.

Public Member Functions

 ContinuousWaveletTransform ()
 Constructor.
virtual ~ContinuousWaveletTransform ()
 Destructor.
const DPeakArray
< RawDataPoint1D > & 
getSignal () const
 Non-mutable access to the wavelet transform of the signal.
DPeakArray< RawDataPoint1D > & getSignal ()
 Mutable access to the wavelet transform of the signal.
void setSignal (const DPeakArray< RawDataPoint1D > &signal)
 Mutable access to the wavelet transform of the signal.
const std::vector< double > & getWavelet () const
 Non-mutable access to the wavelet.
std::vector< double > & getWavelet ()
 Mutable access to the wavelet.
void setWavelet (const std::vector< double > &wavelet)
 Mutable access to the signal.
DoubleReal getScale () const
double & getScale ()
 Mutable access to the spacing of raw data.
void setScale (DoubleReal scale)
 Mutable access to the spacing of raw data.
DoubleReal getSpacing () const
double & getSpacing ()
 Mutable access to the spacing of raw data.
void setSpacing (double spacing)
 Mutable access to the spacing of raw data.
Int getLeftPaddingIndex () const
 Non-mutable access to the position where the signal starts (in the intervall [0,end_left_padding_) are the padded zeros).
int & getLeftPaddingIndex ()
 Mutable access to the position where the signal starts.
void setLeftPaddingIndex (const int end_left_padding)
 Mutable access to position where the signal starts.
Int getRightPaddingIndex () const
 Non-mutable access to the position where the signal ends (in the intervall (begin_right_padding_,end] are the padded zeros).
int & getRightPaddingIndex ()
 Mutable access to the position where the signal starts.
void setRightPaddingIndex (const int begin_right_padding)
 Mutable access to position where the signal starts.
Int getSignalLength () const
 Non-mutable access to signal length [end_left_padding,begin_right_padding].
int & getSignalLength ()
 Mutable access to signal length [end_left_padding,begin_right_padding].
void setSignalLength (const int signal_length)
 Mutable access to signal length [end_left_padding,begin_right_padding].
int getSize () const
 Non-mutable access to signal length including padded zeros [0,end].
virtual void init (double scale, double spacing)
 Perform possibly necessary preprocessing steps, like tabulating the Wavelet.
double operator[] (unsigned int i)
 Yields the signal (intensity) at position i.
double operator[] (unsigned int i) const

Protected Member Functions

double getInterpolatedValue_ (double x, RawDataPointConstIterator it_left)
template<typename InputPeakIterator>
double getInterpolatedValue_ (double x, InputPeakIterator it_left)

Protected Attributes

DPeakArray< RawDataPoint1Dsignal_
 The transformed signal.
std::vector< double > wavelet_
 The pretabulated wavelet used for the transform.
double scale_
 Spacing and scale of the wavelet and length of the signal.
double spacing_
int signal_length_
int end_left_padding_
int begin_right_padding_

Member Typedef Documentation

typedef std::vector<RawDataPoint1D >::const_iterator RawDataPointConstIterator

Raw data const iterator type.

Reimplemented in ContinuousWaveletTransformNumIntegration.


Constructor & Destructor Documentation

ContinuousWaveletTransform (  )  [inline]

Constructor.

virtual ~ContinuousWaveletTransform (  )  [inline, virtual]

Destructor.


Member Function Documentation

const DPeakArray<RawDataPoint1D >& getSignal (  )  const [inline]

Non-mutable access to the wavelet transform of the signal.

DPeakArray<RawDataPoint1D >& getSignal (  )  [inline]

Mutable access to the wavelet transform of the signal.

void setSignal ( const DPeakArray< RawDataPoint1D > &  signal  )  [inline]

Mutable access to the wavelet transform of the signal.

const std::vector<double>& getWavelet (  )  const [inline]

Non-mutable access to the wavelet.

std::vector<double>& getWavelet (  )  [inline]

Mutable access to the wavelet.

void setWavelet ( const std::vector< double > &  wavelet  )  [inline]

Mutable access to the signal.

DoubleReal getScale (  )  const [inline]

double& getScale (  )  [inline]

Mutable access to the spacing of raw data.

void setScale ( DoubleReal  scale  )  [inline]

Mutable access to the spacing of raw data.

DoubleReal getSpacing (  )  const [inline]

double& getSpacing (  )  [inline]

Mutable access to the spacing of raw data.

void setSpacing ( double  spacing  )  [inline]

Mutable access to the spacing of raw data.

Int getLeftPaddingIndex (  )  const [inline]

Non-mutable access to the position where the signal starts (in the intervall [0,end_left_padding_) are the padded zeros).

int& getLeftPaddingIndex (  )  [inline]

Mutable access to the position where the signal starts.

void setLeftPaddingIndex ( const int  end_left_padding  )  [inline]

Mutable access to position where the signal starts.

Int getRightPaddingIndex (  )  const [inline]

Non-mutable access to the position where the signal ends (in the intervall (begin_right_padding_,end] are the padded zeros).

int& getRightPaddingIndex (  )  [inline]

Mutable access to the position where the signal starts.

void setRightPaddingIndex ( const int  begin_right_padding  )  [inline]

Mutable access to position where the signal starts.

Int getSignalLength (  )  const [inline]

Non-mutable access to signal length [end_left_padding,begin_right_padding].

int& getSignalLength (  )  [inline]

Mutable access to signal length [end_left_padding,begin_right_padding].

void setSignalLength ( const int  signal_length  )  [inline]

Mutable access to signal length [end_left_padding,begin_right_padding].

int getSize (  )  const [inline]

Non-mutable access to signal length including padded zeros [0,end].

virtual void init ( double  scale,
double  spacing 
) [virtual]

Perform possibly necessary preprocessing steps, like tabulating the Wavelet.

Reimplemented in ContinuousWaveletTransformNumIntegration.

double operator[] ( unsigned int  i  )  [inline]

Yields the signal (intensity) at position i.

double operator[] ( unsigned int  i  )  const [inline]

double getInterpolatedValue_ ( double  x,
RawDataPointConstIterator  it_left 
) [protected]

Computes the interpolated value at position x (mz) given the iterator it_left, which points to the left neighbour raw data point of x in the original data

double getInterpolatedValue_ ( double  x,
InputPeakIterator  it_left 
) [inline, protected]


Member Data Documentation

DPeakArray<RawDataPoint1D > signal_ [protected]

The transformed signal.

std::vector<double> wavelet_ [protected]

The pretabulated wavelet used for the transform.

double scale_ [protected]

Spacing and scale of the wavelet and length of the signal.

double spacing_ [protected]

int signal_length_ [protected]

int end_left_padding_ [protected]

We often have to pad the transform at the left and right with zeros. Since we don't want to iterate over those as well, we have to store their positions.

int begin_right_padding_ [protected]


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:48 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1