ProteoWizard
Public Member Functions | Public Attributes | List of all members
pwiz::frequency::PeakDetectorMatchedFilter::Config Struct Reference

structure for holding configuration More...

#include <PeakDetectorMatchedFilter.hpp>

Public Member Functions

 Config ()
 

Public Attributes

const chemistry::IsotopeEnvelopeEstimatorisotopeEnvelopeEstimator
 IsotopeEnvelopeEstimator pointer, must be valid for PeakDetector lifetime. More...
 
int filterMatchRate
 number of filter correlations computed per frequency step More...
 
int filterSampleRadius
 number of filter samples taken on either side of 0 More...
 
double peakThresholdFactor
 noise floor multiple for initial peak reporting threshold More...
 
double peakMaxCorrelationAngle
 maximum correlation angle (degrees) for initial peak reporting More...
 
double isotopeThresholdFactor
 noise floor multiple for isotope filter threshold More...
 
double monoisotopicPeakThresholdFactor
 noise floor multiple for monoisotopic peak threshold More...
 
int isotopeMaxChargeState
 isotope filter maximum charge state to score More...
 
int isotopeMaxNeutronCount
 isotope filter maximum number of neutrons to score More...
 
double collapseRadius
 multiple peaks within this radius (Hz) are reported as single peak More...
 
bool useMagnitudeFilter
 use the magnitude of the peak shape filter kernel for finding peaks More...
 
int logDetailLevel
 log detail level (0 == normal, 1 == extra) More...
 
std::ostream * log
 log stream (0 == no logging) More...
 

Detailed Description

structure for holding configuration

Definition at line 46 of file PeakDetectorMatchedFilter.hpp.

Constructor & Destructor Documentation

§ Config()

pwiz::frequency::PeakDetectorMatchedFilter::Config::Config ( )
inline

Definition at line 87 of file PeakDetectorMatchedFilter.hpp.

89  filterMatchRate(0),
97  collapseRadius(0),
98  useMagnitudeFilter(false),
99  logDetailLevel(0),
100  log(0)
101  {}
double collapseRadius
multiple peaks within this radius (Hz) are reported as single peak
int filterSampleRadius
number of filter samples taken on either side of 0
int isotopeMaxNeutronCount
isotope filter maximum number of neutrons to score
int logDetailLevel
log detail level (0 == normal, 1 == extra)
const chemistry::IsotopeEnvelopeEstimator * isotopeEnvelopeEstimator
IsotopeEnvelopeEstimator pointer, must be valid for PeakDetector lifetime.
double monoisotopicPeakThresholdFactor
noise floor multiple for monoisotopic peak threshold
std::ostream * log
log stream (0 == no logging)
double peakThresholdFactor
noise floor multiple for initial peak reporting threshold
int filterMatchRate
number of filter correlations computed per frequency step
double peakMaxCorrelationAngle
maximum correlation angle (degrees) for initial peak reporting
int isotopeMaxChargeState
isotope filter maximum charge state to score
double isotopeThresholdFactor
noise floor multiple for isotope filter threshold
bool useMagnitudeFilter
use the magnitude of the peak shape filter kernel for finding peaks

Member Data Documentation

§ isotopeEnvelopeEstimator

const chemistry::IsotopeEnvelopeEstimator* pwiz::frequency::PeakDetectorMatchedFilter::Config::isotopeEnvelopeEstimator

IsotopeEnvelopeEstimator pointer, must be valid for PeakDetector lifetime.

Definition at line 49 of file PeakDetectorMatchedFilter.hpp.

Referenced by testCreation(), and testFind().

§ filterMatchRate

int pwiz::frequency::PeakDetectorMatchedFilter::Config::filterMatchRate

number of filter correlations computed per frequency step

Definition at line 52 of file PeakDetectorMatchedFilter.hpp.

Referenced by testCreation(), and testFind().

§ filterSampleRadius

int pwiz::frequency::PeakDetectorMatchedFilter::Config::filterSampleRadius

number of filter samples taken on either side of 0

Definition at line 55 of file PeakDetectorMatchedFilter.hpp.

Referenced by testCreation(), and testFind().

§ peakThresholdFactor

double pwiz::frequency::PeakDetectorMatchedFilter::Config::peakThresholdFactor

noise floor multiple for initial peak reporting threshold

Definition at line 58 of file PeakDetectorMatchedFilter.hpp.

Referenced by testCreation(), and testFind().

§ peakMaxCorrelationAngle

double pwiz::frequency::PeakDetectorMatchedFilter::Config::peakMaxCorrelationAngle

maximum correlation angle (degrees) for initial peak reporting

Definition at line 61 of file PeakDetectorMatchedFilter.hpp.

Referenced by testCreation(), and testFind().

§ isotopeThresholdFactor

double pwiz::frequency::PeakDetectorMatchedFilter::Config::isotopeThresholdFactor

noise floor multiple for isotope filter threshold

Definition at line 64 of file PeakDetectorMatchedFilter.hpp.

Referenced by testCreation(), and testFind().

§ monoisotopicPeakThresholdFactor

double pwiz::frequency::PeakDetectorMatchedFilter::Config::monoisotopicPeakThresholdFactor

noise floor multiple for monoisotopic peak threshold

Definition at line 67 of file PeakDetectorMatchedFilter.hpp.

Referenced by testCreation(), and testFind().

§ isotopeMaxChargeState

int pwiz::frequency::PeakDetectorMatchedFilter::Config::isotopeMaxChargeState

isotope filter maximum charge state to score

Definition at line 70 of file PeakDetectorMatchedFilter.hpp.

Referenced by testFind().

§ isotopeMaxNeutronCount

int pwiz::frequency::PeakDetectorMatchedFilter::Config::isotopeMaxNeutronCount

isotope filter maximum number of neutrons to score

Definition at line 73 of file PeakDetectorMatchedFilter.hpp.

Referenced by testFind().

§ collapseRadius

double pwiz::frequency::PeakDetectorMatchedFilter::Config::collapseRadius

multiple peaks within this radius (Hz) are reported as single peak

Definition at line 76 of file PeakDetectorMatchedFilter.hpp.

Referenced by testFind().

§ useMagnitudeFilter

bool pwiz::frequency::PeakDetectorMatchedFilter::Config::useMagnitudeFilter

use the magnitude of the peak shape filter kernel for finding peaks

Definition at line 79 of file PeakDetectorMatchedFilter.hpp.

Referenced by testFind().

§ logDetailLevel

int pwiz::frequency::PeakDetectorMatchedFilter::Config::logDetailLevel

log detail level (0 == normal, 1 == extra)

Definition at line 82 of file PeakDetectorMatchedFilter.hpp.

Referenced by testFind().

§ log

std::ostream* pwiz::frequency::PeakDetectorMatchedFilter::Config::log

log stream (0 == no logging)

Definition at line 85 of file PeakDetectorMatchedFilter.hpp.

Referenced by testFind().


The documentation for this struct was generated from the following file: