Instrument#

class pyopenms.Instrument#

Bases: object

Cython implementation of _Instrument

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

__init__()#

Overload:

__init__(self) → None

Description of a MS instrument

Overload:

__init__(self, in_0: Instrument) → None

Methods

`__init__`	Overload:
`clearMetaInfo`(self)	Removes all meta values
`getCustomizations`(self)	Returns a description of customizations
`getIonDetectors`(self)	Returns the ion detector list
`getIonOptics`(self)	Returns the ion optics type
`getIonSources`(self)	Returns the ion source list
`getKeys`(self, keys)	Fills the given vector with a list of all keys for which a value is set
`getMassAnalyzers`(self)	Returns the mass analyzer list
`getMetaValue`(self, in_0)	Returns the value corresponding to a string, or
`getModel`(self)	Returns the instrument model
`getName`(self)	Returns the name of the instrument
`getSoftware`(self)	Returns the instrument software
`getVendor`(self)	Returns the instrument vendor
`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
`setCustomizations`(self, customizations)	Sets the a description of customizations
`setIonDetectors`(self, ion_detectors)	Sets the ion detector list
`setIonOptics`(self, ion_optics)	Sets the ion optics type
`setIonSources`(self, ion_sources)	Sets the ion source list
`setMassAnalyzers`(self, mass_analyzers)	Sets the mass analyzer list
`setMetaValue`(self, in_0, in_1)	Sets the DataValue corresponding to a name
`setModel`(self, model)	Sets the instrument model
`setName`(self, name)	Sets the name of the instrument
`setSoftware`(self, software)	Sets the instrument software
`setVendor`(self, vendor)	Sets the instrument vendor

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

getCustomizations(self) → bytes | str | String#: Returns a description of customizations

getIonDetectors(self) → List[IonDetector]#: Returns the ion detector list

getIonOptics(self) → int#: Returns the ion optics type

getIonSources(self) → List[IonSource]#: Returns the ion source list

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

getMassAnalyzers(self) → List[MassAnalyzer]#: Returns the mass analyzer list

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

getModel(self) → bytes | str | String#: Returns the instrument model

getName(self) → bytes | str | String#: Returns the name of the instrument

getSoftware(self) → Software#: Returns the instrument software

getVendor(self) → bytes | str | String#: Returns the instrument vendor

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

setCustomizations(self, customizations: bytes | str | String) → None#: Sets the a description of customizations

setIonDetectors(self, ion_detectors: List[IonDetector]) → None#: Sets the ion detector list

setIonOptics(self, ion_optics: int) → None#: Sets the ion optics type

setIonSources(self, ion_sources: List[IonSource]) → None#: Sets the ion source list

setMassAnalyzers(self, mass_analyzers: List[MassAnalyzer]) → None#: Sets the mass analyzer list

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

setModel(self, model: bytes | str | String) → None#: Sets the instrument model

setName(self, name: bytes | str | String) → None#: Sets the name of the instrument

setSoftware(self, software: Software) → None#: Sets the instrument software

setVendor(self, vendor: bytes | str | String) → None#: Sets the instrument vendor