MassTraceDetection

class pyopenms.MassTraceDetection

Bases: DefaultParamHandler

A mass trace extraction method that gathers peaks similar in m/z and moving along retention time

__init__() → None

__init__(arg: pyopenms.MassTraceDetection, /) → None

Methods

__init__()
endProgress([bytes_processed])	Ends the progress display
getDefaults()	Returns the default parameters
getLogType()	Returns the type of progress log being used
getName()	Returns the name
getParameters()	Returns the parameters
getSubsections()
nextProgress()	Increment progress by 1 (according to range begin-end)
run(input[, max_traces])	Main method of MassTraceDetection.
setLogType(type)	Sets the progress log that should be used.
setName(name)	Sets the name
setParameters(param)	Sets the parameters
setProgress(value)	Sets the current progress
startProgress(begin, end, label)

endProgress(bytes_processed: int = 0) → None

Ends the progress display

getDefaults() → pyopenms.Param

Returns the default parameters

getLogType() → pyopenms.ProgressLogger.LogType

Returns the type of progress log being used

getName() → str

Returns the name

getParameters() → pyopenms.Param

Returns the parameters

getSubsections() → list[str]

nextProgress() → None

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

run(input: pyopenms.MSExperiment, max_traces: int = 0) → list[pyopenms.MassTrace]

Main method of MassTraceDetection. Extracts mass traces of a MSExperiment.

Parameters:

• input – MSExperiment (PeakMap) holding the raw data

• max_traces – Maximum number of mass traces to extract (0 = no limit)

Returns:

List of found MassTrace objects

setLogType(type: pyopenms.ProgressLogger.LogType) → None

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

setName(name: str) → None

Sets the name

setParameters(param: pyopenms.Param) → None

Sets the parameters

setProgress(value: int) → None

Sets the current progress

startProgress(begin: int, end: int, label: str) → None