OpenMS
MetaboTargetedTargetDecoy.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-2023.
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 
39 
40 
41 namespace OpenMS
42 {
43 
49  class OPENMS_DLLAPI MetaboTargetedTargetDecoy
50  {
51  public:
57  {
58  public:
59 
63  std::vector<double> target_product_masses;
64  std::vector<double> decoy_product_masses;
65  };
66 
73  static std::vector<MetaboTargetDecoyMassMapping> constructTargetDecoyMassMapping(const TargetedExperiment& t_exp);
74 
83  static void resolveOverlappingTargetDecoyMassesByIndividualMassShift(TargetedExperiment& t_exp, std::vector<MetaboTargetedTargetDecoy::MetaboTargetDecoyMassMapping>& mappings, const double& mass_to_add);
84 
93  static void generateMissingDecoysByMassShift(TargetedExperiment& t_exp, std::vector<MetaboTargetedTargetDecoy::MetaboTargetDecoyMassMapping>& mappings, const double& mass_to_add);
94 
95  protected:
101  static std::map<String, std::vector<OpenMS::ReactionMonitoringTransition> > constructTransitionsMap_(const TargetedExperiment& t_exp);
102  };
103 
104 } // namespace OpenMS
Resolve overlapping fragments and missing decoys for experimental specific decoy generation in target...
Definition: MetaboTargetedTargetDecoy.h:50
String target_compound_ref
> unique identifier (e.g. m_id)
Definition: MetaboTargetedTargetDecoy.h:61
std::vector< double > target_product_masses
> identifier which allows to reference back to the decoy (e.g. decoy_transitions_id)
Definition: MetaboTargetedTargetDecoy.h:63
static std::map< String, std::vector< OpenMS::ReactionMonitoringTransition > > constructTransitionsMap_(const TargetedExperiment &t_exp)
Generate a TransitionMap based on Compound_Ref and ReactionMonitoringTransitions.
String decoy_compound_ref
> identifier which allows to reference back to the target (e.g. target_transitions_id)
Definition: MetaboTargetedTargetDecoy.h:62
static void generateMissingDecoysByMassShift(TargetedExperiment &t_exp, std::vector< MetaboTargetedTargetDecoy::MetaboTargetDecoyMassMapping > &mappings, const double &mass_to_add)
Generate a decoy for targets where fragmentation tree re-rooting was not possible,...
std::vector< double > decoy_product_masses
> masses of target transitions
Definition: MetaboTargetedTargetDecoy.h:64
String identifier
Definition: MetaboTargetedTargetDecoy.h:60
static void resolveOverlappingTargetDecoyMassesByIndividualMassShift(TargetedExperiment &t_exp, std::vector< MetaboTargetedTargetDecoy::MetaboTargetDecoyMassMapping > &mappings, const double &mass_to_add)
Resolves overlapping target and decoy transition masses by adding a specifiable mass (e....
static std::vector< MetaboTargetDecoyMassMapping > constructTargetDecoyMassMapping(const TargetedExperiment &t_exp)
Constructs a mass mapping of targets and decoys using the unique m_id identifier.
MetaboTargetDecoyMassMapping introduces a mapping of target and decoy masses and their respective com...
Definition: MetaboTargetedTargetDecoy.h:57
A more convenient string class.
Definition: String.h:60
A description of a targeted experiment containing precursor and production ions.
Definition: TargetedExperiment.h:65
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48