OpenMS
RNPxlModificationsGenerator.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: Timo Sachsenberg $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
41 #include <vector>
42 #include <map>
43 #include <set>
44 
45 namespace OpenMS
46 {
47  class AASequence;
48 
49  struct OPENMS_DLLAPI RNPxlModificationMassesResult
50  {
51  std::map<String, double> mod_masses;
52  std::map<String, std::set<String> > mod_combinations;
53  };
54 
55  class OPENMS_DLLAPI RNPxlModificationsGenerator
56  {
57  public:
59  const StringList& nt_groups,
60  const std::set<char>& can_xl,
61  const StringList& mappings,
62  const StringList& modifications,
63  String sequence_restriction,
64  bool cysteine_adduct,
65  Int max_length = 4);
66  private:
67  static bool notInSeq(const String& res_seq, const String& query);
68  static void generateTargetSequences(const String& res_seq, Size param_pos, const std::map<char, std::vector<char> >& map_source2target, StringList& target_sequences);
69  };
70 }
71 
72 
Definition: RNPxlModificationsGenerator.h:56
static void generateTargetSequences(const String &res_seq, Size param_pos, const std::map< char, std::vector< char > > &map_source2target, StringList &target_sequences)
static RNPxlModificationMassesResult initModificationMassesRNA(const StringList &target_nucleotides, const StringList &nt_groups, const std::set< char > &can_xl, const StringList &mappings, const StringList &modifications, String sequence_restriction, bool cysteine_adduct, Int max_length=4)
static bool notInSeq(const String &res_seq, const String &query)
A more convenient string class.
Definition: String.h:60
int Int
Signed integer type.
Definition: Types.h:102
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
std::map< String, double > mod_masses
empirical formula -> mass
Definition: RNPxlModificationsGenerator.h:51
std::map< String, std::set< String > > mod_combinations
empirical formula -> nucleotide formula(s) (formulas if modifications lead to ambiguities)
Definition: RNPxlModificationsGenerator.h:52
Definition: RNPxlModificationsGenerator.h:50