SignalToNoiseEstimatorMedianSettings Struct Reference

The parameters of SignalToNoiseEstimatorMedian as plain values; the defaults are those of its parameters. More...

#include <OpenMS/PROCESSING/NOISEESTIMATION/SignalToNoiseEstimatorMedianSettings.h>

Static Public Member Functions
static SignalToNoiseEstimatorMedianSettings	fromParam (const Param &p)
	Reads the settings from the parameters of a SignalToNoiseEstimatorMedian (e.g. a "SignalToNoise:" subsection)

Public Attributes
double	max_intensity = -1
double	auto_max_stdev_factor = 3.0
double	auto_max_percentile = 95
int	auto_mode = 0
	-1: 'max_intensity', 0: mean + 'auto_max_stdev_factor' * stdev, 1: 'auto_max_percentile'
double	win_len = 200.0
int	bin_count = 30
int	min_required_elements = 10
double	noise_for_empty_window = std::pow(10.0, 20)
bool	write_log_messages = true

Detailed Description

The parameters of SignalToNoiseEstimatorMedian as plain values; the defaults are those of its parameters.

Kept apart from the estimator, so that classes that estimate many containers (e.g. PeakPickerHiRes) can hold the settings as a member and call SignalToNoiseEstimatorMedian::estimate() without building an estimator object. The type does not depend on the container type of the estimator.

Member Function Documentation

fromParam()

static SignalToNoiseEstimatorMedianSettings fromParam ( const Param &  p )

inlinestatic

Reads the settings from the parameters of a SignalToNoiseEstimatorMedian (e.g. a "SignalToNoise:" subsection)

References SignalToNoiseEstimatorMedianSettings::auto_max_percentile, SignalToNoiseEstimatorMedianSettings::auto_max_stdev_factor, SignalToNoiseEstimatorMedianSettings::auto_mode, SignalToNoiseEstimatorMedianSettings::bin_count, Param::getValue(), SignalToNoiseEstimatorMedianSettings::max_intensity, SignalToNoiseEstimatorMedianSettings::min_required_elements, SignalToNoiseEstimatorMedianSettings::noise_for_empty_window, ParamValue::toBool(), SignalToNoiseEstimatorMedianSettings::win_len, and SignalToNoiseEstimatorMedianSettings::write_log_messages.

Member Data Documentation

auto_max_percentile

double auto_max_percentile = 95

Referenced by SignalToNoiseEstimatorMedian< Container >::computeSTN_(), SignalToNoiseEstimatorMedian< Container >::estimate(), and SignalToNoiseEstimatorMedianSettings::fromParam().

auto_max_stdev_factor

double auto_max_stdev_factor = 3.0

Referenced by SignalToNoiseEstimatorMedian< Container >::computeSTN_(), SignalToNoiseEstimatorMedian< Container >::estimate(), and SignalToNoiseEstimatorMedianSettings::fromParam().

auto_mode

int auto_mode = 0

-1: 'max_intensity', 0: mean + 'auto_max_stdev_factor' * stdev, 1: 'auto_max_percentile'

Referenced by SignalToNoiseEstimatorMedian< Container >::computeSTN_(), SignalToNoiseEstimatorMedian< Container >::estimate(), and SignalToNoiseEstimatorMedianSettings::fromParam().

bin_count

int bin_count = 30

Referenced by SignalToNoiseEstimatorMedian< Container >::computeSTN_(), SignalToNoiseEstimatorMedian< Container >::estimate(), SignalToNoiseEstimatorMedianSettings::fromParam(), and SignalToNoiseOpenMS< ContainerT >::SignalToNoiseOpenMS().

max_intensity

double max_intensity = -1

Referenced by SignalToNoiseEstimatorMedian< Container >::computeSTN_(), SignalToNoiseEstimatorMedian< Container >::estimate(), and SignalToNoiseEstimatorMedianSettings::fromParam().

min_required_elements

int min_required_elements = 10

Referenced by SignalToNoiseEstimatorMedian< Container >::computeSTN_(), SignalToNoiseEstimatorMedian< Container >::estimate(), and SignalToNoiseEstimatorMedianSettings::fromParam().

noise_for_empty_window

double noise_for_empty_window = std::pow(10.0, 20)

Referenced by SignalToNoiseEstimatorMedian< Container >::computeSTN_(), SignalToNoiseEstimatorMedian< Container >::estimate(), and SignalToNoiseEstimatorMedianSettings::fromParam().

win_len

double win_len = 200.0

Referenced by SignalToNoiseEstimatorMedian< Container >::computeSTN_(), SignalToNoiseEstimatorMedian< Container >::estimate(), SignalToNoiseEstimatorMedianSettings::fromParam(), and SignalToNoiseOpenMS< ContainerT >::SignalToNoiseOpenMS().

write_log_messages

bool write_log_messages = true

Referenced by SignalToNoiseEstimatorMedian< Container >::computeSTN_(), SignalToNoiseEstimatorMedian< Container >::estimate(), SignalToNoiseEstimatorMedianSettings::fromParam(), and SignalToNoiseOpenMS< ContainerT >::SignalToNoiseOpenMS().