FineIsotopePatternGenerator#

class pyopenms.FineIsotopePatternGenerator#

Bases: object

Cython implementation of _FineIsotopePatternGenerator

Original C++ documentation is available here

Isotope pattern generator for fine isotope distributions. Generates isotopes until a stop condition (threshold) is reached, the lower the threshold the more isotopes are generated. The parameter use_total_prob defines whether the stop condition is interpreted as the total probability that the distribution should cover (default) or as a threshold for individual peaks. Finally, the absolute parameter specifies for individual peak thresholding if the threshold is absolute or relative.

__init__()#

Overload:

__init__(self) None

Overload:

__init__(self, threshold: float) None

Overload:

__init__(self, threshold: float, use_total_prob: bool) None

Overload:

__init__(self, threshold: float, use_total_prob: bool, absolute: bool) None

Methods

__init__

Overload:

getAbsolute(self)

getThreshold(self)

getTotalProbability(self)

run(self, in_0)

setAbsolute(self, absolute)

setThreshold(self, threshold)

setTotalProbability(self, total)

getAbsolute(self) bool#
getThreshold(self) float#
getTotalProbability(self) bool#
run(self, in_0: EmpiricalFormula) IsotopeDistribution#
setAbsolute(self, absolute: bool) None#
setThreshold(self, threshold: float) None#
setTotalProbability(self, total: bool) None#