OpenMS
IonDetector.h
Go to the documentation of this file.
1 // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
2 // SPDX-License-Identifier: BSD-3-Clause
3 //
4 // --------------------------------------------------------------------------
5 // $Maintainer: Timo Sachsenberg $
6 // $Authors: Marc Sturm $
7 // --------------------------------------------------------------------------
8 
9 #pragma once
10 
13 
14 namespace OpenMS
15 {
21  class OPENMS_DLLAPI IonDetector :
22  public MetaInfoInterface
23  {
24 public:
26  enum Type
27  {
50  SIZE_OF_TYPE
51  };
53  static const std::string NamesOfType[SIZE_OF_TYPE];
54 
57  {
60  ADC,
61  TDC,
63  SIZE_OF_ACQUISITIONMODE
64  };
66  static const std::string NamesOfAcquisitionMode[SIZE_OF_ACQUISITIONMODE];
67 
72 
76  IonDetector(const IonDetector &) = default;
78  IonDetector(IonDetector&&) = default;
81 
83  IonDetector & operator=(const IonDetector &) = default;
86 
88  bool operator==(const IonDetector & rhs) const;
90  bool operator!=(const IonDetector & rhs) const;
91 
93  Type getType() const;
95  void setType(Type type);
96 
100  void setAcquisitionMode(AcquisitionMode acquisition_mode);
101 
103  double getResolution() const;
105  void setResolution(double resolution);
106 
108  double getADCSamplingFrequency() const;
110  void setADCSamplingFrequency(double ADC_sampling_frequency);
111 
122  Int getOrder() const;
124  void setOrder(Int order);
125 
126 protected:
129  double resolution_;
132 
133  };
134 } // namespace OpenMS
135 
Description of a ion detector (part of a MS Instrument)
Definition: IonDetector.h:23
bool operator!=(const IonDetector &rhs) const
Equality operator.
Type
Detector type.
Definition: IonDetector.h:27
@ ARRAYDETECTOR
array detector
Definition: IonDetector.h:40
@ INDUCTIVEDETECTOR
inductive detector
Definition: IonDetector.h:48
@ FARADAYCUP
Faraday cup.
Definition: IonDetector.h:32
@ FOCALPLANECOLLECTOR
focal plane collector
Definition: IonDetector.h:43
@ CONVERSIONDYNODEPHOTOMULTIPLIER
Conversion dynode photo multiplier.
Definition: IonDetector.h:34
@ PHOTODIODEARRAYDETECTOR
photodiode array detector
Definition: IonDetector.h:47
@ DYNODE
dynode
Definition: IonDetector.h:42
@ ELECTRONMULTIPLIER
Electron multiplier.
Definition: IonDetector.h:29
@ CONVERSIONDYNODE
conversion dynode
Definition: IonDetector.h:41
@ CHANNELELECTRONMULTIPLIER
Channel electron multiplier.
Definition: IonDetector.h:36
@ POINTCOLLECTOR
point collector
Definition: IonDetector.h:45
@ CONVERSIONDYNODEELECTRONMULTIPLIER
Conversion dynode electron multiplier.
Definition: IonDetector.h:33
@ TYPENULL
Unknown.
Definition: IonDetector.h:28
@ PHOTOMULTIPLIER
Photo multiplier.
Definition: IonDetector.h:30
@ MICROCHANNELPLATEDETECTOR
microchannel plate detector
Definition: IonDetector.h:39
@ MULTICOLLECTOR
Multi-collector.
Definition: IonDetector.h:35
@ POSTACCELERATIONDETECTOR
postacceleration detector
Definition: IonDetector.h:46
@ DALYDETECTOR
daly detector
Definition: IonDetector.h:38
@ IONTOPHOTONDETECTOR
ion-to-photon detector
Definition: IonDetector.h:44
@ CHANNELTRON
channeltron
Definition: IonDetector.h:37
@ ELECTRONMULTIPLIERTUBE
electron multiplier tube
Definition: IonDetector.h:49
@ FOCALPLANEARRAY
Focal plane array.
Definition: IonDetector.h:31
Int getOrder() const
returns the position of this part in the whole Instrument.
double getResolution() const
returns the resolution (in ns)
void setResolution(double resolution)
sets the resolution (in ns)
static StringList getAllNamesOfType()
returns all detector type names known to OpenMS
IonDetector()
Constructor.
void setADCSamplingFrequency(double ADC_sampling_frequency)
sets the analog-to-digital converter sampling frequency (in Hz)
void setOrder(Int order)
sets the order
AcquisitionMode getAcquisitionMode() const
returns the acquisition mode
double resolution_
Definition: IonDetector.h:129
static StringList getAllNamesOfAcquisitionMode()
returns all acquisition mode names known to OpenMS
void setType(Type type)
sets the detector type
~IonDetector()
Destructor.
IonDetector(const IonDetector &)=default
Copy constructor.
Int order_
Definition: IonDetector.h:131
IonDetector & operator=(const IonDetector &)=default
Assignment operator.
void setAcquisitionMode(AcquisitionMode acquisition_mode)
sets the acquisition mode
Type getType() const
returns the detector type
AcquisitionMode
Acquisition mode.
Definition: IonDetector.h:57
@ TDC
Time-digital converter.
Definition: IonDetector.h:61
@ ACQMODENULL
Unknown.
Definition: IonDetector.h:58
@ PULSECOUNTING
Pulse counting.
Definition: IonDetector.h:59
@ ADC
Analog-digital converter.
Definition: IonDetector.h:60
@ TRANSIENTRECORDER
Transient recorder.
Definition: IonDetector.h:62
AcquisitionMode acquisition_mode_
Definition: IonDetector.h:128
double ADC_sampling_frequency_
Definition: IonDetector.h:130
bool operator==(const IonDetector &rhs) const
Equality operator.
IonDetector & operator=(IonDetector &&) &=default
Move assignment operator.
Type type_
Definition: IonDetector.h:127
double getADCSamplingFrequency() const
returns the analog-to-digital converter sampling frequency (in Hz)
IonDetector(IonDetector &&)=default
Move constructor.
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:35
int Int
Signed integer type.
Definition: Types.h:72
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:44
Main OpenMS namespace.
Definition: openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19