Instrument#

class pyopenms.Instrument#

Bases: object

Cython implementation of _Instrument

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

__init__()#

Cython signature: void Instrument() Description of a MS instrument
Cython signature: void Instrument(Instrument &)

Methods

`__init__`	Cython signature: void Instrument()
`clearMetaInfo`	Cython signature: void clearMetaInfo() Removes all meta values
`getCustomizations`	Cython signature: String getCustomizations() Returns a description of customizations
`getIonDetectors`	Cython signature: libcpp_vector[IonDetector] getIonDetectors() Returns the ion detector list
`getIonOptics`	Cython signature: IonOpticsType getIonOptics() Returns the ion optics type
`getIonSources`	Cython signature: libcpp_vector[IonSource] getIonSources() Returns the ion source list
`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
`getMassAnalyzers`	Cython signature: libcpp_vector[MassAnalyzer] getMassAnalyzers() Returns the mass analyzer list
`getMetaValue`	Cython signature: DataValue getMetaValue(String) Returns the value corresponding to a string, or
`getModel`	Cython signature: String getModel() Returns the instrument model
`getName`	Cython signature: String getName() Returns the name of the instrument
`getSoftware`	Cython signature: Software getSoftware() Returns the instrument software
`getVendor`	Cython signature: String getVendor() Returns the instrument vendor
`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
`setCustomizations`	Cython signature: void setCustomizations(String customizations) Sets the a description of customizations
`setIonDetectors`	Cython signature: void setIonDetectors(libcpp_vector[IonDetector] ion_detectors) Sets the ion detector list
`setIonOptics`	Cython signature: void setIonOptics(IonOpticsType ion_optics) Sets the ion optics type
`setIonSources`	Cython signature: void setIonSources(libcpp_vector[IonSource] ion_sources) Sets the ion source list
`setMassAnalyzers`	Cython signature: void setMassAnalyzers(libcpp_vector[MassAnalyzer] mass_analyzers) Sets the mass analyzer list
`setMetaValue`	Cython signature: void setMetaValue(String, DataValue) Sets the DataValue corresponding to a name
`setModel`	Cython signature: void setModel(String model) Sets the instrument model
`setName`	Cython signature: void setName(String name) Sets the name of the instrument
`setSoftware`	Cython signature: void setSoftware(Software software) Sets the instrument software
`setVendor`	Cython signature: void setVendor(String vendor) Sets the instrument vendor

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

getCustomizations()#: Cython signature: String getCustomizations() Returns a description of customizations

getIonDetectors()#: Cython signature: libcpp_vector[IonDetector] getIonDetectors() Returns the ion detector list

getIonOptics()#: Cython signature: IonOpticsType getIonOptics() Returns the ion optics type

getIonSources()#: Cython signature: libcpp_vector[IonSource] getIonSources() Returns the ion source list

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

getMassAnalyzers()#: Cython signature: libcpp_vector[MassAnalyzer] getMassAnalyzers() Returns the mass analyzer list

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

getModel()#: Cython signature: String getModel() Returns the instrument model

getName()#: Cython signature: String getName() Returns the name of the instrument

getSoftware()#: Cython signature: Software getSoftware() Returns the instrument software

getVendor()#: Cython signature: String getVendor() Returns the instrument vendor

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

setCustomizations()#: Cython signature: void setCustomizations(String customizations) Sets the a description of customizations

setIonDetectors()#: Cython signature: void setIonDetectors(libcpp_vector[IonDetector] ion_detectors) Sets the ion detector list

setIonOptics()#: Cython signature: void setIonOptics(IonOpticsType ion_optics) Sets the ion optics type

setIonSources()#: Cython signature: void setIonSources(libcpp_vector[IonSource] ion_sources) Sets the ion source list

setMassAnalyzers()#: Cython signature: void setMassAnalyzers(libcpp_vector[MassAnalyzer] mass_analyzers) Sets the mass analyzer list

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

setModel()#: Cython signature: void setModel(String model) Sets the instrument model

setName()#: Cython signature: void setName(String name) Sets the name of the instrument

setSoftware()#: Cython signature: void setSoftware(Software software) Sets the instrument software

setVendor()#: Cython signature: void setVendor(String vendor) Sets the instrument vendor