SignalToNoiseEstimatorMedianRapid::NoiseEstimator Struct Reference

Class to compute the noise value at a given position. More...

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

Collaboration diagram for SignalToNoiseEstimatorMedianRapid::NoiseEstimator:

Public Member Functions
	NoiseEstimator ()
	Constructor. More...
	NoiseEstimator (double nr_windows_, double mz_start_, double win_len_)
	Constructor. More...
double	get_noise_value (double mz)
	Return the noise value at a given m/z position. More...
double	get_noise_even (double mz)
double	get_noise_odd (double mz)

Public Attributes
int	nr_windows
	Number of windows in m/z direction for which noise values are stored. More...
double	mz_start
	Start of m/z domain. More...
double	window_length
	Length of the window in m/z direction. More...
std::vector< double >	result_windows_even
	Noise values for window starting at mz_start (length = nr_windows) More...
std::vector< double >	result_windows_odd
	Noise values for window starting at mz_start - 0.5 * window_length (length = nr_windows + 1) More...

Detailed Description

Class to compute the noise value at a given position.

This class implements a method to obtain the noise value at any given m/z position. For a median based noise estimator, the noise at position m/z is given by the median intensity in a window around this position. This noise estimator has median estimates for a set of precomputed windows and retrieves the appropriate noise value from the closest window. To lower errors at the bin borders, two noise binning values are provided (for a set of windows offset by 1/2 of the window width) and the reported value is the average of these two values.

Constructor & Destructor Documentation

NoiseEstimator() [1/2]

NoiseEstimator ( )

inline

Constructor.

NoiseEstimator() [2/2]

NoiseEstimator ( double  nr_windows_, double  mz_start_, double  win_len_  )

inline

Constructor.

Member Function Documentation

get_noise_even()

double get_noise_even ( double  mz )

inline

get_noise_odd()

double get_noise_odd ( double  mz )

inline

get_noise_value()

double get_noise_value ( double  mz )

inline

Return the noise value at a given m/z position.

Will return the noise value at a given m/z position.

Note

Will return 1.0 if the noise would be lower than 1.0

Member Data Documentation

mz_start

double mz_start

Start of m/z domain.

nr_windows

int nr_windows

Number of windows in m/z direction for which noise values are stored.

result_windows_even

std::vector<double> result_windows_even

Noise values for window starting at mz_start (length = nr_windows)

Referenced by SignalToNoiseEstimatorMedianRapid::estimateNoise().

result_windows_odd

std::vector<double> result_windows_odd

Noise values for window starting at mz_start - 0.5 * window_length (length = nr_windows + 1)

Referenced by SignalToNoiseEstimatorMedianRapid::estimateNoise().

window_length

double window_length

Length of the window in m/z direction.