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

LinearResampler Class Reference

#include <OpenMS/FILTERING/TRANSFORMERS/LinearResampler.h>

Inheritance diagram for LinearResampler:

DefaultParamHandler ProgressLogger

List of all members.


Detailed Description

Linear Resampling of raw data.

This class can be used to generate uniform data from non-uniform raw data (e.g. ESI-TOF or MALDI-TOF experiments). Therefore the intensity at every position x in the input raw data is spread to the two adjacent resampling points. This method preserves the area of the input signal and also the centroid position of a peak. Therefore it is recommended for quantitation as well as for ProteinIdentification experiments.

Note:
Use this method only for high resoluted data (< 0.1 Th between two adjacent raw data points). The resampling rate should be >= the precision.
LinearResampler Parameters are explained on a separate page.

Public Member Functions

 LinearResampler ()
 Constructor.
 ~LinearResampler ()
 Destructor.
template<typename InputPeakIterator, typename OutputPeakContainer>
void raster (InputPeakIterator first, InputPeakIterator last, OutputPeakContainer &resampled_peak_container)
 Applies the resampling algorithm to to an given iterator range.
template<typename InputPeakContainer, typename OutputPeakContainer>
void raster (const InputPeakContainer &input_peak_container, OutputPeakContainer &baseline_filtered_container)
 Applies the resampling algorithm to a raw data point container.
template<typename InputSpectrumIterator, typename OutputPeakType>
void rasterExperiment (InputSpectrumIterator first, InputSpectrumIterator last, MSExperiment< OutputPeakType > &ms_exp_filtered)
 Resamples the data in a range of MSSpectra.
template<typename InputPeakType, typename OutputPeakType>
void rasterExperiment (const MSExperiment< InputPeakType > &ms_exp_raw, MSExperiment< OutputPeakType > &ms_exp_filtered)
 Resamples the data in an MSExperiment.

Protected Member Functions

virtual void updateMembers_ ()
 This method is used to update extra member variables at the end of the setParam() method.

Protected Attributes

double spacing_
 Spacing of the resampled data.

Constructor & Destructor Documentation

LinearResampler (  )  [inline]

Constructor.

~LinearResampler (  )  [inline]

Destructor.


Member Function Documentation

void raster ( InputPeakIterator  first,
InputPeakIterator  last,
OutputPeakContainer &  resampled_peak_container 
) [inline]

Applies the resampling algorithm to to an given iterator range.

Creates uniform data from the raw data given iterator intervall [first,last) and writes the resulting data to the resampled_peak_container.

Note:
This method assumes that the InputPeakIterator (e.g. of type MSSpectrum<RawDataPoint1D >::const_iterator) points to a data point of type RawDataPoint1D or any other class derived from RawDataPoint1D.
The resulting raw data in the resampled_peak_container (e.g. of type MSSpectrum<RawDataPoint1D >) can be of type RawDataPoint1D or any other class derived from RawDataPoint1D.

void raster ( const InputPeakContainer &  input_peak_container,
OutputPeakContainer &  baseline_filtered_container 
) [inline]

Applies the resampling algorithm to a raw data point container.

Creates uniform data from the raw data in the input container (e.g. of type MSSpectrum<RawDataPoint1D >) and writes the resulting data to the resampled_peak_container.

Note:
This method assumes that the InputPeakIterator (e.g. of type MSSpectrum<RawDataPoint1D >::const_iterator) points to a data point of type RawDataPoint1D or any other class derived from RawDataPoint1D.
The resulting raw data in the resampled_peak_container (e.g. of type MSSpectrum<RawDataPoint1D >) can be of type RawDataPoint1D or any other class derived from RawDataPoint1D.

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

Resamples the data in a range of MSSpectra.

Rasters the raw data successive in every scan in the intervall [first,last). The resampled data are stored in a MSExperiment.

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

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

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

Resamples the data in an MSExperiment.

Rasters the raw data of every scan in the MSExperiment. The resampled data are stored in a MSExperiment.

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

virtual void updateMembers_ (  )  [inline, protected, virtual]

This method is used to update extra member variables at the end of the setParam() method.

Also call it at the end of the derived classes' copy constructor and assignment operator.

The default implementation is empty.

Reimplemented from DefaultParamHandler.


Member Data Documentation

double spacing_ [protected]

Spacing of the resampled data.


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