OpenMS
ModificationDefinitionsSet.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: Timo Sachsenberg $
32 // $Authors: $
33 // --------------------------------------------------------------------------
34 //
35 
36 #pragma once
37 
40 #include <OpenMS/CONCEPT/Types.h> // for "UInt"
42 #include <OpenMS/DATASTRUCTURES/ListUtils.h> // for "StringList"
45 
46 #include <set>
47 
48 namespace OpenMS
49 {
58  class OPENMS_DLLAPI ModificationDefinitionsSet
59  {
60 public:
61 
67 
70 
72  ModificationDefinitionsSet(const StringList& fixed_modifications, const StringList& variable_modifications);
73 
77 
82  void setMaxModifications(Size max_mod);
83 
86 
89 
92 
95 
98 
100  void setModifications(const std::set<ModificationDefinition>& mod_defs);
101 
108  void setModifications(const String& fixed_modifications, const String& variable_modifications);
109 
111  void setModifications(const StringList& fixed_modifications, const StringList& variable_modifications);
112 
114  std::set<ModificationDefinition> getModifications() const;
115 
117  const std::set<ModificationDefinition>& getFixedModifications() const;
118 
120  const std::set<ModificationDefinition>& getVariableModifications() const;
121 
123  std::set<String> getModificationNames() const;
124 
126  void getModificationNames(StringList& fixed_modifications, StringList& variable_modifications) const;
127 
129  std::set<String> getFixedModificationNames() const;
130 
132  std::set<String> getVariableModificationNames() const;
134 
141 
146  bool isCompatible(const AASequence& peptide) const;
147 
149  bool operator==(const ModificationDefinitionsSet& rhs) const;
150 
152  bool operator!=(const ModificationDefinitionsSet& rhs) const;
154 
169  void findMatches(std::multimap<double, ModificationDefinition>& matches, double mass, const String& residue = "", ResidueModification::TermSpecificity term_spec = ResidueModification::NUMBER_OF_TERM_SPECIFICITY, bool consider_fixed = true, bool consider_variable = true, bool is_delta = true, double tolerance = 0.01) const;
170 
172  void inferFromPeptides(const std::vector<PeptideIdentification>& peptides);
173 
174 protected:
175 
176  std::set<ModificationDefinition> variable_mods_;
177 
178  std::set<ModificationDefinition> fixed_mods_;
179 
181 
183  static void addMatches_(std::multimap<double, ModificationDefinition>& matches, double mass, const String& residue, ResidueModification::TermSpecificity term_spec, const std::set<ModificationDefinition>& source, bool is_delta, double tolerance);
184 
185  };
186 
187 } // namespace OpenMS
188 
Representation of a peptide/protein sequence.
Definition: AASequence.h:112
Representation of modification definition.
Definition: ModificationDefinition.h:53
Representation of a set of modification definitions.
Definition: ModificationDefinitionsSet.h:59
Size getNumberOfModifications() const
returns the number of modifications stored in this set
bool operator==(const ModificationDefinitionsSet &rhs) const
equality operator
void setModifications(const StringList &fixed_modifications, const StringList &variable_modifications)
same as above, but using StringList instead of comma separated strings
Size max_mods_per_peptide_
Definition: ModificationDefinitionsSet.h:180
bool isCompatible(const AASequence &peptide) const
returns true if the peptide is compatible with the definitions, e.g. does not contain other modificat...
std::set< String > getFixedModificationNames() const
returns only the names of the fixed modifications
std::set< String > getVariableModificationNames() const
returns only the names of the variable modifications
virtual ~ModificationDefinitionsSet()
destructor
ModificationDefinitionsSet()
default constructor
std::set< String > getModificationNames() const
returns only the names of the modifications stored in the set
void setModifications(const std::set< ModificationDefinition > &mod_defs)
sets the modification definitions
void inferFromPeptides(const std::vector< PeptideIdentification > &peptides)
Infers the sets of defined modifications from the modifications present on peptide identifications.
Size getNumberOfVariableModifications() const
returns the number of variable modifications stored in this set
static void addMatches_(std::multimap< double, ModificationDefinition > &matches, double mass, const String &residue, ResidueModification::TermSpecificity term_spec, const std::set< ModificationDefinition > &source, bool is_delta, double tolerance)
helper function for findMatches() - finds matching modifications in source and adds them to matches
const std::set< ModificationDefinition > & getFixedModifications() const
returns the stored fixed modification definitions
ModificationDefinitionsSet(const StringList &fixed_modifications, const StringList &variable_modifications)
detailed constructor with StringLists
void getModificationNames(StringList &fixed_modifications, StringList &variable_modifications) const
populates the output lists with the modification names (use e.g. for ProteinIdentification::SearchPar...
Size getMaxModifications() const
return the maximal number of modifications allowed per peptide
const std::set< ModificationDefinition > & getVariableModifications() const
returns the stored variable modification definitions
bool operator!=(const ModificationDefinitionsSet &rhs) const
inequality operator
std::set< ModificationDefinition > fixed_mods_
Definition: ModificationDefinitionsSet.h:178
void findMatches(std::multimap< double, ModificationDefinition > &matches, double mass, const String &residue="", ResidueModification::TermSpecificity term_spec=ResidueModification::NUMBER_OF_TERM_SPECIFICITY, bool consider_fixed=true, bool consider_variable=true, bool is_delta=true, double tolerance=0.01) const
Finds modifications in the set that match a given (delta) mass.
void setModifications(const String &fixed_modifications, const String &variable_modifications)
set the modification definitions from a string
Size getNumberOfFixedModifications() const
returns the number of fixed modifications stored in this set
void addModification(const ModificationDefinition &mod_def)
adds a modification definition to the set
std::set< ModificationDefinition > getModifications() const
returns the stored modification definitions
std::set< ModificationDefinition > variable_mods_
Definition: ModificationDefinitionsSet.h:176
ModificationDefinitionsSet & operator=(const ModificationDefinitionsSet &element)
assignment operator
void setMaxModifications(Size max_mod)
sets the maximal number of modifications allowed per peptide
ModificationDefinitionsSet(const ModificationDefinitionsSet &rhs)
copy constructor
TermSpecificity
Position where the modification is allowed to occur.
Definition: ResidueModification.h:98
@ NUMBER_OF_TERM_SPECIFICITY
Definition: ResidueModification.h:104
A more convenient string class.
Definition: String.h:60
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:70
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48