MassAnalyzer#

class pyopenms.MassAnalyzer#

Bases: object

Cython implementation of _MassAnalyzer

Original C++ documentation is available here

– Inherits from [‘MetaInfoInterface’]

__init__()#

Overload:

__init__(self) None

Overload:

__init__(self, in_0: MassAnalyzer) None

Methods

__init__

Overload:

clearMetaInfo(self)

Removes all meta values

getAccuracy(self)

Returns the mass accuracy i.e. how much the theoretical mass may differ from the measured mass (in ppm).

getFinalMSExponent(self)

Returns the final MS exponent

getIsolationWidth(self)

Returns the isolation width i.e. in which m/z range the precursor ion is selected for MS to the n (in m/z).

getKeys(self, keys)

Fills the given vector with a list of all keys for which a value is set

getMagneticFieldStrength(self)

Returns the strength of the magnetic field (in T)

getMetaValue(self, in_0)

Returns the value corresponding to a string, or

getOrder(self)

Returns the position of this part in the whole Instrument

getReflectronState(self)

Returns the reflectron state (for TOF)

getResolution(self)

Returns the resolution.

getResolutionMethod(self)

Returns the method used for determination of the resolution

getResolutionType(self)

Returns the resolution type

getScanDirection(self)

Returns the direction of scanning

getScanLaw(self)

Returns the scan law

getScanRate(self)

Returns the scan rate (in s)

getScanTime(self)

Returns the scan time for a single scan (in s)

getTOFTotalPathLength(self)

Returns the path length for a TOF mass analyzer (in meter)

getType(self)

Returns the analyzer type

isMetaEmpty(self)

Returns if the MetaInfo is empty

metaRegistry(self)

Returns a reference to the MetaInfoRegistry

metaValueExists(self, in_0)

Returns whether an entry with the given name exists

removeMetaValue(self, in_0)

Removes the DataValue corresponding to name if it exists

setAccuracy(self, accuracy)

Sets the accuracy i.e. how much the theoretical mass may differ from the measured mass (in ppm).

setFinalMSExponent(self, final_MS_exponent)

Sets the final MS exponent

setIsolationWidth(self, isolation_width)

Sets the isolation width i.e. in which m/z range the precursor ion is selected for MS to the n (in m/z).

setMagneticFieldStrength(self, ...)

Sets the strength of the magnetic field (in T)

setMetaValue(self, in_0, in_1)

Sets the DataValue corresponding to a name

setOrder(self, order)

Sets the order

setReflectronState(self, reflecton_state)

Sets the reflectron state (for TOF)

setResolution(self, resolution)

Sets the resolution

setResolutionMethod(self, resolution_method)

Sets the method used for determination of the resolution

setResolutionType(self, resolution_type)

Sets the resolution type

setScanDirection(self, scan_direction)

Sets the direction of scanning

setScanLaw(self, scan_law)

Sets the scan law

setScanRate(self, scan_rate)

Sets the scan rate (in s)

setScanTime(self, scan_time)

Sets the scan time for a single scan (in s)

setTOFTotalPathLength(self, ...)

Sets the path length for a TOF mass analyzer (in meter)

setType(self, type)

Sets the analyzer type

AnalyzerType#

alias of __AnalyzerType

ReflectronState#

alias of __ReflectronState

ResolutionMethod#

alias of __ResolutionMethod

ResolutionType#

alias of __ResolutionType

ScanDirection#

alias of __ScanDirection

ScanLaw#

alias of __ScanLaw

clearMetaInfo(self) None#

Removes all meta values

getAccuracy(self) float#

Returns the mass accuracy i.e. how much the theoretical mass may differ from the measured mass (in ppm)

getFinalMSExponent(self) int#

Returns the final MS exponent

getIsolationWidth(self) float#

Returns the isolation width i.e. in which m/z range the precursor ion is selected for MS to the n (in m/z)

getKeys(self, keys: List[bytes]) None#

Fills the given vector with a list of all keys for which a value is set

getMagneticFieldStrength(self) float#

Returns the strength of the magnetic field (in T)

getMetaValue(self, in_0: bytes | str | String) int | float | bytes | str | List[int] | List[float] | List[bytes]#

Returns the value corresponding to a string, or

getOrder(self) int#

Returns the position of this part in the whole Instrument

getReflectronState(self) int#

Returns the reflectron state (for TOF)

getResolution(self) float#

Returns the resolution. The maximum m/z value at which two peaks can be resolved, according to one of the standard measures

getResolutionMethod(self) int#

Returns the method used for determination of the resolution

getResolutionType(self) int#

Returns the resolution type

getScanDirection(self) int#

Returns the direction of scanning

getScanLaw(self) int#

Returns the scan law

getScanRate(self) float#

Returns the scan rate (in s)

getScanTime(self) float#

Returns the scan time for a single scan (in s)

getTOFTotalPathLength(self) float#

Returns the path length for a TOF mass analyzer (in meter)

getType(self) int#

Returns the analyzer type

isMetaEmpty(self) bool#

Returns if the MetaInfo is empty

metaRegistry(self) MetaInfoRegistry#

Returns a reference to the MetaInfoRegistry

metaValueExists(self, in_0: bytes | str | String) bool#

Returns whether an entry with the given name exists

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

Removes the DataValue corresponding to name if it exists

setAccuracy(self, accuracy: float) None#

Sets the accuracy i.e. how much the theoretical mass may differ from the measured mass (in ppm)

setFinalMSExponent(self, final_MS_exponent: int) None#

Sets the final MS exponent

setIsolationWidth(self, isolation_width: float) None#

Sets the isolation width i.e. in which m/z range the precursor ion is selected for MS to the n (in m/z)

setMagneticFieldStrength(self, magnetic_field_strength: float) None#

Sets the strength of the magnetic field (in T)

setMetaValue(self, in_0: bytes | str | String, in_1: int | float | bytes | str | List[int] | List[float] | List[bytes]) None#

Sets the DataValue corresponding to a name

setOrder(self, order: int) None#

Sets the order

setReflectronState(self, reflecton_state: int) None#

Sets the reflectron state (for TOF)

setResolution(self, resolution: float) None#

Sets the resolution

setResolutionMethod(self, resolution_method: int) None#

Sets the method used for determination of the resolution

setResolutionType(self, resolution_type: int) None#

Sets the resolution type

setScanDirection(self, scan_direction: int) None#

Sets the direction of scanning

setScanLaw(self, scan_law: int) None#

Sets the scan law

setScanRate(self, scan_rate: float) None#

Sets the scan rate (in s)

setScanTime(self, scan_time: float) None#

Sets the scan time for a single scan (in s)

setTOFTotalPathLength(self, TOF_total_path_length: float) None#

Sets the path length for a TOF mass analyzer (in meter)

setType(self, type: int) None#

Sets the analyzer type