OpenMS  3.0.0
FeatureMapping.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: Oliver Alka $
32 // $Authors: Oliver Alka $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
41 
42 namespace OpenMS
43 {
44 
45  class OPENMS_DLLAPI FeatureMapping
46  {
47  public:
48 
51  {
52  public:
53  std::vector<FeatureMap> feature_maps; // feature data
54  KDTreeFeatureMaps kd_tree; // KDTree references into feature_maps to provides fast spatial queries
55  };
56 
59  {
60  public:
61  std::map<const BaseFeature*, std::vector<size_t>> assignedMS2;
62  std::vector<size_t> unassignedMS2;
63  };
64 
77  static FeatureToMs2Indices assignMS2IndexToFeature(const MSExperiment& spectra,
78  const FeatureMappingInfo& fm_info,
79  const double& precursor_mz_tolerance,
80  const double& precursor_rt_tolerance,
81  bool ppm);
82 
83  };
84 } // namespace OpenMS
OpenMS::FeatureMapping::FeatureToMs2Indices::unassignedMS2
std::vector< size_t > unassignedMS2
Definition: FeatureMapping.h:62
KDTreeFeatureMaps.h
OpenMS::MSExperiment
In-Memory representation of a mass spectrometry run.
Definition: MSExperiment.h:70
OpenMS::FeatureMapping::FeatureToMs2Indices
Stores preprocessed feature mapping information.
Definition: FeatureMapping.h:58
OpenMS::FeatureMapping::FeatureMappingInfo::kd_tree
KDTreeFeatureMaps kd_tree
Definition: FeatureMapping.h:54
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::FeatureMapping::FeatureMappingInfo::feature_maps
std::vector< FeatureMap > feature_maps
Definition: FeatureMapping.h:53
BaseFeature.h
FeatureMap.h
MSExperiment.h
OpenMS::FeatureMapping::FeatureToMs2Indices::assignedMS2
std::map< const BaseFeature *, std::vector< size_t > > assignedMS2
Definition: FeatureMapping.h:61
OpenMS::FeatureMapping
Definition: FeatureMapping.h:45
OpenMS::KDTreeFeatureMaps
Stores a set of features, together with a 2D tree for fast search.
Definition: KDTreeFeatureMaps.h:49
OpenMS::FeatureMapping::FeatureMappingInfo
Stores information required for preprocessing.
Definition: FeatureMapping.h:50