Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Types | Public Member Functions | Static Public Attributes | Protected Attributes

IonDetector Class Reference
[Metadata]

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

#include <OpenMS/METADATA/IonDetector.h>

Inheritance diagram for IonDetector:
MetaInfoInterface

List of all members.

Public Types

enum  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  AcquisitionMode {
  ACQMODENULL, PULSECOUNTING, ADC, TDC,
  TRANSIENTRECORDER, SIZE_OF_ACQUISITIONMODE
}
 

Acquisition mode.

More...

Public Member Functions

 IonDetector ()
 Constructor.
 IonDetector (const IonDetector &source)
 Copy constructor.
 ~IonDetector ()
 Destructor.
IonDetector & operator= (const IonDetector &source)
 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
DoubleReal getResolution () const
 returns the resolution (in ns)
void setResolution (DoubleReal resolution)
 sets the resolution (in ns)
DoubleReal getADCSamplingFrequency () const
 retruns the analog-to-digital converter sampling frequency (in Hz)
void setADCSamplingFrequency (DoubleReal 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

Static Public Attributes

static const std::string NamesOfType [SIZE_OF_TYPE]
 Names of detector types.
static const std::string NamesOfAcquisitionMode [SIZE_OF_ACQUISITIONMODE]
 Names of acquisition modes.

Protected Attributes

Type type_
AcquisitionMode acquisition_mode_
DoubleReal resolution_
DoubleReal ADC_sampling_frequency_
Int order_

Detailed Description

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

Member Enumeration Documentation

enum AcquisitionMode

Acquisition mode.

Enumerator:
ACQMODENULL 

Unknown.

PULSECOUNTING 

Pulse counting.

ADC 

Analog-digital converter.

TDC 

Time-digital converter.

TRANSIENTRECORDER 

Transient recorder.

SIZE_OF_ACQUISITIONMODE 
enum Type

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 (  ) 

Constructor.

IonDetector ( const IonDetector &  source  ) 

Copy constructor.

~IonDetector (  ) 

Destructor.

Member Function Documentation

AcquisitionMode getAcquisitionMode (  )  const

returns the acquisition mode

DoubleReal getADCSamplingFrequency (  )  const

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

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 instuments, the order should be defined.

DoubleReal getResolution (  )  const

returns the resolution (in ns)

Type getType (  )  const

returns the detector type

bool operator!= ( const IonDetector &  rhs  )  const

Equality operator.

IonDetector& operator= ( const IonDetector &  source  ) 

Assignment operator.

bool operator== ( const IonDetector &  rhs  )  const

Equality operator.

void setAcquisitionMode ( AcquisitionMode  acquisition_mode  ) 

sets the acquisition mode

Referenced by DBAdapter::loadExperiment().

void setADCSamplingFrequency ( DoubleReal  ADC_sampling_frequency  ) 

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

Referenced by DBAdapter::loadExperiment().

void setOrder ( Int  order  ) 

sets the order

Referenced by DBAdapter::loadExperiment().

void setResolution ( DoubleReal  resolution  ) 

sets the resolution (in ns)

Referenced by DBAdapter::loadExperiment().

void setType ( Type  type  ) 

sets the detector type

Referenced by DBAdapter::loadExperiment().

Member Data Documentation

AcquisitionMode acquisition_mode_ [protected]
DoubleReal ADC_sampling_frequency_ [protected]
const std::string NamesOfAcquisitionMode[SIZE_OF_ACQUISITIONMODE] [static]

Names of acquisition modes.

const std::string NamesOfType[SIZE_OF_TYPE] [static]

Names of detector types.

Int order_ [protected]
DoubleReal resolution_ [protected]
Type type_ [protected]
OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:56 using doxygen 1.7.1