MasstraceCorrelator#

class pyopenms.MasstraceCorrelator#

Bases: object

Cython implementation of _MasstraceCorrelator

Original C++ documentation is available here: – Inherits from [‘DefaultParamHandler’, ‘ProgressLogger’]

__init__()#

Overload:

__init__(self) → None

Overload:

__init__(self, in_0: MasstraceCorrelator) → None

Methods

`__init__`	Overload:
`createPseudoSpectra`(self, map_, ...)	Compute pseudo-spectra from a set of (MS2) masstraces
`endProgress`(self)	Ends the progress display
`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)

createPseudoSpectra(self, map_: ConsensusMap, pseudo_spectra: MSExperiment, min_peak_nr: int, min_correlation: float, max_lag: int, max_rt_apex_difference: float) → None#

Compute pseudo-spectra from a set of (MS2) masstraces

This function will take a set of masstraces (consensus map) as input and produce a vector of pseudo spectra as output (pseudo_spectra result vector).

It basically makes an all-vs-all comparison of all masstraces against each other and scores them on how similar they are in their mass traces.

This assumes that the consensus feature is only from one (SWATH) map This assumes that the consensus map is sorted by intensity

endProgress(self) → None#: Ends the progress display

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#