MorphologicalFilter#

class pyopenms.MorphologicalFilter#

Bases: object

Cython implementation of _MorphologicalFilter

Original C++ documentation is available here

– Inherits from [‘DefaultParamHandler’, ‘ProgressLogger’]

__init__(self) None#

Methods

__init__(self)

endProgress(self)

Ends the progress display

filter(self, spectrum)

Applies the morphological filtering operation to an MSSpectrum

filterExperiment(self, exp)

Applies the morphological filtering operation to an MSExperiment

getDefaults(self)

Returns the default parameters

getLogType(self)

Returns the type of progress log being used

getName(self)

Returns the name

getParameters(self)

Returns the parameters

getSubsections(self)

nextProgress(self)

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

setLogType(self, in_0)

Sets the progress log that should be used.

setName(self, in_0)

Sets the name

setParameters(self, param)

Sets the parameters

setProgress(self, value)

Sets the current progress

startProgress(self, begin, end, label)

endProgress(self) None#

Ends the progress display

filter(self, spectrum: MSSpectrum) None#

Applies the morphological filtering operation to an MSSpectrum

If the size of the structuring element is given in ‘Thomson’, the number of data points for the structuring element is computed as follows:

filterExperiment(self, exp: MSExperiment) None#

Applies the morphological filtering operation to an MSExperiment

The size of the structuring element is computed for each spectrum individually, if it is given in ‘Thomson’ See the filtering method for MSSpectrum for details

getDefaults(self) Param#

Returns the default parameters

getLogType(self) int#

Returns the type of progress log being used

getName(self) bytes | str | String#

Returns the name

getParameters(self) Param#

Returns the parameters

getSubsections(self) List[bytes]#
nextProgress(self) None#

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

setLogType(self, in_0: int) None#

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

setName(self, in_0: bytes | str | String) None#

Sets the name

setParameters(self, param: Param) None#

Sets the parameters

setProgress(self, value: int) None#

Sets the current progress

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