| OpenMS 2.5.0

Annotation1DDistanceItem.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-2020.
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: Johannes Veit $
32 // $Authors: Johannes Junker $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/VISUAL/ANNOTATION/Annotation1DItem.h>
38 #include <vector>
39
40 namespace OpenMS
41 {
45 class Annotation1DDistanceItem :
46 public Annotation1DItem
47 {
48
49 public:
51 Annotation1DDistanceItem(const QString & text, const PointType & start_point, const PointType & end_point);
53 Annotation1DDistanceItem(const Annotation1DDistanceItem & rhs);
55 ~Annotation1DDistanceItem() override;
56 // Docu in base class
57 void ensureWithinDataRange(Spectrum1DCanvas * const canvas) override;
58 // Docu in base class
59 void draw(Spectrum1DCanvas * const canvas, QPainter & painter, bool flipped = false) override;
60 // Docu in base class
61 void move(const PointType & delta) override;
63 void setStartPoint(const PointType & start);
65 void setEndPoint(const PointType & end);
67 const PointType & getStartPoint() const;
69 const PointType & getEndPoint() const;
71 void setTicks(const std::vector<double> & ticks);
72 protected:
74 PointType start_point_;
76 PointType end_point_;
78 std::vector<double> ticks_;
79
80 };
81 } // namespace OpenMS
82
OpenMS::Annotation1DDistanceItem::draw
void draw(Spectrum1DCanvas *const canvas, QPainter &painter, bool flipped=false) override
Draws the item on painter.
OpenMS::Annotation1DDistanceItem::end_point_
PointType end_point_
The end point of the measured distance line.
Definition: Annotation1DDistanceItem.h:76
OpenMS::Annotation1DDistanceItem::~Annotation1DDistanceItem
~Annotation1DDistanceItem() override
Destructor.
OpenMS::Annotation1DDistanceItem::setStartPoint
void setStartPoint(const PointType &start)
Sets the start point of the measured distance line.
OpenMS::Annotation1DDistanceItem::start_point_
PointType start_point_
The start point of the measured distance line.
Definition: Annotation1DDistanceItem.h:74
OpenMS::Annotation1DItem
An abstract class acting as an interface for the different 1D annotation items.
Definition: Annotation1DItem.h:59
OpenMS::Annotation1DDistanceItem::setTicks
void setTicks(const std::vector< double > &ticks)
Set tick lines for the distance item.
OpenMS::Annotation1DDistanceItem::ensureWithinDataRange
void ensureWithinDataRange(Spectrum1DCanvas *const canvas) override
Ensures that the item has coordinates within the visible area of the canvas.
OpenMS::Annotation1DDistanceItem::move
void move(const PointType &delta) override
OpenMS::Annotation1DDistanceItem::setEndPoint
void setEndPoint(const PointType &end)
Sets the peak index of the end peak of the measurement.
OpenMS::Annotation1DItem::PointType
DPosition< 2 > PointType
Type of the Points.
Definition: Annotation1DItem.h:64
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::Annotation1DDistanceItem
An annotation item which represents a measured distance between two peaks.
Definition: Annotation1DDistanceItem.h:45
Annotation1DItem.h
OpenMS::Annotation1DDistanceItem::ticks_
std::vector< double > ticks_
Additional tick lines for the distance item.
Definition: Annotation1DDistanceItem.h:78
OpenMS::Spectrum1DCanvas
Canvas for visualization of one or several spectra.
Definition: Spectrum1DCanvas.h:67
OpenMS::Annotation1DDistanceItem::getEndPoint
const PointType & getEndPoint() const
Returns the end point as (MZ,intensity)
OpenMS::Annotation1DDistanceItem::Annotation1DDistanceItem
Annotation1DDistanceItem(const QString &text, const PointType &start_point, const PointType &end_point)
Constructor.
OpenMS::Annotation1DDistanceItem::getStartPoint
const PointType & getStartPoint() const
Returns the start point as (MZ,intensity)