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

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

Inheritance diagram for ContinuousWaveletTransform:

Public Types
typedef std::vector< Peak1D > ::const_iterator	PeakConstIterator
	Raw data const iterator type.
Public Member Functions
	ContinuousWaveletTransform ()
	Constructor.
virtual	~ContinuousWaveletTransform ()
	Destructor.
const std::vector< Peak1D > &	getSignal () const
	Non-mutable access to the wavelet transform of the signal.
std::vector< Peak1D > &	getSignal ()
	Mutable access to the wavelet transform of the signal.
void	setSignal (const std::vector< Peak1D > &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.
SignedSize	getLeftPaddingIndex () const
	Non-mutable access to the position where the signal starts (in the intervall [0,end_left_padding_) are the padded zeros).
SignedSize &	getLeftPaddingIndex ()
	Mutable access to the position where the signal starts.
void	setLeftPaddingIndex (const SignedSize end_left_padding)
	Mutable access to position where the signal starts.
SignedSize	getRightPaddingIndex () const
	Non-mutable access to the position where the signal ends (in the intervall (begin_right_padding_,end] are the padded zeros).
SignedSize &	getRightPaddingIndex ()
	Mutable access to the position where the signal starts.
void	setRightPaddingIndex (const SignedSize begin_right_padding)
	Mutable access to position where the signal starts.
SignedSize	getSignalLength () const
	Non-mutable access to signal length [end_left_padding,begin_right_padding].
SignedSize &	getSignalLength ()
	Mutable access to signal length [end_left_padding,begin_right_padding].
void	setSignalLength (const SignedSize 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
template<typename InputPeakIterator >
double	getInterpolatedValue_ (double x, InputPeakIterator it_left)
Protected Attributes
std::vector< Peak1D >	signal_
	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_
SignedSize	signal_length_
SignedSize	end_left_padding_
SignedSize	begin_right_padding_

Detailed Description

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

Member Typedef Documentation

typedef std::vector<Peak1D>::const_iterator PeakConstIterator

Raw data const iterator type.

Reimplemented in ContinuousWaveletTransformNumIntegration.

Constructor & Destructor Documentation

ContinuousWaveletTransform ( ) [inline]

Constructor.

virtual ~ContinuousWaveletTransform ( ) [inline, virtual]

Destructor.

Member Function Documentation

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

SignedSize getLeftPaddingIndex ( ) const [inline]

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

SignedSize& getLeftPaddingIndex ( ) [inline]

Mutable access to the position where the signal starts.

SignedSize getRightPaddingIndex ( ) const [inline]

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

SignedSize& getRightPaddingIndex ( ) [inline]

Mutable access to the position where the signal starts.

double& getScale ( ) [inline]

Mutable access to the spacing of raw data.

DoubleReal getScale ( ) const [inline]

std::vector<Peak1D>& getSignal ( ) [inline]

Mutable access to the wavelet transform of the signal.

const std::vector<Peak1D>& getSignal ( ) const [inline]

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

SignedSize getSignalLength ( ) const [inline]

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

SignedSize& getSignalLength ( ) [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].

double& getSpacing ( ) [inline]

Mutable access to the spacing of raw data.

DoubleReal getSpacing ( ) const [inline]

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

Non-mutable access to the wavelet.

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

Mutable access to the wavelet.

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]

void setLeftPaddingIndex ( const SignedSize end_left_padding ) [inline]

Mutable access to position where the signal starts.

void setRightPaddingIndex ( const SignedSize begin_right_padding ) [inline]

Mutable access to position where the signal starts.

void setScale ( DoubleReal scale ) [inline]

Mutable access to the spacing of raw data.

void setSignal ( const std::vector< Peak1D > & signal ) [inline]

Mutable access to the wavelet transform of the signal.

void setSignalLength ( const SignedSize signal_length ) [inline]

Mutable access to signal length [end_left_padding,begin_right_padding].

void setSpacing ( double spacing ) [inline]

Mutable access to the spacing of raw data.

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

Mutable access to the signal.

Member Data Documentation

SignedSize begin_right_padding_ [protected]

SignedSize 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.

double scale_ [protected]

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

std::vector<Peak1D> signal_ [protected]

The transformed signal.

SignedSize signal_length_ [protected]

double spacing_ [protected]

std::vector<double> wavelet_ [protected]

The pretabulated wavelet used for the transform.

OpenMS / TOPP release 1.10.0

Documentation generated on Thu Mar 7 2013 09:42:57 using doxygen 1.7.1

ContinuousWaveletTransform Class Reference

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation