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

SmoothFilter Class Reference

#include <OpenMS/FILTERING/SMOOTHING/SmoothFilter.h>

Inheritance diagram for SmoothFilter:

ProgressLogger GaussFilter SavitzkyGolayFilter

List of all members.


Detailed Description

Base class for all noise filter implementations.

Public Member Functions

 SmoothFilter ()
 Constructor.
virtual ~SmoothFilter ()
 Destructor.
template<typename InputPeakIterator, typename OutputPeakContainer>
void filter (InputPeakIterator first, InputPeakIterator last, OutputPeakContainer &smoothed_data_container)
 Applies the convolution with the filter coefficients to an given iterator range.
template<typename InputPeakContainer, typename OutputPeakContainer>
void filter (const InputPeakContainer &input_peak_container, OutputPeakContainer &smoothed_data_container)
 Convolutes the filter coefficients and the input raw data.
template<typename InputSpectrumIterator, typename OutputPeakType>
void filterExperiment (InputSpectrumIterator first, InputSpectrumIterator last, MSExperiment< OutputPeakType > &ms_exp_filtered)
 Filters every MSSpectrum in a given iterator range.
template<typename InputPeakType, typename OutputPeakType>
void filterExperiment (const MSExperiment< InputPeakType > &ms_exp_raw, MSExperiment< OutputPeakType > &ms_exp_filtered)
 Filters an MSExperiment.

Protected Attributes

std::vector< DoubleRealcoeffs_
 The coefficient matrix.

Constructor & Destructor Documentation

SmoothFilter (  )  [inline]

Constructor.

virtual ~SmoothFilter (  )  [inline, virtual]

Destructor.


Member Function Documentation

void filter ( InputPeakIterator  first,
InputPeakIterator  last,
OutputPeakContainer &  smoothed_data_container 
) [inline]

Applies the convolution with the filter coefficients to an given iterator range.

Convolutes the filter and the raw data in the iterator intervall [first,last) and writes the resulting data to the smoothed_data_container.

Note:
This method assumes that the InputPeakIterator (e.g. of type MSSpectrum<DRawDataPoint<1> >const_iterator) points to a data point of type DRawDataPoint<1> or any other class derived from DRawDataPoint<1>.

The resulting peaks in the smoothed_data_container (e.g. of type MSSpectrum<DRawDataPoint<1> >) can be of type DRawDataPoint<1> or any other class derived from DRawDataPoint.

Reimplemented in GaussFilter, and SavitzkyGolayFilter.

void filter ( const InputPeakContainer &  input_peak_container,
OutputPeakContainer &  smoothed_data_container 
) [inline]

Convolutes the filter coefficients and the input raw data.

Convolutes the filter and the raw data in the input_peak_container and writes the resulting data to the smoothed_data_container.

Note:
This method assumes that the elements of the InputPeakContainer (e.g. of type MSSpectrum<DRawDataPoint<1> >) are of type DRawDataPoint<1> or any other class derived from DRawDataPoint<1>.

The resulting peaks in the smoothed_data_container (e.g. of type MSSpectrum<DRawDataPoint<1> >) can be of type DRawDataPoint<1> or any other class derived from DRawDataPoint.

Reimplemented in GaussFilter, and SavitzkyGolayFilter.

void filterExperiment ( InputSpectrumIterator  first,
InputSpectrumIterator  last,
MSExperiment< OutputPeakType > &  ms_exp_filtered 
) [inline]

Filters every MSSpectrum in a given iterator range.

Filters the data successive in every scan in the intervall [first,last). The filtered data are stored in a MSExperiment.

Note:
The InputSpectrumIterator should point to a MSSpectrum. Elements of the input spectra should be of type DRawDataPoint<1> or any other derived class of DRawDataPoint.

You have to copy the ExperimentalSettings of the raw data by your own.

Reimplemented in GaussFilter, and SavitzkyGolayFilter.

void filterExperiment ( const MSExperiment< InputPeakType > &  ms_exp_raw,
MSExperiment< OutputPeakType > &  ms_exp_filtered 
) [inline]

Filters an MSExperiment.

Filters the data every scan in the MSExperiment. The filtered data are stored in an MSExperiment.

Note:
The InputPeakType as well as the OutputPeakType should be of type DRawDataPoint<1> or any other derived class of DRawDataPoint.

Reimplemented in GaussFilter, and SavitzkyGolayFilter.


Member Data Documentation

std::vector<DoubleReal> coeffs_ [protected]

The coefficient matrix.


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