| OpenMS 2.5.0

FeatureFinderAlgorithmSH.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: Timo Sachsenberg $
32 // $Authors: Florian Zeller $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/TRANSFORMATIONS/FEATUREFINDER/SUPERHIRN/SuperHirnConfig.h>
38
39 #include <OpenMS/TRANSFORMATIONS/FEATUREFINDER/FeatureFinderAlgorithm.h>
40
41 namespace OpenMS
42 {
99 class SUPERHIRN_DLLAPI FeatureFinderAlgorithmSH :
100 public FeatureFinderAlgorithm,
101 public FeatureFinderDefs
102 {
103
104 public:
105 typedef Peak1D PeakType;
106 typedef FeatureFinderAlgorithm::MapType MapType; // MSExperiment
107 typedef MapType::SpectrumType SpectrumType;
108
109 FeatureFinderAlgorithmSH();
110
111 unsigned int getNativeScanId(String native_id);
112
113 void run() override;
114
115 static FeatureFinderAlgorithm* create();
116
117 static const String getProductName();
118
119 protected:
120 MapType map_;
121 using FeatureFinderAlgorithm::features_;
122
123 };
124
125 }
126
OpenMS::FeatureFinderAlgorithmSH::SpectrumType
MapType::SpectrumType SpectrumType
Definition: FeatureFinderAlgorithmSH.h:107
OpenMS::String
A more convenient string class.
Definition: String.h:58
FeatureFinderAlgorithm.h
OpenMS::FeatureFinderAlgorithm
Abstract base class for FeatureFinder algorithms.
Definition: FeatureFinderAlgorithm.h:74
OpenMS::MSExperiment
In-Memory representation of a mass spectrometry experiment.
Definition: MSExperiment.h:77
OpenMS::FeatureFinderAlgorithmSH::map_
MapType map_
Definition: FeatureFinderAlgorithmSH.h:120
OpenMS::Peak1D
A 1-dimensional raw data point or peak.
Definition: Peak1D.h:54
OpenMS::MSSpectrum
The representation of a 1D spectrum.
Definition: MSSpectrum.h:67
OpenMS::FeatureFinderAlgorithmSH::MapType
FeatureFinderAlgorithm::MapType MapType
Definition: FeatureFinderAlgorithmSH.h:106
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::FeatureFinderDefs
The purpose of this struct is to provide definitions of classes and typedefs which are used throughou...
Definition: FeatureFinderDefs.h:50
OpenMS::FeatureFinderAlgorithmSH
The Superhirn FeatureFinderAlgorithm.
Definition: FeatureFinderAlgorithmSH.h:99
OpenMS::FeatureFinderAlgorithm::features_
FeatureMap * features_
Output data pointer.
Definition: FeatureFinderAlgorithm.h:142
OpenMS::FeatureFinderAlgorithmSH::PeakType
Peak1D PeakType
Definition: FeatureFinderAlgorithmSH.h:105