OpenMS
LayerDataFeature.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 LayerDataFeature : public virtual LayerDataBase, public IPeptideIds
49  {
50  public:
54  LayerDataFeature(const LayerDataFeature& ld) = delete;
57 
58  std::unique_ptr<Painter2DBase> getPainter2D() const override;
59 
60  std::unique_ptr<LayerData1DBase> to1DLayer() const override
61  {
62  throw Exception::NotImplemented(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION);
63  }
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  { // currently only a stub
72  ProjectionData proj;
73  return proj;
74  }
75 
76  PeakIndex findHighestDataPoint(const RangeAllType& area) const override;
77 
78  PointXYType peakIndexToXY(const PeakIndex& peak, const DimMapper<2>& mapper) const override;
79 
80  void updateRanges() override
81  {
82  features_->updateRanges();
83  }
84 
85  RangeAllType getRange() const override
86  {
87  RangeAllType r;
88  r.assign(*getFeatureMap());
89  return r;
90  }
91 
92  std::unique_ptr<LayerStatistics> getStats() const override;
93 
94  bool annotate(const std::vector<PeptideIdentification>& identifications, const std::vector<ProteinIdentification>& protein_identifications) override;
95 
96  const PepIds& getPeptideIds() const override
97  {
98  return getFeatureMap()->getUnassignedPeptideIdentifications();
99  }
100  PepIds& getPeptideIds() override
101  {
102  return getFeatureMap()->getUnassignedPeptideIdentifications();
103  }
104 
105  void setPeptideIds(const PepIds& ids) override
106  {
107  getFeatureMap()->getUnassignedPeptideIdentifications() = ids;
108  }
109  void setPeptideIds(PepIds&& ids) override
110  {
111  getFeatureMap()->getUnassignedPeptideIdentifications() = std::move(ids);
112  }
113 
114 
117  {
118  return features_;
119  }
120 
123  {
124  return features_;
125  }
126 
127  protected:
130  };
131 
132 }// namespace OpenMS
DataFilter array providing some convenience functions.
Definition: DataFilters.h:53
Not implemented exception.
Definition: Exception.h:430
A container for features.
Definition: FeatureMap.h:106
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 FeatureMap.
Definition: LayerDataFeature.h:49
std::unique_ptr< LayerStatistics > getStats() const override
Compute layer statistics (via visitor)
LayerDataFeature & operator=(const LayerDataFeature &ld)=delete
no assignment operator (should not be needed)
void setPeptideIds(const PepIds &ids) override
overwrite the peptide IDs for this layer
Definition: LayerDataFeature.h:105
ProjectionData getProjection(const DIM_UNIT, const DIM_UNIT, const RangeAllType &) const override
Definition: LayerDataFeature.h:70
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...
PeakIndex findHighestDataPoint(const RangeAllType &area) const override
Find the datapoint with the highest intensity within the given range and return a proxy to that datap...
bool annotate(const std::vector< PeptideIdentification > &identifications, const std::vector< ProteinIdentification > &protein_identifications) override
const FeatureMapSharedPtrType & getFeatureMap() const
Returns a const reference to the current feature data.
Definition: LayerDataFeature.h:116
std::unique_ptr< LayerData1DBase > to1DLayer() const override
Create a shallow copy (i.e. shared experimental data using shared_ptr) of the current layer,...
Definition: LayerDataFeature.h:60
const PepIds & getPeptideIds() const override
get the peptide IDs for this layer
Definition: LayerDataFeature.h:96
PointXYType peakIndexToXY(const PeakIndex &peak, const DimMapper< 2 > &mapper) const override
Convert a PeakIndex to a XY coordinate (via mapper).
PepIds & getPeptideIds() override
Definition: LayerDataFeature.h:100
FeatureMapSharedPtrType & getFeatureMap()
Returns a const reference to the current feature data.
Definition: LayerDataFeature.h:122
RangeAllType getRange() const override
Definition: LayerDataFeature.h:85
void setPeptideIds(PepIds &&ids) override
Definition: LayerDataFeature.h:109
LayerDataFeature()
Default constructor.
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.
LayerDataFeature(const LayerDataFeature &ld)=delete
no Copy-ctor (should not be needed)
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: LayerDataFeature.h:80
auto & assign(const RangeManager< RangeBasesOther... > &rhs)
Definition: RangeManager.h:612
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
boost::shared_ptr< FeatureMap > FeatureMapSharedPtrType
SharedPtr on feature map.
Definition: LayerDataBase.h:140
Index of a peak or feature.
Definition: PeakIndex.h:51