OpenMS  2.4.0
TOPPViewIdentificationViewBehavior.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-2018.
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 
37 // #include <OpenMS/CHEMISTRY/NASequence.h>
40 #include <vector>
41 
42 namespace OpenMS
43 {
44  class TOPPViewBase;
45 
50  : public QObject
51  {
52  Q_OBJECT
54 
55  //Feature map type
57  //Feature map managed type
59 
60  //Consensus feature map type
62  //Consensus map managed type
64 
65  //Peak map type
67  //Main managed data type (experiment)
72 
73  public:
76 
77  public slots:
79  virtual void showSpectrumAs1D(int spectrum_index, int peptide_id_index, int peptide_hit_index);
80 
82  virtual void showSpectrumAs1D(int index);
83 
85  virtual void activate1DSpectrum(int spectrum_index, int peptide_id_index, int peptide_hit_index);
86 
88  virtual void activate1DSpectrum(int index);
89 
91  virtual void deactivate1DSpectrum(int index);
92 
94  virtual void activateBehavior();
95 
97  virtual void deactivateBehavior();
98 
99  void setVisibleArea1D(double l, double h);
100 
101  private:
103  void addPrecursorLabels1D_(const std::vector<Precursor>& pcs);
104 
106  void removeTemporaryAnnotations_(Size spectrum_index);
107 
110 
112  void addPeakAnnotationsFromID_(const PeptideHit& hit);
113 
116 
118  void removeGraphicalPeakAnnotations_(int spectrum_index);
119 
121  void addPeakAnnotations_(const std::vector<PeptideIdentification>& ph);
122 
124  String n_times(Size n, String input);
125 
127  void extractCoverageStrings(std::vector<PeptideHit::PeakAnnotation> frag_annotations, String& alpha_string, String& beta_string, Size alpha_size, Size beta_size);
128 
130  template <typename SeqType>
131  String generateSequenceDiagram_(const SeqType& seq, const std::vector<PeptideHit::PeakAnnotation>& annotations, const StringList& top_ions, const StringList& bottom_ions);
132 
134  void generateSequenceRow_(const AASequence& seq, std::vector<String>& row);
135 
136 /*
138  void generateSequenceRow_(const NASequence& seq, std::vector<String>& row);
139 */
140 
142  String collapseStringVector(std::vector<String> strings);
143 
144  private:
148  std::vector<Annotation1DItem*> temporary_annotations_;
149  };
150 }
boost::shared_ptr< FeatureMap > FeatureMapSharedPtrType
SharedPtr on feature map.
Definition: LayerData.h:135
void removeTheoreticalSpectrumLayer_()
removes all layer with theoretical spectrum generated in identification view
Behavior of TOPPView in identification mode.
Definition: TOPPViewIdentificationViewBehavior.h:49
A more convenient string class.
Definition: String.h:57
LayerData::FeatureMapSharedPtrType FeatureMapSharedPtrType
Definition: TOPPViewIdentificationViewBehavior.h:58
Main window of TOPPView tool.
Definition: TOPPViewBase.h:124
A container for features.
Definition: FeatureMap.h:93
void addPeakAnnotationsFromID_(const PeptideHit &hit)
Add peak annotatios from id data structure.
virtual void deactivate1DSpectrum(int index)
Behavior for deactivate1DSpectrum.
A container for consensus elements.
Definition: ConsensusMap.h:75
Representation of a peptide/protein sequence.
Definition: AASequence.h:107
String collapseStringVector(std::vector< String > strings)
Helper function, that collapses a vector of Strings into one String.
virtual void deactivateBehavior()
Slot for behavior deactivation.
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
String generateSequenceDiagram_(const SeqType &seq, const std::vector< PeptideHit::PeakAnnotation > &annotations, const StringList &top_ions, const StringList &bottom_ions)
Generates HTML for showing the sequence with annotations of matched fragments.
boost::shared_ptr< ExperimentType > ExperimentSharedPtrType
SharedPtr on MSExperiment.
Definition: LayerData.h:147
void setVisibleArea1D(double l, double h)
TOPPViewIdentificationViewBehavior(TOPPViewBase *parent)
Construct the behaviour with its parent.
LayerData::ExperimentSharedPtrType ExperimentSharedPtrType
Definition: TOPPViewIdentificationViewBehavior.h:68
void extractCoverageStrings(std::vector< PeptideHit::PeakAnnotation > frag_annotations, String &alpha_string, String &beta_string, Size alpha_size, Size beta_size)
Helper function that turns fragment annotations into coverage Strings for visualization with the sequ...
LayerData::FeatureMapType FeatureMapType
Definition: TOPPViewIdentificationViewBehavior.h:56
virtual void showSpectrumAs1D(int spectrum_index, int peptide_id_index, int peptide_hit_index)
Behavior for showSpectrumAs1D.
void addPeakAnnotations_(const std::vector< PeptideIdentification > &ph)
Adds annotation (compound name, adducts, ppm error) to a peak in 1D spectra.
The representation of a 1D spectrum.
Definition: MSSpectrum.h:66
Representation of a peptide hit.
Definition: PeptideHit.h:54
boost::shared_ptr< ConsensusMap > ConsensusMapSharedPtrType
SharedPtr on consensus features.
Definition: LayerData.h:141
void generateSequenceRow_(const AASequence &seq, std::vector< String > &row)
Helper function for generateSequenceDiagram_() - overload for peptides.
const double h
String n_times(Size n, String input)
Helper function for text formatting.
void addTheoreticalSpectrumLayer_(const PeptideHit &ph)
Adds a theoretical spectrum as set from the preferences dialog for the peptide hit.
ExperimentType::SpectrumType SpectrumType
Peak spectrum type.
Definition: TOPPViewIdentificationViewBehavior.h:70
void removeGraphicalPeakAnnotations_(int spectrum_index)
remove all graphical peak annotations
std::vector< Annotation1DItem * > temporary_annotations_
Definition: TOPPViewIdentificationViewBehavior.h:148
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:73
In-Memory representation of a mass spectrometry experiment.
Definition: MSExperiment.h:77
virtual void activate1DSpectrum(int spectrum_index, int peptide_id_index, int peptide_hit_index)
Behavior for activate1DSpectrum.
LayerData::ConsensusMapType ConsensusMapType
Definition: TOPPViewIdentificationViewBehavior.h:61
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127
virtual void activateBehavior()
Slot for behavior activation.
LayerData::ConsensusMapSharedPtrType ConsensusMapSharedPtrType
Definition: TOPPViewIdentificationViewBehavior.h:63
TOPPViewBase * tv_
Definition: TOPPViewIdentificationViewBehavior.h:145
LayerData::ExperimentType ExperimentType
Definition: TOPPViewIdentificationViewBehavior.h:66
void addPrecursorLabels1D_(const std::vector< Precursor > &pcs)
Adds labels for the provided precursors to the 1D spectrum.
void removeTemporaryAnnotations_(Size spectrum_index)
Removes the precursor labels for from the specified 1D spectrum.