IonSource

class pyopenms.IonSource

Bases: object

Cython implementation of _IonSource

Documentation is available at http://www.openms.de/current_doxygen/html/classOpenMS_1_1IonSource.html

– Inherits from [‘MetaInfoInterface’]

__init__()
  • Cython signature: void IonSource() Description of an ion source (part of a MS Instrument)

  • Cython signature: void IonSource(IonSource &)

Methods

__init__

  • Cython signature: void IonSource()

clearMetaInfo

Cython signature: void clearMetaInfo() Removes all meta values

getInletType

Cython signature: InletType getInletType() Returns the inlet type

getIonizationMethod

Cython signature: IonizationMethod getIonizationMethod() Returns the ionization method

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

getOrder

Cython signature: int getOrder()

getPolarity

Cython signature: Polarity getPolarity() Returns the ionization mode

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

setInletType

Cython signature: void setInletType(InletType inlet_type) Sets the inlet type

setIonizationMethod

Cython signature: void setIonizationMethod(IonizationMethod ionization_type) Sets the ionization method

setMetaValue

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

setOrder

Cython signature: void setOrder(int order) Sets the order

setPolarity

Cython signature: void setPolarity(Polarity polarity) Sets the ionization mode

InletType

alias of pyopenms.pyopenms_8.__InletType

IonizationMethod

alias of pyopenms.pyopenms_8.__IonizationMethod

Polarity

alias of pyopenms.pyopenms_8.__Polarity

clearMetaInfo()

Cython signature: void clearMetaInfo() Removes all meta values

getInletType()

Cython signature: InletType getInletType() Returns the inlet type

getIonizationMethod()

Cython signature: IonizationMethod getIonizationMethod() Returns the ionization method

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

getOrder()

Cython signature: int getOrder()

Order can be ignored, as long the instrument has this default setup:
  • one ion source

  • one or many mass analyzers

  • one ion detector

For more complex instruments, the order should be defined.

getPolarity()

Cython signature: Polarity getPolarity() Returns the ionization mode

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

setInletType()

Cython signature: void setInletType(InletType inlet_type) Sets the inlet type

setIonizationMethod()

Cython signature: void setIonizationMethod(IonizationMethod ionization_type) Sets the ionization method

setMetaValue()

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

setOrder()

Cython signature: void setOrder(int order) Sets the order

setPolarity()

Cython signature: void setPolarity(Polarity polarity) Sets the ionization mode