/usr/include/OpenMS/METADATA/IonDetector.h is in libopenms-dev 1.11.1-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 | // --------------------------------------------------------------------------
// OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2013.
//
// This software is released under a three-clause BSD license:
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// * Neither the name of any author or any participating institution
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Andreas Bertsch $
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------
#ifndef OPENMS_METADATA_IONDETECTOR_H
#define OPENMS_METADATA_IONDETECTOR_H
#include <OpenMS/METADATA/MetaInfoInterface.h>
namespace OpenMS
{
/**
@brief Description of a ion detector (part of a MS Instrument)
@ingroup Metadata
*/
class OPENMS_DLLAPI IonDetector :
public MetaInfoInterface
{
public:
/// Detector type
enum Type
{
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
};
/// Names of detector types
static const std::string NamesOfType[SIZE_OF_TYPE];
/// Acquisition mode
enum AcquisitionMode
{
ACQMODENULL, ///< Unknown
PULSECOUNTING, ///< Pulse counting
ADC, ///< Analog-digital converter
TDC, ///< Time-digital converter
TRANSIENTRECORDER, ///< Transient recorder
SIZE_OF_ACQUISITIONMODE
};
/// Names of acquisition modes
static const std::string NamesOfAcquisitionMode[SIZE_OF_ACQUISITIONMODE];
/// Constructor
IonDetector();
/// Copy constructor
IonDetector(const IonDetector & source);
/// Destructor
~IonDetector();
/// Assignment operator
IonDetector & operator=(const IonDetector & source);
/// Equality operator
bool operator==(const IonDetector & rhs) const;
/// Equality operator
bool operator!=(const IonDetector & rhs) const;
/// returns the detector type
Type getType() const;
/// sets the detector type
void setType(Type type);
/// returns the acquisition mode
AcquisitionMode getAcquisitionMode() const;
/// sets the acquisition mode
void setAcquisitionMode(AcquisitionMode acquisition_mode);
/// returns the resolution (in ns)
DoubleReal getResolution() const;
/// sets the resolution (in ns)
void setResolution(DoubleReal resolution);
/// returns the analog-to-digital converter sampling frequency (in Hz)
DoubleReal getADCSamplingFrequency() const;
/// sets the analog-to-digital converter sampling frequency (in Hz)
void setADCSamplingFrequency(DoubleReal ADC_sampling_frequency);
/**
@brief 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.
*/
Int getOrder() const;
/// sets the order
void setOrder(Int order);
protected:
Type type_;
AcquisitionMode acquisition_mode_;
DoubleReal resolution_;
DoubleReal ADC_sampling_frequency_;
Int order_;
};
} // namespace OpenMS
#endif // OPENMS_METADATA_IONDETECTOR_H
|