OpenMS
Loading...
Searching...
No Matches
AbsoluteQuantitationMethod.h
Go to the documentation of this file.
1// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
2// SPDX-License-Identifier: BSD-3-Clause
3//
4// --------------------------------------------------------------------------
5// $Maintainer: Douglas McCloskey, Pasquale Domenico Colaianni $
6// $Authors: Douglas McCloskey, Pasquale Domenico Colaianni $
7// --------------------------------------------------------------------------
8
9#pragma once
10
11#include <OpenMS/config.h> // OPENMS_DLLAPI
14
15namespace OpenMS
16{
43 class OPENMS_DLLAPI AbsoluteQuantitationMethod
44 {
45public:
46 bool operator==(const AbsoluteQuantitationMethod& other) const;
47 bool operator!=(const AbsoluteQuantitationMethod& other) const;
48
49 void setComponentName(const std::string& component_name);
50 std::string getComponentName() const;
51
52 void setFeatureName(const std::string& feature_name);
53 std::string getFeatureName() const;
54
55 void setISName(const std::string& IS_name);
56 std::string getISName() const;
57
58 void setLLOD(const double llod);
59 double getLLOD() const;
60 void setULOD(const double ulod);
61 double getULOD() const;
62 bool checkLOD(const double value) const;
63
64 void setLLOQ(const double lloq);
65 double getLLOQ() const;
66 void setULOQ(const double uloq);
67 double getULOQ() const;
68 bool checkLOQ(const double value) const;
69
70 void setNPoints(const Int n_points);
71 Int getNPoints() const;
72
73 void setCorrelationCoefficient(const double correlation_coefficient);
75
76 void setConcentrationUnits(const std::string& concentration_units);
77 std::string getConcentrationUnits() const;
78
79 void setTransformationModel(const std::string& transformation_model);
80 std::string getTransformationModel() const;
81
82 void setTransformationModelParams(const Param& transformation_model_params);
84
85private:
87 std::string component_name_;
88 std::string feature_name_;
89 std::string IS_name_;
92 double llod_ { 0.0 };
93 double ulod_ { 0.0 };
94 double lloq_ { 0.0 };
95 double uloq_ { 0.0 };
96 double correlation_coefficient_ { 0.0 };
97 Int n_points_ { 0 };
98 };
99}
100
AbsoluteQuantitationMethod is a class to hold information about the quantitation method and for apply...
Definition AbsoluteQuantitationMethod.h:44
void setCorrelationCoefficient(const double correlation_coefficient)
Set the correlation coefficient.
Param getTransformationModelParams() const
Transformation model parameters getter.
Param transformation_model_params_
transformation model parameters
Definition AbsoluteQuantitationMethod.h:86
Int getNPoints() const
Get the number of points.
std::string transformation_model_
transformation model
Definition AbsoluteQuantitationMethod.h:91
std::string getComponentName() const
Component name getter.
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)
std::string component_name_
id of the component
Definition AbsoluteQuantitationMethod.h:87
double getULOQ() const
ULOQ getter.
bool checkLOD(const double value) const
This function checks if the value is within the limits of detection (LOD)
void setConcentrationUnits(const std::string &concentration_units)
Concentration units setter.
void setLLOD(const double llod)
LLOD setter.
std::string feature_name_
name of the feature (i.e., peak_apex_int or peak_area)
Definition AbsoluteQuantitationMethod.h:88
void setComponentName(const std::string &component_name)
Component name setter.
double getLLOD() const
LLOD getter.
std::string getISName() const
IS_name getter.
void setULOQ(const double uloq)
ULOQ setter.
std::string getTransformationModel() const
Transformation model getter.
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
std::string concentration_units_
concentration units of the component's concentration
Definition AbsoluteQuantitationMethod.h:90
void setFeatureName(const std::string &feature_name)
Feature name setter.
std::string getConcentrationUnits() const
Concentration units getter.
std::string IS_name_
the internal standard (IS) name for the transition
Definition AbsoluteQuantitationMethod.h:89
double getLLOQ() const
LLOQ getter.
void setTransformationModel(const std::string &transformation_model)
Transformation model setter.
void setISName(const std::string &IS_name)
IS name setter.
void setLLOQ(const double lloq)
LLOQ setter.
std::string getFeatureName() const
Feature name getter.
Management and storage of parameters / INI files.
Definition Param.h:46
int Int
Signed integer type.
Definition Types.h:72
Main OpenMS namespace.
Definition openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19