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

SignalToNoiseEstimator Class Template Reference

#include <OpenMS/FILTERING/NOISEESTIMATION/SignalToNoiseEstimator.h>

Inheritance diagram for SignalToNoiseEstimator:

DefaultParamHandler ProgressLogger SignalToNoiseEstimatorMeanIterative SignalToNoiseEstimatorMedian

List of all members.


Detailed Description

template<typename Container = MSSpectrum< >>
class OpenMS::SignalToNoiseEstimator< Container >

This class represents the abstract base class of a signal to noise estimator.

A signal to noise estimator should provide the signal to noise ratio of all raw data points in a given intervall [first_,last_).

Public Types

Type definitions
typedef Container::const_iterator PeakIterator
typedef PeakIterator::value_type PeakType

Public Member Functions

 SignalToNoiseEstimator ()
 Constructor.
 SignalToNoiseEstimator (const SignalToNoiseEstimator &source)
 Copy constructor.
SignalToNoiseEstimatoroperator= (const SignalToNoiseEstimator &source)
 Assignment operator.
virtual ~SignalToNoiseEstimator ()
 Destructor.
virtual void init (const PeakIterator &it_begin, const PeakIterator &it_end)
 Set the start and endpoint of the raw data intervall, for which signal to noise ratios will be estimated immediately.
virtual void init (const Container &c)
 Set the start and endpoint of the raw data intervall, for which signal to noise ratios will be estimated immediately.
virtual double getSignalToNoise (const PeakIterator &data_point)
virtual double getSignalToNoise (const PeakType &data_point)

Protected Member Functions

virtual void computeSTN_ (const PeakIterator &scan_first_, const PeakIterator &scan_last_)=0 throw (Exception::InvalidValue)
GaussianEstimate estimate_ (const PeakIterator &scan_first_, const PeakIterator &scan_last_) const
 calculate mean & stdev of intensities of a DPeakArray

Protected Attributes

std::map< PeakType, double,
typename
PeakType::PositionLess > 
stn_estimates_
 stores the noise estimate for each peak
PeakIterator first_
 points to the first raw data point in the interval
PeakIterator last_
 points to the right position next to the last raw data point in the interval
bool is_result_valid_
 flag: set to true if SignalToNoise estimates are calculated and none of the params were changed. otherwise false.

Classes

struct  GaussianEstimate
 protected struct to store parameters my, sigma for a gaussian distribution More...


Member Typedef Documentation

typedef Container::const_iterator PeakIterator

Reimplemented in SignalToNoiseEstimatorMeanIterative, and SignalToNoiseEstimatorMedian.

typedef PeakIterator::value_type PeakType

Reimplemented in SignalToNoiseEstimatorMeanIterative, and SignalToNoiseEstimatorMedian.


Constructor & Destructor Documentation

SignalToNoiseEstimator (  )  [inline]

Constructor.

SignalToNoiseEstimator ( const SignalToNoiseEstimator< Container > &  source  )  [inline]

Copy constructor.

virtual ~SignalToNoiseEstimator (  )  [inline, virtual]

Destructor.


Member Function Documentation

SignalToNoiseEstimator& operator= ( const SignalToNoiseEstimator< Container > &  source  )  [inline]

Assignment operator.

virtual void init ( const PeakIterator it_begin,
const PeakIterator it_end 
) [inline, virtual]

Set the start and endpoint of the raw data intervall, for which signal to noise ratios will be estimated immediately.

virtual void init ( const Container &  c  )  [inline, virtual]

Set the start and endpoint of the raw data intervall, for which signal to noise ratios will be estimated immediately.

virtual double getSignalToNoise ( const PeakIterator data_point  )  [inline, virtual]

Return to signal/noise estimate for data point data_point

Note:
the first query to this function will take longer, as all SignalToNoise values are calculated

you will get a warning to stderr if more than 20% of the noise estimates used sparse windows

virtual double getSignalToNoise ( const PeakType data_point  )  [inline, virtual]

virtual void computeSTN_ ( const PeakIterator scan_first_,
const PeakIterator scan_last_ 
) throw (Exception::InvalidValue) [protected, pure virtual]

GaussianEstimate estimate_ ( const PeakIterator scan_first_,
const PeakIterator scan_last_ 
) const [inline, protected]

calculate mean & stdev of intensities of a DPeakArray


Member Data Documentation

std::map< PeakType, double, typename PeakType::PositionLess > stn_estimates_ [protected]

stores the noise estimate for each peak

PeakIterator first_ [protected]

points to the first raw data point in the interval

PeakIterator last_ [protected]

points to the right position next to the last raw data point in the interval

bool is_result_valid_ [mutable, protected]

flag: set to true if SignalToNoise estimates are calculated and none of the params were changed. otherwise false.


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