| OpenMS 2.5.0

IonDetector.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2020.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg $
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/METADATA/MetaInfoInterface.h>
38
39 namespace OpenMS
40 {
46 class OPENMS_DLLAPI IonDetector :
47 public MetaInfoInterface
48 {
49 public:
51 enum Type
52 {
53 TYPENULL,
54 ELECTRONMULTIPLIER,
55 PHOTOMULTIPLIER,
56 FOCALPLANEARRAY,
57 FARADAYCUP,
58 CONVERSIONDYNODEELECTRONMULTIPLIER,
59 CONVERSIONDYNODEPHOTOMULTIPLIER,
60 MULTICOLLECTOR,
61 CHANNELELECTRONMULTIPLIER,
62 CHANNELTRON,
63 DALYDETECTOR,
64 MICROCHANNELPLATEDETECTOR,
65 ARRAYDETECTOR,
66 CONVERSIONDYNODE,
67 DYNODE,
68 FOCALPLANECOLLECTOR,
69 IONTOPHOTONDETECTOR,
70 POINTCOLLECTOR,
71 POSTACCELERATIONDETECTOR,
72 PHOTODIODEARRAYDETECTOR,
73 INDUCTIVEDETECTOR,
74 ELECTRONMULTIPLIERTUBE,
75 SIZE_OF_TYPE
76 };
78 static const std::string NamesOfType[SIZE_OF_TYPE];
79
81 enum AcquisitionMode
82 {
83 ACQMODENULL,
84 PULSECOUNTING,
85 ADC,
86 TDC,
87 TRANSIENTRECORDER,
88 SIZE_OF_ACQUISITIONMODE
89 };
91 static const std::string NamesOfAcquisitionMode[SIZE_OF_ACQUISITIONMODE];
92
94 IonDetector();
96 IonDetector(const IonDetector &) = default;
98 IonDetector(IonDetector&&) = default;
100 ~IonDetector();
101
103 IonDetector & operator=(const IonDetector &) = default;
105 IonDetector& operator=(IonDetector&&) & = default;
106
108 bool operator==(const IonDetector & rhs) const;
110 bool operator!=(const IonDetector & rhs) const;
111
113 Type getType() const;
115 void setType(Type type);
116
118 AcquisitionMode getAcquisitionMode() const;
120 void setAcquisitionMode(AcquisitionMode acquisition_mode);
121
123 double getResolution() const;
125 void setResolution(double resolution);
126
128 double getADCSamplingFrequency() const;
130 void setADCSamplingFrequency(double ADC_sampling_frequency);
131
142 Int getOrder() const;
144 void setOrder(Int order);
145
146 protected:
147 Type type_;
148 AcquisitionMode acquisition_mode_;
149 double resolution_;
150 double ADC_sampling_frequency_;
151 Int order_;
152
153 };
154 } // namespace OpenMS
155
OpenMS::IonDetector::CHANNELTRON
channeltron
Definition: IonDetector.h:62
OpenMS::IonDetector::POINTCOLLECTOR
point collector
Definition: IonDetector.h:70
OpenMS::IonDetector::FOCALPLANECOLLECTOR
focal plane collector
Definition: IonDetector.h:68
OpenMS::IonDetector::ACQMODENULL
Unknown.
Definition: IonDetector.h:83
OpenMS::IonDetector::TRANSIENTRECORDER
Transient recorder.
Definition: IonDetector.h:87
OpenMS::IonDetector::CHANNELELECTRONMULTIPLIER
Channel electron multiplier.
Definition: IonDetector.h:61
OpenMS::IonDetector::POSTACCELERATIONDETECTOR
postacceleration detector
Definition: IonDetector.h:71
OpenMS::IonDetector::INDUCTIVEDETECTOR
inductive detector
Definition: IonDetector.h:73
OpenMS::IonDetector::DYNODE
dynode
Definition: IonDetector.h:67
KDTree::operator!=
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
OpenMS::IonDetector::Type
Type
Detector type.
Definition: IonDetector.h:51
OpenMS::IonDetector::resolution_
double resolution_
Definition: IonDetector.h:149
OpenMS::IonDetector::ARRAYDETECTOR
array detector
Definition: IonDetector.h:65
OpenMS::IonDetector::PULSECOUNTING
Pulse counting.
Definition: IonDetector.h:84
OpenMS::IonDetector::ELECTRONMULTIPLIERTUBE
electron multiplier tube
Definition: IonDetector.h:74
OpenMS::IonDetector::CONVERSIONDYNODEPHOTOMULTIPLIER
Conversion dynode photo multiplier.
Definition: IonDetector.h:59
OpenMS::IonDetector::IONTOPHOTONDETECTOR
ion-to-photon detector
Definition: IonDetector.h:69
OpenMS::IonDetector::ADC
Analog-digital converter.
Definition: IonDetector.h:85
OpenMS::IonDetector::MULTICOLLECTOR
Multi-collector.
Definition: IonDetector.h:60
OpenMS::IonDetector::CONVERSIONDYNODE
conversion dynode
Definition: IonDetector.h:66
OpenMS::IonDetector::ELECTRONMULTIPLIER
Electron multiplier.
Definition: IonDetector.h:54
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::IonDetector::MICROCHANNELPLATEDETECTOR
microchannel plate detector
Definition: IonDetector.h:64
OpenMS::IonDetector::PHOTOMULTIPLIER
Photo multiplier.
Definition: IonDetector.h:55
OpenMS::IonDetector::DALYDETECTOR
daly detector
Definition: IonDetector.h:63
int
OpenMS::IonDetector::ADC_sampling_frequency_
double ADC_sampling_frequency_
Definition: IonDetector.h:150
MetaInfoInterface.h
OpenMS::IonDetector::order_
Int order_
Definition: IonDetector.h:151
OpenMS::IonDetector::AcquisitionMode
AcquisitionMode
Acquisition mode.
Definition: IonDetector.h:81
OpenMS::IonDetector
Description of a ion detector (part of a MS Instrument)
Definition: IonDetector.h:46
OpenMS::IonDetector::PHOTODIODEARRAYDETECTOR
photodiode array detector
Definition: IonDetector.h:72
OpenMS::IonDetector::acquisition_mode_
AcquisitionMode acquisition_mode_
Definition: IonDetector.h:148
OpenMS::IonDetector::TDC
Time-digital converter.
Definition: IonDetector.h:86
OpenMS::IonDetector::FARADAYCUP
Faraday cup.
Definition: IonDetector.h:57
OpenMS::IonDetector::CONVERSIONDYNODEELECTRONMULTIPLIER
Conversion dynode electron multiplier.
Definition: IonDetector.h:58
OpenMS::IonDetector::type_
Type type_
Definition: IonDetector.h:147
OpenMS::MetaInfoInterface
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:60
OpenMS::IonDetector::FOCALPLANEARRAY
Focal plane array.
Definition: IonDetector.h:56
KDTree::operator==
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
OpenMS::IonDetector::TYPENULL
Unknown.
Definition: IonDetector.h:53