OpenMS
Plot1DWidget.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: Timo Sachsenberg$
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 // OpenMS_GUI config
38 #include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
39 
40 // STL
41 #include <vector>
42 
43 // OpenMS
46 
47 class QAction;
48 class QSpacerItem;
49 
50 namespace OpenMS
51 {
52  class Plot1DCanvas;
53 
65  class OPENMS_GUI_DLLAPI Plot1DWidget :
66  public PlotWidget
67  {
68  Q_OBJECT
69 
70 public:
72  Plot1DWidget(const Param& preferences, const DIM gravity_axis = DIM::Y, QWidget* parent = nullptr);
74  ~Plot1DWidget() override;
75 
76  // docu in base class
77  Plot1DCanvas* canvas() const override
78  {
79  return static_cast<Plot1DCanvas*>(canvas_);
80  }
81 
82  // Docu in base class
83  void setMapper(const DimMapper<2>& mapper) override
84  {
85  canvas_->setMapper(mapper);
86  }
87 
88  // Docu in base class
89  void hideAxes() override;
90 
91  // Docu in base class
92  void showLegend(bool show) override;
93 
95  void toggleMirrorView(bool mirror);
96 
98  void performAlignment(Size layer_index_1, Size layer_index_2, const Param & param);
99 
102 
103  // Docu in base class
104  void saveAsImage() override;
105 
106  // Docu in base class
107  virtual void renderForImage(QPainter& painter);
108 
109 signals:
112 
115 
118 
120  void showCurrentPeaksAsDIA(const Precursor& pc, const MSExperiment& exp);
121 
122 public slots:
123  // Docu in base class
124  void showGoToDialog() override;
125 
126 protected:
127  // Docu in base class
128  void recalculateAxes_() override;
129 
132 
134  QSpacerItem * spacer_;
135 
136  };
137 } // namespace OpenMS
138 
Widget that represents an axis of a graph.
Definition: AxisWidget.h:65
In-Memory representation of a mass spectrometry run.
Definition: MSExperiment.h:72
The representation of a 1D spectrum.
Definition: MSSpectrum.h:70
Management and storage of parameters / INI files.
Definition: Param.h:70
Canvas for visualization of one or several spectra.
Definition: Plot1DCanvas.h:321
Widget for visualization of several spectra.
Definition: Plot1DWidget.h:67
void recalculateAxes_() override
recalculates the Axis ticks
AxisWidget * flipped_y_axis_
The second y-axis for the mirror view.
Definition: Plot1DWidget.h:131
QSpacerItem * spacer_
Spacer between the two y-axes in mirror mode (needed when visualizing an alignment)
Definition: Plot1DWidget.h:134
Plot1DWidget(const Param &preferences, const DIM gravity_axis=DIM::Y, QWidget *parent=nullptr)
Default constructor.
void showCurrentPeaksAs2D()
Requests to display the whole spectrum in 2D view.
void showCurrentPeaksAsIonMobility(const MSSpectrum &spec)
Requests to display the whole spectrum in ion mobility view.
void setMapper(const DimMapper< 2 > &mapper) override
Set a new mapper for the canvas and axis. Internally, all dependent components are updated (e....
Definition: Plot1DWidget.h:83
void toggleMirrorView(bool mirror)
Switches to mirror view, displays another y-axis for the second spectrum.
~Plot1DWidget() override
Destructor.
void performAlignment(Size layer_index_1, Size layer_index_2, const Param &param)
Performs an alignment of the layers with layer_index_1 and layer_index_2.
void saveAsImage() override
Saves the widget's content as image file.
void showCurrentPeaksAsDIA(const Precursor &pc, const MSExperiment &exp)
Requests to display a full DIA window.
void showCurrentPeaksAs3D()
Requests to display the whole spectrum in 3D view.
void showGoToDialog() override
virtual void renderForImage(QPainter &painter)
void hideAxes() override
Hides x-axis and y-axis.
Plot1DCanvas * canvas() const override
Returns a pointer to canvas object.
Definition: Plot1DWidget.h:77
void showLegend(bool show) override
Shows/hides axis labels.
void resetAlignment()
Resets the alignment.
Base class for spectrum widgets.
Definition: PlotWidget.h:83
Precursor meta information.
Definition: Precursor.h:61
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
DIM
Definition: DimMapper.h:627