OpenMS  3.0.0
FeatureFileOptions.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-2022.
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: Marc Sturm, Chris Bielow $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 
39 #include <vector>
40 
41 namespace OpenMS
42 {
46  class OPENMS_DLLAPI FeatureFileOptions
47  {
48 public:
53 
56  void setLoadConvexHull(bool convex);
58  bool getLoadConvexHull() const;
59 
62  void setLoadSubordinates(bool sub);
64  bool getLoadSubordinates() const;
65 
68  void setMetadataOnly(bool only);
70  bool getMetadataOnly() const;
71 
74  void setSizeOnly(bool only);
76  bool getSizeOnly() const;
77 
80  void setRTRange(const DRange<1> & range);
82  bool hasRTRange() const;
84  const DRange<1> & getRTRange() const;
85 
88  void setMZRange(const DRange<1> & range);
90  bool hasMZRange() const;
92  const DRange<1> & getMZRange() const;
93 
96  void setIntensityRange(const DRange<1> & range);
98  bool hasIntensityRange() const;
100  const DRange<1> & getIntensityRange() const;
101 
102 private:
113 
114  };
115 
116 } // namespace OpenMS
117 
OpenMS::FeatureFileOptions::has_rt_range_
bool has_rt_range_
Definition: FeatureFileOptions.h:106
OpenMS::FeatureFileOptions::size_only_
bool size_only_
Definition: FeatureFileOptions.h:109
DRange.h
OpenMS::FeatureFileOptions
Options for loading files containing features.
Definition: FeatureFileOptions.h:46
OpenMS::FeatureFileOptions::has_mz_range_
bool has_mz_range_
Definition: FeatureFileOptions.h:107
OpenMS::DRange< 1 >
OpenMS::FeatureFileOptions::metadata_only_
bool metadata_only_
Definition: FeatureFileOptions.h:105
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::FeatureFileOptions::has_intensity_range_
bool has_intensity_range_
Definition: FeatureFileOptions.h:108
OpenMS::FeatureFileOptions::rt_range_
DRange< 1 > rt_range_
Definition: FeatureFileOptions.h:110
OpenMS::FeatureFileOptions::loadConvexhull_
bool loadConvexhull_
Definition: FeatureFileOptions.h:103
OpenMS::FeatureFileOptions::loadSubordinates_
bool loadSubordinates_
Definition: FeatureFileOptions.h:104
OpenMS::FeatureFileOptions::intensity_range_
DRange< 1 > intensity_range_
Definition: FeatureFileOptions.h:112
OpenMS::FeatureFileOptions::mz_range_
DRange< 1 > mz_range_
Definition: FeatureFileOptions.h:111