OpenMS  3.0.0
GNPSMGFFile.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: Dorrestein Lab - University of California San Diego - https://dorresteinlab.ucsd.edu/$
32 // $Authors: Abinesh Sarvepalli and Louis Felix Nothias$
33 // $Contributors: Fabian Aicheler and Oliver Alka from Oliver Kohlbacher's group at Tubingen University$
34 
35 #pragma once
36 
40 
41 namespace OpenMS
42 {
43  class OPENMS_DLLAPI GNPSMGFFile :
44  public DefaultParamHandler,
45  public ProgressLogger
46  {
47  public:
48  // default c'tor
49  GNPSMGFFile();
50 
51  // see GNPSExport tool documentation
58  void store(const String& consensus_file_path, const StringList& mzml_file_paths, const String& out) const;
59 
60  private:
61  static constexpr double DEF_COSINE_SIMILARITY = 0.9;
62  static constexpr double DEF_MERGE_BIN_SIZE = static_cast<double>(BinnedSpectrum::DEFAULT_BIN_WIDTH_HIRES);
63 
64 // static constexpr double DEF_PREC_MASS_TOL = 0.5;
65 // static constexpr bool DEF_PREC_MASS_TOL_ISPPM = false;
66 
67  static constexpr int DEF_PEPT_CUTOFF = 5;
68  static constexpr int DEF_MSMAP_CACHE = 50;
69  };
70 }
DefaultParamHandler.h
OpenMS::BinnedSpectrum::DEFAULT_BIN_WIDTH_HIRES
static constexpr const float DEFAULT_BIN_WIDTH_HIRES
Definition: BinnedSpectrum.h:104
OpenMS::GNPSMGFFile
Definition: GNPSMGFFile.h:43
OpenMS::String
A more convenient string class.
Definition: String.h:58
BinnedSpectrum.h
OpenMS::DefaultParamHandler
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:92
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::ProgressLogger
Base class for all classes that want to report their progress.
Definition: ProgressLogger.h:52
ProgressLogger.h
OpenMS::StringList
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:70