ChromatogramExtractor#

class pyopenms.ChromatogramExtractor#

Bases: object

Cython implementation of _ChromatogramExtractor

Original C++ documentation is available here

– Inherits from [‘ProgressLogger’]

__init__()#

Overload:

__init__(self) None

Overload:

__init__(self, in_0: ChromatogramExtractor) None

Methods

__init__

Overload:

endProgress(self)

Ends the progress display

extractChromatograms(self, input, output, ...)

getLogType(self)

Returns the type of progress log being used

nextProgress(self)

Increment progress by 1 (according to range begin-end)

prepare_coordinates

__static_ChromatogramExtractor_prepare_coordinates(output_chromatograms: List[OSChromatogram] , extraction_coordinates: List[ExtractionCoordinates] , targeted: TargetedExperiment , rt_extraction_window: float , ms1: bool , ms1_isotopes: int ) -> None

setLogType(self, in_0)

Sets the progress log that should be used.

setProgress(self, value)

Sets the current progress

startProgress(self, begin, end, label)

endProgress(self) None#

Ends the progress display

extractChromatograms(self, input: SpectrumAccessOpenMS, output: List[OSChromatogram], extraction_coordinates: List[ExtractionCoordinates], mz_extraction_window: float, ppm: bool, im_extraction_window: float, filter: bytes | str | String) None#
getLogType(self) int#

Returns the type of progress log being used

nextProgress(self) None#

Increment progress by 1 (according to range begin-end)

prepare_coordinates()#

__static_ChromatogramExtractor_prepare_coordinates(output_chromatograms: List[OSChromatogram] , extraction_coordinates: List[ExtractionCoordinates] , targeted: TargetedExperiment , rt_extraction_window: float , ms1: bool , ms1_isotopes: int ) -> None

setLogType(self, in_0: int) None#

Sets the progress log that should be used. The default type is NONE!

setProgress(self, value: int) None#

Sets the current progress

startProgress(self, begin: int, end: int, label: bytes | str | String) None#