InstrumentSettings#

class pyopenms.InstrumentSettings#

Bases: object

Cython implementation of _InstrumentSettings

Original C++ documentation is available here: – Inherits from [‘MetaInfoInterface’]

__init__()#

Overload:

__init__(self) → None

Description of the settings a MS Instrument was run with

Overload:

__init__(self, in_0: InstrumentSettings) → None

Methods

`__init__`	Overload:
`clearMetaInfo`(self)	Removes all meta values
`getKeys`(self, keys)	Fills the given vector with a list of all keys for which a value is set
`getMetaValue`(self, in_0)	Returns the value corresponding to a string, or
`getPolarity`(self)	Returns the polarity
`getScanMode`(self)	Returns the scan mode
`getScanWindows`(self)	Returns the m/z scan windows
`getZoomScan`(self)	Returns if this scan is a zoom (enhanced resolution) scan
`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
`setMetaValue`(self, in_0, in_1)	Sets the DataValue corresponding to a name
`setPolarity`(self, in_0)	Sets the polarity
`setScanMode`(self, scan_mode)	Sets the scan mode
`setScanWindows`(self, scan_windows)	Sets the m/z scan windows
`setZoomScan`(self, zoom_scan)	Sets if this scan is a zoom (enhanced resolution) scan

clearMetaInfo(self) → None#: Removes all meta values

getKeys(self, keys: List[bytes]) → None#: Fills the given vector with a list of all keys for which a value is set

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

getPolarity(self) → int#: Returns the polarity

getScanMode(self) → int#: Returns the scan mode

getScanWindows(self) → List[ScanWindow]#: Returns the m/z scan windows

getZoomScan(self) → bool#: Returns if this scan is a zoom (enhanced resolution) scan

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

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

setPolarity(self, in_0: int) → None#: Sets the polarity

setScanMode(self, scan_mode: int) → None#: Sets the scan mode

setScanWindows(self, scan_windows: List[ScanWindow]) → None#: Sets the m/z scan windows

setZoomScan(self, zoom_scan: bool) → None#: Sets if this scan is a zoom (enhanced resolution) scan