IonSource

class pyopenms.IonSource

Bases: object

Cython implementation of _IonSource

Original C++ documentation is available here

– Inherits from [‘MetaInfoInterface’]

__init__()

Overload:

__init__(self) → None

Description of an ion source (part of a MS Instrument)

Overload:

__init__(self, in_0: IonSource) → None

Methods

__init__	Overload:
clearMetaInfo(self)	Removes all meta values
getInletType(self)	Returns the inlet type
getIonizationMethod(self)	Returns the ionization method
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
getOrder(self)	Returns the position of this part in the whole Instrument
getPolarity(self)	Returns the ionization mode
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
setInletType(self, inlet_type)	Sets the inlet type
setIonizationMethod(self, ionization_type)	Sets the ionization method
setMetaValue(self, in_0, in_1)	Sets the DataValue corresponding to a name
setOrder(self, order)	Sets the order
setPolarity(self, polarity)	Sets the ionization mode

InletType

alias of __InletType

IonizationMethod

alias of __IonizationMethod

Polarity

alias of __Polarity

clearMetaInfo(self) → None

Removes all meta values

getInletType(self) → int

Returns the inlet type

getIonizationMethod(self) → int

Returns the ionization method

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

getOrder(self) → int

Returns the position of this part in the whole Instrument

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(self) → int

Returns the ionization mode

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

setInletType(self, inlet_type: int) → None

Sets the inlet type

setIonizationMethod(self, ionization_type: int) → None

Sets the ionization method

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

setOrder(self, order: int) → None

Sets the order

setPolarity(self, polarity: int) → None

Sets the ionization mode