OpenMS
LayerDataIdent.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: Chris Bielow $
32 // $Authors: Chris Bielow $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
39 
40 namespace OpenMS
41 {
42 
48  class OPENMS_GUI_DLLAPI LayerDataIdent : public LayerDataBase, public IPeptideIds
49  {
50  public:
53  LayerDataBase(LayerDataBase::DT_IDENT){};
55  LayerDataIdent(const LayerDataIdent& ld) = delete;
57  LayerDataIdent& operator=(const LayerDataIdent& ld) = delete;
58 
59  std::unique_ptr<Painter2DBase> getPainter2D() const override;
60 
61  std::unique_ptr<LayerData1DBase> to1DLayer() const override
62  {
63  throw Exception::NotImplemented(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION);
64  }
65 
66  std::unique_ptr<LayerStoreData> storeVisibleData(const RangeAllType& visible_range, const DataFilters& layer_filters) const override;
67 
68  std::unique_ptr<LayerStoreData> storeFullData() const override;
69 
70  ProjectionData getProjection(const DIM_UNIT unit_x, const DIM_UNIT unit_y, const RangeAllType& area) const override;
71 
72  PeakIndex findHighestDataPoint(const RangeAllType& /*area*/) const override
73  { // todo: not implemented
74  return PeakIndex();
75  }
76 
77  PointXYType peakIndexToXY(const PeakIndex& peak, const DimMapper<2>& mapper) const override;
78 
79 
80  void updateRanges() override
81  {
82  // nothing to do...
83  }
84 
85  RangeAllType getRange() const override
86  {
87  RangeAllType r;
88  for (const PeptideIdentification& pep : peptides_)
89  {
90  r.extendRT(pep.getRT());
91  r.extendMZ(pep.getMZ());
92  }
93  return r;
94  }
95 
96  std::unique_ptr<LayerStatistics> getStats() const override;
97 
98  virtual const PepIds& getPeptideIds() const override
99  {
100  return peptides_;
101  }
102  virtual PepIds& getPeptideIds() override
103  {
104  return peptides_;
105  }
106 
107  virtual void setPeptideIds(const PepIds& ids) override
108  {
109  peptides_ = ids;
110  }
111  virtual void setPeptideIds(PepIds&& ids) override
112  {
113  peptides_ = std::move(ids);
114  }
115 
116  private:
118  std::vector<PeptideIdentification> peptides_;
119  };
120 
121 }// namespace OpenMS
DataFilter array providing some convenience functions.
Definition: DataFilters.h:53
Not implemented exception.
Definition: Exception.h:430
Abstract base class which defines an interface for PeptideIdentifications.
Definition: IPeptideIds.h:49
std::vector< PeptideIdentification > PepIds
Definition: IPeptideIds.h:51
Class that stores the data for one layer.
Definition: LayerDataBase.h:195
Class that stores the data for one layer of type PeptideIdentifications.
Definition: LayerDataIdent.h:49
LayerDataIdent()
Default constructor.
Definition: LayerDataIdent.h:52
std::unique_ptr< LayerStatistics > getStats() const override
Compute layer statistics (via visitor)
virtual void setPeptideIds(const PepIds &ids) override
overwrite the peptide IDs for this layer
Definition: LayerDataIdent.h:107
virtual void setPeptideIds(PepIds &&ids) override
Definition: LayerDataIdent.h:111
std::unique_ptr< LayerStoreData > storeFullData() const override
Returns a visitor which contains the the full data of the layer and can write the data to disk in the...
std::unique_ptr< LayerData1DBase > to1DLayer() const override
Create a shallow copy (i.e. shared experimental data using shared_ptr) of the current layer,...
Definition: LayerDataIdent.h:61
PointXYType peakIndexToXY(const PeakIndex &peak, const DimMapper< 2 > &mapper) const override
Convert a PeakIndex to a XY coordinate (via mapper).
LayerDataIdent & operator=(const LayerDataIdent &ld)=delete
no assignment operator (should not be needed)
LayerDataIdent(const LayerDataIdent &ld)=delete
no Copy-ctor (should not be needed)
ProjectionData getProjection(const DIM_UNIT unit_x, const DIM_UNIT unit_y, const RangeAllType &area) const override
RangeAllType getRange() const override
Definition: LayerDataIdent.h:85
virtual const PepIds & getPeptideIds() const override
get the peptide IDs for this layer
Definition: LayerDataIdent.h:98
std::unique_ptr< LayerStoreData > storeVisibleData(const RangeAllType &visible_range, const DataFilters &layer_filters) const override
Returns a visitor which contains the current visible data and can write the data to disk.
PeakIndex findHighestDataPoint(const RangeAllType &) const override
Find the datapoint with the highest intensity within the given range and return a proxy to that datap...
Definition: LayerDataIdent.h:72
virtual PepIds & getPeptideIds() override
Definition: LayerDataIdent.h:102
std::vector< PeptideIdentification > peptides_
peptide identifications
Definition: LayerDataIdent.h:118
std::unique_ptr< Painter2DBase > getPainter2D() const override
Obtain a painter which can draw the layer on a 2D canvas.
void updateRanges() override
Update ranges of the underlying data.
Definition: LayerDataIdent.h:80
Represents the peptide hits for a spectrum.
Definition: PeptideIdentification.h:65
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48
DIM_UNIT
Definition: CommonEnums.h:46
Result of computing a projection on X and Y axis in a 2D Canvas; see LayerDataBase::getProjection()
Definition: LayerDataBase.h:77
Index of a peak or feature.
Definition: PeakIndex.h:51