TOFCalibration

class pyopenms.TOFCalibration

Bases: object

Cython implementation of _TOFCalibration

Original C++ documentation is available here

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

__init__()

Overload:

__init__(self) → None

Overload:

__init__(self, in_0: TOFCalibration) → None

Methods

__init__	Overload:
calibrate(self, input, output, exp_masses)
endProgress(self)	Ends the progress display
getDefaults(self)	Returns the default parameters
getLogType(self)	Returns the type of progress log being used
getML1s(self)	Returns the first calibration constant
getML2s(self)
getML3s(self)
getName(self)	Returns the name
getParameters(self)	Returns the parameters
getSubsections(self)
nextProgress(self)	Increment progress by 1 (according to range begin-end)
pickAndCalibrate(self, input, output, exp_masses)
setLogType(self, in_0)	Sets the progress log that should be used.
setML1s(self, ml1s)
setML2s(self, ml2s)	Returns the second calibration constant
setML3s(self, ml3s)	Returns the third calibration constant
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)

calibrate(self, input: MSExperiment, output: MSExperiment, exp_masses: List[float]) → None

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

getML1s(self) → List[float]

Returns the first calibration constant

getML2s(self) → List[float]

getML3s(self) → List[float]

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)

pickAndCalibrate(self, input: MSExperiment, output: MSExperiment, exp_masses: List[float]) → None

setLogType(self, in_0: int) → None

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

setML1s(self, ml1s: List[float]) → None

setML2s(self, ml2s: List[float]) → None

Returns the second calibration constant

setML3s(self, ml3s: List[float]) → None

Returns the third calibration constant

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