OpenMS
AbsoluteQuantitationMethod.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: Douglas McCloskey, Pasquale Domenico Colaianni $
32 // $Authors: Douglas McCloskey, Pasquale Domenico Colaianni $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/config.h> // OPENMS_DLLAPI
40 
41 namespace OpenMS
42 {
52  class OPENMS_DLLAPI AbsoluteQuantitationMethod
53  {
54 public:
55  bool operator==(const AbsoluteQuantitationMethod& other) const;
56  bool operator!=(const AbsoluteQuantitationMethod& other) const;
57 
58  void setComponentName(const String& component_name);
60 
61  void setFeatureName(const String& feature_name);
63 
64  void setISName(const String& IS_name);
65  String getISName() const;
66 
67  void setLLOD(const double llod);
68  double getLLOD() const;
69  void setULOD(const double ulod);
70  double getULOD() const;
71  bool checkLOD(const double value) const;
72 
73  void setLLOQ(const double lloq);
74  double getLLOQ() const;
75  void setULOQ(const double uloq);
76  double getULOQ() const;
77  bool checkLOQ(const double value) const;
78 
79  void setNPoints(const Int n_points);
80  Int getNPoints() const;
81 
82  void setCorrelationCoefficient(const double correlation_coefficient);
83  double getCorrelationCoefficient() const;
84 
85  void setConcentrationUnits(const String& concentration_units);
87 
88  void setTransformationModel(const String& transformation_model);
90 
91  void setTransformationModelParams(const Param& transformation_model_params);
93 
94 private:
101  double llod_ { 0.0 };
102  double ulod_ { 0.0 };
103  double lloq_ { 0.0 };
104  double uloq_ { 0.0 };
105  double correlation_coefficient_ { 0.0 };
106  Int n_points_ { 0 };
107  };
108 }
109 
AbsoluteQuantitationMethod is a class to hold information about the quantitation method and for apply...
Definition: AbsoluteQuantitationMethod.h:53
void setCorrelationCoefficient(const double correlation_coefficient)
Set the correlation coefficient.
String getComponentName() const
Component name getter.
Param getTransformationModelParams() const
Transformation model parameters getter.
Param transformation_model_params_
transformation model parameters
Definition: AbsoluteQuantitationMethod.h:95
Int getNPoints() const
Get the number of points.
void setComponentName(const String &component_name)
Component name setter.
void setFeatureName(const String &feature_name)
Feature name setter.
void setISName(const String &IS_name)
IS name setter.
void setNPoints(const Int n_points)
Set the number of points.
void setULOD(const double ulod)
ULOD setter.
bool checkLOQ(const double value) const
This function checks if the value is within the limits of quantitation (LOQ)
double getULOQ() const
ULOQ getter.
bool checkLOD(const double value) const
This function checks if the value is within the limits of detection (LOD)
String feature_name_
name of the feature (i.e., peak_apex_int or peak_area)
Definition: AbsoluteQuantitationMethod.h:97
String transformation_model_
transformation model
Definition: AbsoluteQuantitationMethod.h:100
void setLLOD(const double llod)
LLOD setter.
String getISName() const
IS_name getter.
void setConcentrationUnits(const String &concentration_units)
Concentration units setter.
double getLLOD() const
LLOD getter.
void setULOQ(const double uloq)
ULOQ setter.
String getTransformationModel() const
Transformation model getter.
void setTransformationModel(const String &transformation_model)
Transformation model setter.
double getULOD() const
ULOD getter.
bool operator==(const AbsoluteQuantitationMethod &other) const
void setTransformationModelParams(const Param &transformation_model_params)
Transformation model parameters setter.
double getCorrelationCoefficient() const
Get the correlation coefficient.
bool operator!=(const AbsoluteQuantitationMethod &other) const
String getFeatureName() const
Feature name getter.
String concentration_units_
concentration units of the component's concentration
Definition: AbsoluteQuantitationMethod.h:99
String getConcentrationUnits() const
Concentration units getter.
String component_name_
id of the component
Definition: AbsoluteQuantitationMethod.h:96
String IS_name_
the internal standard (IS) name for the transition
Definition: AbsoluteQuantitationMethod.h:98
double getLLOQ() const
LLOQ getter.
void setLLOQ(const double lloq)
LLOQ setter.
Management and storage of parameters / INI files.
Definition: Param.h:70
A more convenient string class.
Definition: String.h:60
int Int
Signed integer type.
Definition: Types.h:102
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48