OpenMS
AcqusHandler.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: Timo Sachsenberg $
32 // $Authors: Guillaume Belz $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 #include <map>
39 
40 namespace OpenMS
41 {
42  namespace Internal
43  {
52  class OPENMS_DLLAPI AcqusHandler
53  {
54 public:
65  explicit AcqusHandler(const String & filename);
66 
68  virtual ~AcqusHandler();
69 
71  double getPosition(Size index) const;
72 
74  String getParam(const String & param);
75 
77  Size getSize() const;
78 
79 private:
82 
84  std::map<String, String> params_;
85 
88  double dw_;
90  double ml1_;
91  double ml2_;
92  double ml3_;
95  };
96  } // namespace Internal
97 } // namespace OpenMS
98 
Read-only acqus File handler for XMass Analysis.
Definition: AcqusHandler.h:53
double ml1_
Definition: AcqusHandler.h:90
AcqusHandler(const String &filename)
Constructor with filename.
double dw_
Definition: AcqusHandler.h:88
Size getSize() const
Get size of spectrum.
AcqusHandler()
Private default constructor.
String getParam(const String &param)
Read param as string.
virtual ~AcqusHandler()
Destructor.
Size td_
Definition: AcqusHandler.h:93
double getPosition(Size index) const
Conversion from index to MZ ratio using internal calibration params.
Size delay_
Definition: AcqusHandler.h:89
double ml2_
Definition: AcqusHandler.h:91
double ml3_
Definition: AcqusHandler.h:92
std::map< String, String > params_
Map for params saving.
Definition: AcqusHandler.h:84
A more convenient string class.
Definition: String.h:60
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48