| OpenMS 2.5.0

MRMFeatureQCFile.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-2020.
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/FORMAT/CsvFile.h>
38 #include <OpenMS/CONCEPT/ProgressLogger.h>
39 #include <OpenMS/DATASTRUCTURES/StringListUtils.h>
40 #include <OpenMS/ANALYSIS/OPENSWATH/MRMFeatureQC.h>
41
42 namespace OpenMS
43 {
51 class OPENMS_DLLAPI MRMFeatureQCFile :
52 private CsvFile,
53 public ProgressLogger
54 {
55 public:
57 MRMFeatureQCFile() = default;
59 ~MRMFeatureQCFile() = default;
60
71 void load(const String& filename, MRMFeatureQC& mrmfqc, const bool is_component_group) const;
72
73 /*
74 @brief Stores an MRMFeatureQC file.
75
76 @exception Exception::UnableToCreateFile is thrown if the file could not be created
77 */
78 // void store(const String& filename, const MRMFeatureQC& mrmfqc);
79
80
81 protected:
91 void pushValuesFromLine_(
92 const StringList& line,
93 const std::map<String, Size>& headers,
94 std::vector<MRMFeatureQC::ComponentQCs>& c_qcs
95 ) const;
96
106 void pushValuesFromLine_(
107 const StringList& line,
108 const std::map<String, Size>& headers,
109 std::vector<MRMFeatureQC::ComponentGroupQCs>& cg_qcs
110 ) const;
111
126 void setPairValue_(
127 const String& key,
128 const String& value,
129 const String& boundary,
130 std::map<String, std::pair<double,double>>& meta_values_qc
131 ) const;
132
147 Int getCastValue_(
148 const std::map<String, Size>& headers,
149 const StringList& line,
150 const String& header,
151 const Int default_value
152 ) const;
153
168 double getCastValue_(
169 const std::map<String, Size>& headers,
170 const StringList& line,
171 const String& header,
172 const double default_value
173 ) const;
174
189 String getCastValue_(
190 const std::map<String, Size>& headers,
191 const StringList& line,
192 const String& header,
193 const String& default_value
194 ) const;
195
196 };
197
198 } // namespace OpenMS
199
MRMFeatureQC.h
OpenMS::String
A more convenient string class.
Definition: String.h:58
CsvFile.h
StringListUtils.h
ProgressLogger.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::MRMFeatureQCFile
File adapter for MRMFeatureQC files.
Definition: MRMFeatureQCFile.h:51
OpenMS::ProgressLogger
Base class for all classes that want to report their progress.
Definition: ProgressLogger.h:54
OpenMS::StringList
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:70
int
OpenMS::MRMFeatureQC
The MRMFeatureQC is a class to handle the parameters and options for MRMFeatureFilter.
Definition: MRMFeatureQC.h:60
OpenMS::CsvFile
This class handles csv files. Currently only loading is implemented.
Definition: CsvFile.h:49