OpenMS  3.0.0
SONARScoring.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 
41 
43 
45 
46 namespace OpenMS
47 {
54  class OPENMS_DLLAPI SONARScoring :
55  public DefaultParamHandler
56  {
57 public:
58 
60 
61  SONARScoring();
63 
65  ~SONARScoring() override {}
67  //
68 
69  void computeSonarScores(OpenSwath::IMRMFeature* imrmfeature,
70  const std::vector<OpenSwath::LightTransition> & transitions,
71  const std::vector<OpenSwath::SwathMap>& swath_maps,
72  OpenSwath_Scores & scores) const;
73 
74 private:
75 
76  void computeXCorr_(std::vector<std::vector<double> >& sonar_profiles,
77  double& xcorr_coelution_score, double& xcorr_shape_score) const;
78 
80  SONARScoring(const SONARScoring& rhs);
81 
83  SONARScoring& operator=(const SONARScoring& rhs);
84 
86  void updateMembers_() override;
87 
91 
92  };
93 }
94 
95 
DefaultParamHandler.h
OpenSwathScoring.h
ITransition.h
OpenMS::SONARScoring::dia_extraction_ppm_
bool dia_extraction_ppm_
Definition: SONARScoring.h:90
OpenMS::SONARScoring::dia_centroided_
bool dia_centroided_
Definition: SONARScoring.h:89
OpenMS::SONARScoring::~SONARScoring
~SONARScoring() override
Destructor.
Definition: SONARScoring.h:65
TransitionExperiment.h
ISpectrumAccess.h
DataStructures.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::SONARScoring
Scoring of an spectrum using SONAR data.
Definition: SONARScoring.h:54
OpenMS::OpenSwath_Scores
A structure to hold the different scores computed by OpenSWATH.
Definition: OpenSwathScores.h:82
OpenMS::SONARScoring::dia_extract_window_
double dia_extract_window_
Definition: SONARScoring.h:88
OpenSwath::IMRMFeature
Definition: ITransition.h:56