IonDetector#

class pyopenms.IonDetector#

Bases: object

Cython implementation of _IonDetector

Original C++ documentation is available here

– Inherits from [‘MetaInfoInterface’]

__init__()#

Overload:

__init__(self) None

Description of a ion detector (part of a MS Instrument)

Overload:

__init__(self, in_0: IonDetector) None

Methods

__init__

Overload:

clearMetaInfo(self)

Removes all meta values

getADCSamplingFrequency(self)

Returns the analog-to-digital converter sampling frequency (in Hz)

getAcquisitionMode(self)

Returns the acquisition mode

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 order

getResolution(self)

Returns the resolution (in ns)

getType(self)

Returns the detector type

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

setADCSamplingFrequency(self, ...)

Sets the analog-to-digital converter sampling frequency (in Hz)

setAcquisitionMode(self, acquisition_mode)

Sets the acquisition mode

setMetaValue(self, in_0, in_1)

Sets the DataValue corresponding to a name

setOrder(self, order)

Sets the order

setResolution(self, resolution)

Sets the resolution (in ns)

setType(self, type_)

Sets the detector type

AcquisitionMode#

alias of __AcquisitionMode

Type_IonDetector#

alias of __Type_IonDetector

clearMetaInfo(self) None#

Removes all meta values

getADCSamplingFrequency(self) float#

Returns the analog-to-digital converter sampling frequency (in Hz)

getAcquisitionMode(self) int#

Returns the acquisition mode

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 order

getResolution(self) float#

Returns the resolution (in ns)

getType(self) int#

Returns the detector type

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

setADCSamplingFrequency(self, ADC_sampling_frequency: float) None#

Sets the analog-to-digital converter sampling frequency (in Hz)

setAcquisitionMode(self, acquisition_mode: int) None#

Sets the acquisition mode

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

setResolution(self, resolution: float) None#

Sets the resolution (in ns)

setType(self, type_: int) None#

Sets the detector type