OpenMS
LayerData1DChrom.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  class OPENMS_GUI_DLLAPI LayerData1DChrom : public LayerDataChrom, public LayerData1DBase
43  {
44  public:
45  LayerData1DChrom() : LayerDataBase(DT_CHROMATOGRAM)
46  {
47  }
48 
50  {
51  }
52 
53  std::unique_ptr<LayerStoreData> storeVisibleData(const RangeAllType& visible_range, const DataFilters& layer_filters) const override;
54  std::unique_ptr<LayerStoreData> storeFullData() const override;
55 
56  std::unique_ptr<Painter1DBase> getPainter1D() const override;
57 
58  bool hasIndex(Size index) const override
59  {
60  return index < chromatogram_map_->getNrChromatograms();
61  }
62 
63  RangeAllType getRangeForArea(const RangeAllType partial_range) const override
64  {
65  const auto& chrom = getCurrentChrom();
66  auto chrom_filtered = MSExperiment::ChromatogramType();
67  chrom_filtered.insert(chrom_filtered.begin(), chrom.RTBegin(partial_range.getMinRT()), chrom.RTEnd(partial_range.getMaxRT()));
68  chrom_filtered.updateRanges();
69  return RangeAllType().assign(chrom_filtered.getRange());
70  }
71 
72  RangeAllType getRange1D() const override
73  {
74  return RangeAllType().assign(getCurrentChrom().getRange());
75  }
76 
78  {
79  return getChromatogram(current_idx_);
80  }
81 
82  void updateRanges() override
83  {
85  }
86 
87  RangeAllType getRange() const override
88  {
89  // do NOT change the behaviour of getRange() for 1D, since we want the full RT range across all chroms
90  // when scrolling in the list of chroms
91  return LayerDataChrom::getRange();
92  }
93 
94  // docu in base class
95  QMenu* getContextMenuAnnotation(Annotation1DItem* annot_item, bool& need_repaint) override;
96 
97  PeakIndex findClosestDataPoint(const RangeAllType& area) const override;
98 
99  // docu in base class
100  Annotation1DItem* addPeakAnnotation(const PeakIndex& peak_index, const QString& text, const QColor& color) override;
101 
102  protected:
104  //ExperimentType::SpectrumType cached_spectrum_;
105  };
106 
107 } // namespace OpenMS
An abstract class acting as an interface for the different 1D annotation items.
Definition: Annotation1DItem.h:62
DataFilter array providing some convenience functions.
Definition: DataFilters.h:53
Base class for all 1D layers, a special case of LayerData.
Definition: LayerData1DBase.h:54
Definition: LayerData1DChrom.h:43
RangeAllType getRangeForArea(const RangeAllType partial_range) const override
Given a partial_range for the current 1D layer (e.g. an m/z range), fill in the other dimensions (usu...
Definition: LayerData1DChrom.h:63
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< Painter1DBase > getPainter1D() const override
Obtain a painter which can draw the layer on a canvas.
QMenu * getContextMenuAnnotation(Annotation1DItem *annot_item, bool &need_repaint) override
Get a context menu (with lambda actions included) for this 1D layer, when a Annotation1DItem was righ...
RangeAllType getRange() const override
Definition: LayerData1DChrom.h:87
LayerData1DChrom(const LayerDataChrom &base)
Definition: LayerData1DChrom.h:49
bool hasIndex(Size index) const override
Does the layer have at least index items (e.g. spectra, chroms, etc), so a call to setCurrentIndex() ...
Definition: LayerData1DChrom.h:58
PeakIndex findClosestDataPoint(const RangeAllType &area) const override
Find the closest datapoint within the given range and return a proxy to that datapoint.
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.
LayerData1DChrom()
Definition: LayerData1DChrom.h:45
void updateRanges() override
Update ranges of the underlying data.
Definition: LayerData1DChrom.h:82
const ExperimentType::ChromatogramType & getCurrentChrom() const
Definition: LayerData1DChrom.h:77
Annotation1DItem * addPeakAnnotation(const PeakIndex &peak_index, const QString &text, const QColor &color) override
Add a Annotation1DPeakItem to getCurrentAnnotations(). The specific type is determined by the derived...
RangeAllType getRange1D() const override
Definition: LayerData1DChrom.h:72
Class that stores the data for one layer.
Definition: LayerDataBase.h:195
Class that stores the data for one layer of type Chromatogram.
Definition: LayerDataChrom.h:50
RangeAllType getRange() const override
Definition: LayerDataChrom.h:76
void updateRanges() override
Update ranges of the underlying data.
Definition: LayerDataChrom.h:71
The representation of a chromatogram.
Definition: MSChromatogram.h:57
MSChromatogram ChromatogramType
Chromatogram type.
Definition: MSExperiment.h:95
auto & assign(const RangeManager< RangeBasesOther... > &rhs)
Definition: RangeManager.h:612
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48
RangeManager< RangeRT, RangeMZ, RangeIntensity, RangeMobility > RangeAllType
Range which contains all known dimensions.
Definition: RangeManager.h:923
Index of a peak or feature.
Definition: PeakIndex.h:51