PeakIntegrator#
- class pyopenms.PeakIntegrator#
Bases:
DefaultParamHandlerCompute the area, background and shape metrics of a peak
The area computation is performed in integratePeak() and it supports integration by simple sum of the intensity, integration by Simpson’s rule implementations for an odd number of unequally spaced points or integration by the trapezoid rule
The background computation is performed in estimateBackground() and it supports three different approaches to baseline correction, namely computing a rectangular shape under the peak based on the minimum value of the peak borders (vertical_division_min), a rectangular shape based on the maximum value of the beak borders (vertical_division_max) or a trapezoidal shape based on a straight line between the peak borders (base_to_base)
Peak shape metrics are computed in calculatePeakShapeMetrics() and multiple metrics are supported
The containers supported by the methods are MSChromatogram and MSSpectrum
- __init__() None#
- __init__(arg: pyopenms.PeakIntegrator, /) None
Methods
__init__()calculatePeakShapeMetrics(chromatogram, ...)Overloaded function.
estimateBackground(chromatogram, left, ...)Overloaded function.
Returns default parameters
Returns the default parameters
getName()Returns the name
Returns the parameters
integratePeak(chromatogram, left, right)Overloaded function.
setName(name)Sets the name
setParameters(param)Sets the parameters
- calculatePeakShapeMetrics(chromatogram: pyopenms.MSChromatogram, left: float, right: float, peak_height: float, peak_apex_pos: float) pyopenms.PI_PeakShapeMetrics#
- calculatePeakShapeMetrics(spectrum: pyopenms.MSSpectrum, left: float, right: float, peak_height: float, peak_apex_pos: float) pyopenms.PI_PeakShapeMetrics
- calculatePeakShapeMetrics(chromatogram: pyopenms.MSChromatogram, left: float, right: float, peak_height: float, peak_apex_pos: float) pyopenms.PI_PeakShapeMetrics
Overloaded function.
calculatePeakShapeMetrics(chromatogram: pyopenms.MSChromatogram, left: float, right: float, peak_height: float, peak_apex_pos: float) -> pyopenms.PI_PeakShapeMetricscalculatePeakShapeMetrics(spectrum: pyopenms.MSSpectrum, left: float, right: float, peak_height: float, peak_apex_pos: float) -> pyopenms.PI_PeakShapeMetricscalculatePeakShapeMetrics(chromatogram: pyopenms.MSChromatogram, left: float, right: float, peak_height: float, peak_apex_pos: float) -> pyopenms.PI_PeakShapeMetrics
Calculate peak shape metrics
- estimateBackground(chromatogram: pyopenms.MSChromatogram, left: float, right: float, peak_apex_pos: float) pyopenms.PI_PeakBackground#
- estimateBackground(spectrum: pyopenms.MSSpectrum, left: float, right: float, peak_apex_pos: float) pyopenms.PI_PeakBackground
- estimateBackground(chromatogram: pyopenms.MSChromatogram, left: float, right: float, peak_apex_pos: float) pyopenms.PI_PeakBackground
Overloaded function.
estimateBackground(chromatogram: pyopenms.MSChromatogram, left: float, right: float, peak_apex_pos: float) -> pyopenms.PI_PeakBackgroundestimateBackground(spectrum: pyopenms.MSSpectrum, left: float, right: float, peak_apex_pos: float) -> pyopenms.PI_PeakBackgroundestimateBackground(chromatogram: pyopenms.MSChromatogram, left: float, right: float, peak_apex_pos: float) -> pyopenms.PI_PeakBackground
Estimate background in chromatogram
- getDefaultParameters() pyopenms.Param#
Returns default parameters
- getDefaults() pyopenms.Param#
Returns the default parameters
- getName() str#
Returns the name
- getParameters() pyopenms.Param#
Returns the parameters
- getSubsections() list[str]#
- integratePeak(chromatogram: pyopenms.MSChromatogram, left: float, right: float) pyopenms.PI_PeakArea#
- integratePeak(spectrum: pyopenms.MSSpectrum, left: float, right: float) pyopenms.PI_PeakArea
- integratePeak(chromatogram: pyopenms.MSChromatogram, left: float, right: float) pyopenms.PI_PeakArea
- integratePeak(spectrum: pyopenms.MSSpectrum, left: float, right: float) pyopenms.PI_PeakArea
Overloaded function.
integratePeak(chromatogram: pyopenms.MSChromatogram, left: float, right: float) -> pyopenms.PI_PeakAreaintegratePeak(spectrum: pyopenms.MSSpectrum, left: float, right: float) -> pyopenms.PI_PeakAreaintegratePeak(chromatogram: pyopenms.MSChromatogram, left: float, right: float) -> pyopenms.PI_PeakArea
Integrate peak in chromatogram
integratePeak(spectrum: pyopenms.MSSpectrum, left: float, right: float) -> pyopenms.PI_PeakArea
Integrate peak in spectrum
- setName(name: str) None#
Sets the name
- setParameters(param: pyopenms.Param) None#
Sets the parameters