OpenMS
FeatureFileOptions.h
Go to the documentation of this file.
1 // Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
2 // SPDX-License-Identifier: BSD-3-Clause
3 //
4 // --------------------------------------------------------------------------
5 // $Maintainer: Chris Bielow $
6 // $Authors: Marc Sturm, Chris Bielow $
7 // --------------------------------------------------------------------------
8 
9 #pragma once
10 
12 
13 #include <vector>
14 
15 namespace OpenMS
16 {
20  class OPENMS_DLLAPI FeatureFileOptions
21  {
22 public:
27 
30  void setLoadConvexHull(bool convex);
32  bool getLoadConvexHull() const;
33 
36  void setLoadSubordinates(bool sub);
38  bool getLoadSubordinates() const;
39 
42  void setMetadataOnly(bool only);
44  bool getMetadataOnly() const;
45 
48  void setSizeOnly(bool only);
50  bool getSizeOnly() const;
51 
54  void setRTRange(const DRange<1> & range);
56  bool hasRTRange() const;
58  const DRange<1> & getRTRange() const;
59 
62  void setMZRange(const DRange<1> & range);
64  bool hasMZRange() const;
66  const DRange<1> & getMZRange() const;
67 
70  void setIntensityRange(const DRange<1> & range);
72  bool hasIntensityRange() const;
74  const DRange<1> & getIntensityRange() const;
75 
76 private:
83  bool size_only_;
87 
88  };
89 
90 } // namespace OpenMS
91 
Options for loading files containing features.
Definition: FeatureFileOptions.h:21
const DRange< 1 > & getMZRange() const
returns the MZ range
const DRange< 1 > & getIntensityRange() const
returns the intensity range
bool hasRTRange() const
returns true if an RT range has been set
bool loadSubordinates_
Definition: FeatureFileOptions.h:78
void setRTRange(const DRange< 1 > &range)
bool getMetadataOnly() const
returns whether or not to load only meta data
bool getSizeOnly() const
returns whether or not to load only meta data
void setLoadConvexHull(bool convex)
void setSizeOnly(bool only)
bool hasMZRange() const
returns true if an MZ range has been set
bool has_intensity_range_
Definition: FeatureFileOptions.h:82
bool metadata_only_
Definition: FeatureFileOptions.h:79
void setLoadSubordinates(bool sub)
bool hasIntensityRange() const
returns true if an intensity range has been set
~FeatureFileOptions()
Destructor.
DRange< 1 > mz_range_
Definition: FeatureFileOptions.h:85
DRange< 1 > rt_range_
Definition: FeatureFileOptions.h:84
bool getLoadConvexHull() const
returns whether or not to load convex hull
void setMetadataOnly(bool only)
void setIntensityRange(const DRange< 1 > &range)
bool size_only_
Definition: FeatureFileOptions.h:83
void setMZRange(const DRange< 1 > &range)
bool has_rt_range_
Definition: FeatureFileOptions.h:80
const DRange< 1 > & getRTRange() const
returns the RT range
bool getLoadSubordinates() const
returns whether or not to load subordinates
bool loadConvexhull_
Definition: FeatureFileOptions.h:77
DRange< 1 > intensity_range_
Definition: FeatureFileOptions.h:86
FeatureFileOptions()
Default constructor.
bool has_mz_range_
Definition: FeatureFileOptions.h:81
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:22