InstrumentSettings#

class pyopenms.InstrumentSettings#

Bases: object

Cython implementation of _InstrumentSettings

Documentation is available at http://www.openms.de/current_doxygen/html/classOpenMS_1_1InstrumentSettings.html: – Inherits from [‘MetaInfoInterface’]

__init__()#

Cython signature: void InstrumentSettings() Description of the settings a MS Instrument was run with
Cython signature: void InstrumentSettings(InstrumentSettings &)

Methods

`__init__`	Cython signature: void InstrumentSettings()
`clearMetaInfo`	Cython signature: void clearMetaInfo() Removes all meta values
`getKeys`	Cython signature: void getKeys(libcpp_vector[String] & keys) Fills the given vector with a list of all keys for which a value is set
`getMetaValue`	Cython signature: DataValue getMetaValue(String) Returns the value corresponding to a string, or
`getPolarity`	Cython signature: Polarity getPolarity() Returns the polarity
`getScanMode`	Cython signature: ScanMode getScanMode() Returns the scan mode
`getScanWindows`	Cython signature: libcpp_vector[ScanWindow] getScanWindows() Returns the m/z scan windows
`getZoomScan`	Cython signature: bool getZoomScan() Returns if this scan is a zoom (enhanced resolution) scan
`isMetaEmpty`	Cython signature: bool isMetaEmpty() Returns if the MetaInfo is empty
`metaRegistry`	Cython signature: MetaInfoRegistry metaRegistry() Returns a reference to the MetaInfoRegistry
`metaValueExists`	Cython signature: bool metaValueExists(String) Returns whether an entry with the given name exists
`removeMetaValue`	Cython signature: void removeMetaValue(String) Removes the DataValue corresponding to name if it exists
`setMetaValue`	Cython signature: void setMetaValue(String, DataValue) Sets the DataValue corresponding to a name
`setPolarity`	Cython signature: void setPolarity(Polarity) Sets the polarity
`setScanMode`	Cython signature: void setScanMode(ScanMode scan_mode) Sets the scan mode
`setScanWindows`	Cython signature: void setScanWindows(libcpp_vector[ScanWindow] scan_windows) Sets the m/z scan windows
`setZoomScan`	Cython signature: void setZoomScan(bool zoom_scan) Sets if this scan is a zoom (enhanced resolution) scan

clearMetaInfo()#: Cython signature: void clearMetaInfo() Removes all meta values

getKeys()#: Cython signature: void getKeys(libcpp_vector[String] & keys) Fills the given vector with a list of all keys for which a value is set

getMetaValue()#: Cython signature: DataValue getMetaValue(String) Returns the value corresponding to a string, or

getPolarity()#: Cython signature: Polarity getPolarity() Returns the polarity

getScanMode()#: Cython signature: ScanMode getScanMode() Returns the scan mode

getScanWindows()#: Cython signature: libcpp_vector[ScanWindow] getScanWindows() Returns the m/z scan windows

getZoomScan()#: Cython signature: bool getZoomScan() Returns if this scan is a zoom (enhanced resolution) scan

isMetaEmpty()#: Cython signature: bool isMetaEmpty() Returns if the MetaInfo is empty

metaRegistry()#: Cython signature: MetaInfoRegistry metaRegistry() Returns a reference to the MetaInfoRegistry

metaValueExists()#: Cython signature: bool metaValueExists(String) Returns whether an entry with the given name exists

removeMetaValue()#: Cython signature: void removeMetaValue(String) Removes the DataValue corresponding to name if it exists

setMetaValue()#: Cython signature: void setMetaValue(String, DataValue) Sets the DataValue corresponding to a name

setPolarity()#: Cython signature: void setPolarity(Polarity) Sets the polarity

setScanMode()#: Cython signature: void setScanMode(ScanMode scan_mode) Sets the scan mode

setScanWindows()#: Cython signature: void setScanWindows(libcpp_vector[ScanWindow] scan_windows) Sets the m/z scan windows

setZoomScan()#: Cython signature: void setZoomScan(bool zoom_scan) Sets if this scan is a zoom (enhanced resolution) scan