OpenMS
IMTypes.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-2023.
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: Chris Bielow $
32 // $Authors: Chris Bielow $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 #include <OpenMS/OpenMSConfig.h>
39 
40 #include <string>
41 
42 namespace OpenMS
43 {
44  class MSExperiment;
45  class MSSpectrum;
46 
48  enum class DriftTimeUnit
49  {
50  NONE,
51  MILLISECOND,
52  VSSC,
55  };
56 
58  OPENMS_DLLAPI extern const std::string NamesOfDriftTimeUnit[(size_t) DriftTimeUnit::SIZE_OF_DRIFTTIMEUNIT];
59 
62  OPENMS_DLLAPI DriftTimeUnit toDriftTimeUnit(const std::string& dtu_string);
63 
66  OPENMS_DLLAPI const std::string& toString(const DriftTimeUnit value);
67 
69  enum class IMFormat
70  {
71  NONE,
72  CONCATENATED,
74  MIXED,
76  };
78  OPENMS_DLLAPI extern const std::string NamesOfIMFormat[(size_t) IMFormat::SIZE_OF_IMFORMAT];
79 
82  OPENMS_DLLAPI IMFormat toIMFormat(const std::string& IM_format);
85  OPENMS_DLLAPI const std::string& toString(const IMFormat value);
86 
87  class OPENMS_DLLAPI IMTypes
88  {
89  public:
91  inline static constexpr double DRIFTTIME_NOT_SET = -1.0;
92 
98 
107  static IMFormat determineIMFormat(const MSSpectrum& spec);
108 
115  static DIM_UNIT fromIMUnit(const DriftTimeUnit from);
116  };
117 
118 };
119 
Definition: IMTypes.h:88
static IMFormat determineIMFormat(const MSExperiment &exp)
static DIM_UNIT fromIMUnit(const DriftTimeUnit from)
static IMFormat determineIMFormat(const MSSpectrum &spec)
Checks for existence of a single driftTime (using spec.getDriftTime()) or an ion-mobility float data ...
In-Memory representation of a mass spectrometry run.
Definition: MSExperiment.h:72
The representation of a 1D spectrum.
Definition: MSSpectrum.h:70
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48
IMFormat
Different ways to represent ion mobility data in a spectrum.
Definition: IMTypes.h:70
@ MIXED
an MSExperiment contains both CONCATENATED and MULTIPLE_SPECTRA
@ CONCATENATED
ion mobility frame is stacked in a single spectrum (i.e. has an IM float data array)
@ NONE
no ion mobility
@ MULTIPLE_SPECTRA
ion mobility is recorded as multiple spectra per frame (i.e. has one IM annotation per spectrum)
DriftTimeUnit toDriftTimeUnit(const std::string &dtu_string)
DriftTimeUnit
Drift time unit for ion mobility.
Definition: IMTypes.h:49
@ MILLISECOND
milliseconds
@ VSSC
volt-second per square centimeter (i.e. 1/K_0)
@ FAIMS_COMPENSATION_VOLTAGE
compensation voltage
const std::string NamesOfIMFormat[(size_t) IMFormat::SIZE_OF_IMFORMAT]
Names of IMFormat.
const std::string NamesOfDriftTimeUnit[(size_t) DriftTimeUnit::SIZE_OF_DRIFTTIMEUNIT]
Names of IM Units. Should be usable as axis annotation.
const std::string & toString(const DriftTimeUnit value)
IMFormat toIMFormat(const std::string &IM_format)
DIM_UNIT
Definition: CommonEnums.h:46