ProteoWizard
Public Types | Public Member Functions | List of all members
pwiz::analysis::PeakFamilyDetector Class Referenceabstract

interface for peak family (isotope envelope) detection More...

#include <PeakFamilyDetector.hpp>

Inheritance diagram for pwiz::analysis::PeakFamilyDetector:
pwiz::analysis::PeakFamilyDetectorFT

Public Types

typedef pwiz::msdata::MZIntensityPair MZIntensityPair
 
typedef pwiz::data::peakdata::PeakFamily PeakFamily
 

Public Member Functions

virtual void detect (const MZIntensityPair *begin, const MZIntensityPair *end, std::vector< PeakFamily > &result)=0
 find peak families in a specified array of MZIntensityPair More...
 
virtual void detect (const std::vector< MZIntensityPair > &data, std::vector< PeakFamily > &result)
 convenience function – equivalent to: detect(&data[0], &data[0]+data.size(), result) More...
 
virtual ~PeakFamilyDetector ()
 

Detailed Description

interface for peak family (isotope envelope) detection

Definition at line 40 of file PeakFamilyDetector.hpp.

Member Typedef Documentation

§ MZIntensityPair

Definition at line 44 of file PeakFamilyDetector.hpp.

§ PeakFamily

Definition at line 45 of file PeakFamilyDetector.hpp.

Constructor & Destructor Documentation

§ ~PeakFamilyDetector()

virtual pwiz::analysis::PeakFamilyDetector::~PeakFamilyDetector ( )
inlinevirtual

Definition at line 57 of file PeakFamilyDetector.hpp.

57 {}

Member Function Documentation

§ detect() [1/2]

virtual void pwiz::analysis::PeakFamilyDetector::detect ( const MZIntensityPair begin,
const MZIntensityPair end,
std::vector< PeakFamily > &  result 
)
pure virtual

find peak families in a specified array of MZIntensityPair

Implemented in pwiz::analysis::PeakFamilyDetectorFT.

§ detect() [2/2]

virtual void pwiz::analysis::PeakFamilyDetector::detect ( const std::vector< MZIntensityPair > &  data,
std::vector< PeakFamily > &  result 
)
virtual

convenience function – equivalent to: detect(&data[0], &data[0]+data.size(), result)


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