IonDetector Class Reference

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

#include <OpenMS/METADATA/IonDetector.h>

Inheritance diagram for IonDetector:

Collaboration diagram for IonDetector:

Public Types
enum class	Type {   TYPENULL , ELECTRONMULTIPLIER , PHOTOMULTIPLIER , FOCALPLANEARRAY ,   FARADAYCUP , CONVERSIONDYNODEELECTRONMULTIPLIER , CONVERSIONDYNODEPHOTOMULTIPLIER , MULTICOLLECTOR ,   CHANNELELECTRONMULTIPLIER , CHANNELTRON , DALYDETECTOR , MICROCHANNELPLATEDETECTOR ,   ARRAYDETECTOR , CONVERSIONDYNODE , DYNODE , FOCALPLANECOLLECTOR ,   IONTOPHOTONDETECTOR , POINTCOLLECTOR , POSTACCELERATIONDETECTOR , PHOTODIODEARRAYDETECTOR ,   INDUCTIVEDETECTOR , ELECTRONMULTIPLIERTUBE , SIZE_OF_TYPE }
	Detector type. More...
enum class	AcquisitionMode {   ACQMODENULL , PULSECOUNTING , ADC , TDC ,   TRANSIENTRECORDER , SIZE_OF_ACQUISITIONMODE }
	Acquisition mode. More...

Public Member Functions
	IonDetector ()
	Constructor.
	IonDetector (const IonDetector &)=default
	Copy constructor.
	IonDetector (IonDetector &&)=default
	Move constructor.
	~IonDetector ()
	Destructor.
IonDetector &	operator= (const IonDetector &)=default
	Assignment operator.
IonDetector &	operator= (IonDetector &&) &=default
	Move assignment operator.
bool	operator== (const IonDetector &rhs) const
	Equality operator.
bool	operator!= (const IonDetector &rhs) const
	Equality operator.
Type	getType () const
	returns the detector type
void	setType (Type type)
	sets the detector type
AcquisitionMode	getAcquisitionMode () const
	returns the acquisition mode
void	setAcquisitionMode (AcquisitionMode acquisition_mode)
	sets the acquisition mode
double	getResolution () const
	returns the resolution (in ns)
void	setResolution (double resolution)
	sets the resolution (in ns)
double	getADCSamplingFrequency () const
	returns the analog-to-digital converter sampling frequency (in Hz)
void	setADCSamplingFrequency (double ADC_sampling_frequency)
	sets the analog-to-digital converter sampling frequency (in Hz)
Int	getOrder () const
	returns the position of this part in the whole Instrument.
void	setOrder (Int order)
	sets the order
Public Member Functions inherited from MetaInfoInterface
	MetaInfoInterface ()=default
	Constructor.
	MetaInfoInterface (const MetaInfoInterface &rhs)
	Copy constructor.
	MetaInfoInterface (MetaInfoInterface &&) noexcept
	Move constructor.
	~MetaInfoInterface ()
	Destructor.
MetaInfoInterface &	operator= (const MetaInfoInterface &rhs)
	Assignment operator.
MetaInfoInterface &	operator= (MetaInfoInterface &&) noexcept
	Move assignment operator.
void	swap (MetaInfoInterface &rhs)
	Swap contents.
bool	operator== (const MetaInfoInterface &rhs) const
	Equality operator.
bool	operator!= (const MetaInfoInterface &rhs) const
	Equality operator.
const DataValue &	getMetaValue (const String &name) const
	Returns the value corresponding to a string, or DataValue::EMPTY if not found.
DataValue	getMetaValue (const String &name, const DataValue &default_value) const
	Returns the value corresponding to a string, or a default value (e.g.: DataValue::EMPTY) if not found
const DataValue &	getMetaValue (UInt index) const
	Returns the value corresponding to the index, or DataValue::EMPTY if not found.
DataValue	getMetaValue (UInt index, const DataValue &default_value) const
	Returns the value corresponding to the index, or a default value (e.g.: DataValue::EMPTY) if not found
bool	metaValueExists (const String &name) const
	Returns whether an entry with the given name exists.
bool	metaValueExists (UInt index) const
	Returns whether an entry with the given index exists.
void	setMetaValue (const String &name, const DataValue &value)
	Sets the DataValue corresponding to a name.
void	setMetaValue (UInt index, const DataValue &value)
	Sets the DataValue corresponding to an index.
void	removeMetaValue (const String &name)
	Removes the DataValue corresponding to name if it exists.
void	removeMetaValue (UInt index)
	Removes the DataValue corresponding to index if it exists.
void	addMetaValues (const MetaInfoInterface &from)
void	getKeys (std::vector< String > &keys) const
	Fills the given vector with a list of all keys for which a value is set.
void	getKeys (std::vector< UInt > &keys) const
	Fills the given vector with a list of all keys for which a value is set.
bool	isMetaEmpty () const
	Returns if the MetaInfo is empty.
void	clearMetaInfo ()
	Removes all meta values.

Static Public Member Functions
static StringList	getAllNamesOfType ()
	Returns all detector type names known to OpenMS.
static StringList	getAllNamesOfAcquisitionMode ()
	Returns all acquisition mode names known to OpenMS.
static const std::string &	typeToString (Type type)
	Convert a Type enum to its string representation.
static Type	toType (const std::string &name)
	Convert a string to a Type enum.
static const std::string &	acquisitionModeToString (AcquisitionMode mode)
	Convert an AcquisitionMode enum to its string representation.
static AcquisitionMode	toAcquisitionMode (const std::string &name)
	Convert a string to an AcquisitionMode enum.
Static Public Member Functions inherited from MetaInfoInterface
static MetaInfoRegistry &	metaRegistry ()
	Returns a reference to the MetaInfoRegistry.

Static Public Attributes
static const std::string	NamesOfType [static_cast< size_t >(Type::SIZE_OF_TYPE)]
	Names of detector types.
static const std::string	NamesOfAcquisitionMode [static_cast< size_t >(AcquisitionMode::SIZE_OF_ACQUISITIONMODE)]
	Names of acquisition modes.

Protected Attributes
Type	type_
AcquisitionMode	acquisition_mode_
double	resolution_
double	ADC_sampling_frequency_
Int	order_
Protected Attributes inherited from MetaInfoInterface
MetaInfo *	meta_ = nullptr
	Pointer to the MetaInfo object.

Additional Inherited Members
Protected Member Functions inherited from MetaInfoInterface
void	createIfNotExists_ ()
	Creates the MetaInfo object if it does not exist.

Detailed Description

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

Member Enumeration Documentation

AcquisitionMode

enum class AcquisitionMode

strong

Acquisition mode.

Enumerator
ACQMODENULL	Unknown.
PULSECOUNTING	Pulse counting.
ADC	Analog-digital converter.
TDC	Time-digital converter.
TRANSIENTRECORDER	Transient recorder.
SIZE_OF_ACQUISITIONMODE

Type

enum class Type

strong

Detector type.

Enumerator
TYPENULL	Unknown.
ELECTRONMULTIPLIER	Electron multiplier.
PHOTOMULTIPLIER	Photo multiplier.
FOCALPLANEARRAY	Focal plane array.
FARADAYCUP	Faraday cup.
CONVERSIONDYNODEELECTRONMULTIPLIER	Conversion dynode electron multiplier.
CONVERSIONDYNODEPHOTOMULTIPLIER	Conversion dynode photo multiplier.
MULTICOLLECTOR	Multi-collector.
CHANNELELECTRONMULTIPLIER	Channel electron multiplier.
CHANNELTRON	channeltron
DALYDETECTOR	daly detector
MICROCHANNELPLATEDETECTOR	microchannel plate detector
ARRAYDETECTOR	array detector
CONVERSIONDYNODE	conversion dynode
DYNODE	dynode
FOCALPLANECOLLECTOR	focal plane collector
IONTOPHOTONDETECTOR	ion-to-photon detector
POINTCOLLECTOR	point collector
POSTACCELERATIONDETECTOR	postacceleration detector
PHOTODIODEARRAYDETECTOR	photodiode array detector
INDUCTIVEDETECTOR	inductive detector
ELECTRONMULTIPLIERTUBE	electron multiplier tube
SIZE_OF_TYPE

Constructor & Destructor Documentation

IonDetector() [1/3]

IonDetector

(

)

Constructor.

IonDetector() [2/3]

IonDetector ( const IonDetector &  )

default

Copy constructor.

IonDetector() [3/3]

IonDetector ( IonDetector &&  )

default

Move constructor.

~IonDetector()

~IonDetector

(

)

Destructor.

Member Function Documentation

acquisitionModeToString()

static const std::string & acquisitionModeToString ( AcquisitionMode  mode )

static

Convert an AcquisitionMode enum to its string representation.

Parameters

mode	The acquisition mode enum value to convert

Returns

Reference to the string representation

Exceptions

Exception::InvalidValue

if mode is SIZE_OF_ACQUISITIONMODE

getAcquisitionMode()

AcquisitionMode getAcquisitionMode

(

)

const

returns the acquisition mode

getADCSamplingFrequency()

double getADCSamplingFrequency

(

)

const

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

getAllNamesOfAcquisitionMode()

static StringList getAllNamesOfAcquisitionMode ( )

static

Returns all acquisition mode names known to OpenMS.

Returns

List of all acquisition mode names

getAllNamesOfType()

static StringList getAllNamesOfType ( )

static

Returns all detector type names known to OpenMS.

Returns

List of all detector type names

getOrder()

Int getOrder

(

)

const

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.

getResolution()

double getResolution

(

)

const

returns the resolution (in ns)

getType()

Type getType

(

)

const

returns the detector type

operator!=()

bool operator!=

(

const IonDetector &

rhs

)

const

Equality operator.

operator=() [1/2]

IonDetector & operator= ( const IonDetector &  )

default

Assignment operator.

operator=() [2/2]

IonDetector & operator= ( IonDetector &&  ) &

default

Move assignment operator.

operator==()

bool operator==

(

const IonDetector &

rhs

)

const

Equality operator.

setAcquisitionMode()

void setAcquisitionMode

(

AcquisitionMode

acquisition_mode

)

sets the acquisition mode

setADCSamplingFrequency()

void setADCSamplingFrequency

(

double

ADC_sampling_frequency

)

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

setOrder()

void setOrder

(

Int

order

)

sets the order

setResolution()

void setResolution

(

double

resolution

)

sets the resolution (in ns)

setType()

void setType

(

Type

type

)

sets the detector type

toAcquisitionMode()

static AcquisitionMode toAcquisitionMode ( const std::string &  name )

static

Convert a string to an AcquisitionMode enum.

Parameters

name	The string name to convert

Returns

The corresponding AcquisitionMode enum value

Exceptions

Exception::InvalidValue

if name is not found in NamesOfAcquisitionMode[]

toType()

static Type toType ( const std::string &  name )

static

Convert a string to a Type enum.

Parameters

name	The string name to convert

Returns

The corresponding Type enum value

Exceptions

Exception::InvalidValue

if name is not found in NamesOfType[]

typeToString()

static const std::string & typeToString ( Type  type )

static

Convert a Type enum to its string representation.

Parameters

type	The detector type enum value to convert

Returns

Reference to the string representation

Exceptions

Exception::InvalidValue

if type is SIZE_OF_TYPE

Member Data Documentation

acquisition_mode_

AcquisitionMode acquisition_mode_

protected

ADC_sampling_frequency_

double ADC_sampling_frequency_

protected

NamesOfAcquisitionMode

const std::string NamesOfAcquisitionMode[static_cast< size_t >(AcquisitionMode::SIZE_OF_ACQUISITIONMODE)]

static

Names of acquisition modes.

NamesOfType

const std::string NamesOfType[static_cast< size_t >(Type::SIZE_OF_TYPE)]

static

Names of detector types.

order_

Int order_

protected

resolution_

double resolution_

protected

type_

Type type_

protected