OpenMS  3.0.0
SwathMapMassCorrection.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 #include <vector>
38 
41 
42 namespace OpenMS
43 {
44 
52  class OPENMS_DLLAPI SwathMapMassCorrection :
53  public DefaultParamHandler
54  {
55 
56 public:
57 
61 
63  ~SwathMapMassCorrection() override = default;
65 
67  void updateMembers_() override;
68 
85  void correctMZ(const std::map<String, OpenMS::MRMFeatureFinderScoring::MRMTransitionGroupType *>& transition_group_map,
86  const OpenSwath::LightTargetedExperiment & targeted_exp,
87  std::vector< OpenSwath::SwathMap > & swath_maps);
88 
104  void correctIM(const std::map<String, OpenMS::MRMFeatureFinderScoring::MRMTransitionGroupType *> & transition_group_map,
105  const OpenSwath::LightTargetedExperiment & targeted_exp,
106  const std::vector< OpenSwath::SwathMap > & swath_maps,
107  TransformationDescription & im_trafo);
108 
109  private:
112  bool ms1_im_;
118 
119  };
120 }
121 
OpenMS::SwathMapMassCorrection::mz_extraction_window_ppm_
bool mz_extraction_window_ppm_
Definition: SwathMapMassCorrection.h:111
OpenMS::SwathMapMassCorrection::im_correction_function_
String im_correction_function_
Definition: SwathMapMassCorrection.h:115
SwathMap.h
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenSwath::LightTargetedExperiment
Definition: TransitionExperiment.h:218
OpenMS::DefaultParamHandler
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:92
OpenMS::SwathMapMassCorrection::debug_im_file_
String debug_im_file_
Definition: SwathMapMassCorrection.h:116
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::SwathMapMassCorrection::ms1_im_
bool ms1_im_
Definition: SwathMapMassCorrection.h:112
MRMFeatureFinderScoring.h
OpenMS::SwathMapMassCorrection::debug_mz_file_
String debug_mz_file_
Definition: SwathMapMassCorrection.h:117
OpenMS::SwathMapMassCorrection::mz_correction_function_
String mz_correction_function_
Definition: SwathMapMassCorrection.h:114
OpenMS::SwathMapMassCorrection
A class containing correction functions for Swath MS maps.
Definition: SwathMapMassCorrection.h:52
OpenMS::TransformationDescription
Generic description of a coordinate transformation.
Definition: TransformationDescription.h:62
OpenMS::SwathMapMassCorrection::mz_extraction_window_
double mz_extraction_window_
Definition: SwathMapMassCorrection.h:110
OpenMS::SwathMapMassCorrection::im_extraction_window_
double im_extraction_window_
Definition: SwathMapMassCorrection.h:113