OpenMS  3.0.0
OpenSwathTSVWriter.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: Hannes Roest $
32 // $Authors: Hannes Roest $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 // Interfaces
39 
41 
42 #include <fstream>
43 
44 namespace OpenMS
45 {
46 
129  class OPENMS_DLLAPI OpenSwathTSVWriter
130  {
131  std::ofstream ofs;
133  bool doWrite_;
135  bool sonar_;
136 
137  public:
138 
139  OpenSwathTSVWriter(const String& output_filename,
140  const String& input_filename = "inputfile",
141  bool ms1_scores = false,
142  bool sonar = false);
143 
144  bool isActive() const;
145 
150  void writeHeader();
151 
166  String prepareLine(const OpenSwath::LightCompound& pep,
167  const OpenSwath::LightTransition * transition,
168  const FeatureMap& output, const String id) const;
169 
180  void writeLines(const std::vector<String>& to_output);
181 
182  };
183 
184 }
185 
186 
OpenMS::OpenSwathTSVWriter::ofs
std::ofstream ofs
Definition: OpenSwathTSVWriter.h:131
OpenMS::OpenSwathTSVWriter
Class to write out an OpenSwath TSV output (mProphet input).
Definition: OpenSwathTSVWriter.h:129
OpenMS::OpenSwathTSVWriter::input_filename_
String input_filename_
Definition: OpenSwathTSVWriter.h:132
OpenMS::String
A more convenient string class.
Definition: String.h:58
TransitionExperiment.h
OpenMS::OpenSwathTSVWriter::doWrite_
bool doWrite_
Definition: OpenSwathTSVWriter.h:133
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenSwath::LightCompound
Definition: TransitionExperiment.h:160
FeatureMap.h
OpenMS::OpenSwathTSVWriter::use_ms1_traces_
bool use_ms1_traces_
Definition: OpenSwathTSVWriter.h:134
OpenMS::FeatureMap
A container for features.
Definition: FeatureMap.h:98
OpenMS::OpenSwathTSVWriter::sonar_
bool sonar_
Definition: OpenSwathTSVWriter.h:135
OpenSwath::LightTransition
Definition: TransitionExperiment.h:45