IsotopePatternGenerator Class Reference

Provides an interface for different isotope pattern generator methods. More...

#include <OpenMS/CHEMISTRY/ISOTOPEDISTRIBUTION/IsotopePatternGenerator.h>

Inheritance diagram for IsotopePatternGenerator:

Collaboration diagram for IsotopePatternGenerator:

Public Member Functions
	IsotopePatternGenerator ()
	IsotopePatternGenerator (double probability_cutoff)
virtual IsotopeDistribution	run (const EmpiricalFormula &) const =0
	interface that is being used by the Isotope Pattern Generator methods. More...
virtual	~IsotopePatternGenerator ()

Protected Attributes
double	min_prob_

Detailed Description

Provides an interface for different isotope pattern generator methods.

The IsotopePatternGenerator interface allows the developer integrate various isotope pattern generator methods in the OpenMS code. It provides a run() method that generates but does not hold any generated isotope distribution data in the class. Instead it returns an IsotopeDistribution to the caller.

Constructor & Destructor Documentation

IsotopePatternGenerator() [1/2]

IsotopePatternGenerator

(

)

IsotopePatternGenerator() [2/2]

IsotopePatternGenerator

(

double

probability_cutoff

)

~IsotopePatternGenerator()

virtual ~IsotopePatternGenerator ( )

virtual

Member Function Documentation

run()

virtual IsotopeDistribution run ( const EmpiricalFormula &  ) const

pure virtual

interface that is being used by the Isotope Pattern Generator methods.

Method that calculates the isotope distribution for the given formula.

Implemented in FineIsotopePatternGenerator, and CoarseIsotopePatternGenerator.

Member Data Documentation

min_prob_

double min_prob_

protected