OpenMS
LayerDataIonMobility.h
Go to the documentation of this file.
1 // Copyright (c) 2002-present, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
2 // SPDX-License-Identifier: BSD-3-Clause
3 //
4 // --------------------------------------------------------------------------
5 // $Maintainer: Chris Bielow $
6 // $Authors: Chris Bielow $
7 // --------------------------------------------------------------------------
8 
9 #pragma once
10 
13 
15 
16 namespace OpenMS
17 {
18 
27  class OPENMS_GUI_DLLAPI LayerDataIonMobility : public virtual LayerDataBase
28  {
29  public:
31 
38 
39 
40  std::unique_ptr<Painter2DBase> getPainter2D() const override;
41 
42  std::unique_ptr<LayerData1DBase> to1DLayer() const override;
43 
44  std::unique_ptr<LayerStoreData> storeVisibleData(const RangeAllType& visible_range, const DataFilters& layer_filters) const override;
45 
46  std::unique_ptr<LayerStoreData> storeFullData() const override;
47 
48  ProjectionData getProjection(const DIM_UNIT unit_x, const DIM_UNIT unit_y, const RangeAllType& area) const override;
49 
50  PeakIndex findHighestDataPoint(const RangeAllType& /*area*/) const override
51  { // todo: not implemented
52  return PeakIndex();
53  }
54 
55  void updateRanges() override
56  {
57  single_mobilogram_.updateRanges();
58  // on_disc_peaks->updateRanges(); // note: this is not going to work since its on disk! We currently don't have a good way to access these ranges
59  }
60 
61  RangeAllType getRange() const override
62  {
63  RangeAllType r;
64  r.assign(single_mobilogram_);
65  return r;
66  }
67 
68  // for now, only a single Mobilogram. See class description.
69  void setMobilityData(const Mobilogram& mobilogram)
70  {
71  single_mobilogram_ = mobilogram;
72  }
73 
74  const Mobilogram& getMobilogram(Size index) const
75  {
76  if (index != 0) throw Exception::InvalidValue(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, "Only one mobilogram possible atm.", String(index));
77  return single_mobilogram_;
78  }
79 
80  PointXYType peakIndexToXY(const PeakIndex& peak, const DimMapper<2>& mapper) const override;
81 
82  String getDataArrayDescription(const PeakIndex& peak_index) override;
83 
84  std::unique_ptr<LayerStatistics> getStats() const override;
85 
86  protected:
88  };
89 
90 }// namespace OpenMS
DataFilter array providing some convenience functions.
Definition: DataFilters.h:27
Invalid value exception.
Definition: Exception.h:305
Class that stores the data for one layer.
Definition: LayerDataBase.h:169
Class that stores the data for one layer of type IonMobility.
Definition: LayerDataIonMobility.h:28
std::unique_ptr< LayerStatistics > getStats() const override
Compute layer statistics (via visitor)
LayerDataIonMobility(const LayerDataIonMobility &ld)
Copy-ctor.
const Mobilogram & getMobilogram(Size index) const
Definition: LayerDataIonMobility.h:74
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...
void setMobilityData(const Mobilogram &mobilogram)
Definition: LayerDataIonMobility.h:69
std::unique_ptr< LayerData1DBase > to1DLayer() const override
Create a shallow copy (i.e. shared experimental data using shared_ptr) of the current layer,...
PointXYType peakIndexToXY(const PeakIndex &peak, const DimMapper< 2 > &mapper) const override
Convert a PeakIndex to a XY coordinate (via mapper).
ProjectionData getProjection(const DIM_UNIT unit_x, const DIM_UNIT unit_y, const RangeAllType &area) const override
LayerDataIonMobility & operator=(const LayerDataIonMobility &ld)=delete
no assignment operator (should not be needed)
RangeAllType getRange() const override
Definition: LayerDataIonMobility.h:61
Mobilogram single_mobilogram_
a single mobilogram (for now) – see class description
Definition: LayerDataIonMobility.h:87
LayerDataIonMobility()
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.
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: LayerDataIonMobility.h:50
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: LayerDataIonMobility.h:55
String getDataArrayDescription(const PeakIndex &peak_index) override
Get name and value of all data-arrays corresponding to the given datapoint.
A 1-dimensional raw data mobility point or peak. The unit (ms, 1/K_0, etc) is implicit.
Definition: MobilityPeak1D.h:25
The representation of a 1D ion mobilogram.
Definition: Mobilogram.h:29
MobilityPeak1D PeakType
Peak type.
Definition: Mobilogram.h:40
auto & assign(const RangeManager< RangeBasesOther... > &rhs)
Definition: RangeManager.h:593
A more convenient string class.
Definition: String.h:34
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:97
Main OpenMS namespace.
Definition: openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19
DIM_UNIT
Definition: CommonEnums.h:20
Result of computing a projection on X and Y axis in a 2D Canvas; see LayerDataBase::getProjection()
Definition: LayerDataBase.h:51
Index of a peak or feature.
Definition: PeakIndex.h:25