JKQtPlotter/lib/jkqtplotter/jkqtpgraphspeakstream.h
2019-01-19 16:13:08 +01:00

150 lines
6.4 KiB
C++

/*
Copyright (c) 2008-2019 Jan W. Krieger (<jan@jkrieger.de>)
This software is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License (LGPL) as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License (LGPL) for more details.
You should have received a copy of the GNU Lesser General Public License (LGPL)
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/** \file jkqtpgraphspeakstream.h
* \ingroup jkqtplotter_diverse
*/
#include <QString>
#include <QPainter>
#include <QPair>
#include "jkqtplotter/jkqtpgraphsbase.h"
#ifndef jkqtpgraphspeakstream_H_INCLUDED
#define jkqtpgraphspeakstream_H_INCLUDED
// forward declarations
class JKQtBasePlotter;
class JKQtPlotter;
class JKQTPcoordinateAxis;
class JKQTPdatastore;
/*! \brief interprets data as a stream of x- or y-positions \f$ p_i \f$ (depending in \a yPeaks ) ans plots a line on the height
\a baseline and upright lines from baseline to baseline+peakHeight at each position \f$ p_i \f$. This can be used to
display a stream of photons with given arrivaltimes \f$ p_i \f$.
\ingroup jkqtplotter_diverse
\image html JKQTPPeakStreamGraphY.png "yPeaks=true"
\image html JKQTPPeakStreamGraphX.png "yPeaks=false"
*/
class LIB_EXPORT JKQTPPeakStreamGraph: public JKQTPsingleColumnGraph {
Q_OBJECT
public:
/** \brief class constructor */
JKQTPPeakStreamGraph(JKQtBasePlotter* parent=nullptr);
JKQTPPeakStreamGraph(int dataColumn, double baseline, double peakHeight, QColor color, JKQtBasePlotter* parent=nullptr);
JKQTPPeakStreamGraph(int dataColumn, double baseline, double peakHeight, JKQtBasePlotter* parent=nullptr);
JKQTPPeakStreamGraph(JKQtPlotter* parent);
JKQTPPeakStreamGraph(int dataColumn, double baseline, double peakHeight, QColor color, JKQtPlotter* parent);
JKQTPPeakStreamGraph(int dataColumn, double baseline, double peakHeight, JKQtPlotter* parent);
/** \brief get the maximum and minimum x-value of the graph
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getXMinMax(double& minx, double& maxx, double& smallestGreaterZero) override;
/** \brief get the maximum and minimum y-value of the graph
*
* The result is given in the two parameters which are call-by-reference parameters!
*/
virtual bool getYMinMax(double& miny, double& maxy, double& smallestGreaterZero) override;
/** \brief plots the graph to the plotter object specified as parent */
virtual void draw(JKQTPEnhancedPainter& painter) override;
/** \brief plots a key marker inside the specified rectangle \a rect */
virtual void drawKeyMarker(JKQTPEnhancedPainter& painter, QRectF& rect) override;
/*! \brief sets the property baseline to the specified \a __value.
\details Description of the parameter baseline is: <BLOCKQUOTE>\copybrief baseline </BLOCKQUOTE>
\see baseline for more information */
inline virtual void set_baseline(double __value)
{
this->baseline = __value;
}
/*! \brief returns the property baseline.
\details Description of the parameter baseline is: <BLOCKQUOTE>\copybrief baseline </BLOCKQUOTE>
\see baseline for more information */
inline virtual double get_baseline() const
{
return this->baseline;
}
/*! \brief sets the property peakHeight to the specified \a __value.
\details Description of the parameter peakHeight is: <BLOCKQUOTE>\copybrief peakHeight </BLOCKQUOTE>
\see peakHeight for more information */
inline virtual void set_peakHeight(double __value)
{
this->peakHeight = __value;
}
/*! \brief returns the property peakHeight.
\details Description of the parameter peakHeight is: <BLOCKQUOTE>\copybrief peakHeight </BLOCKQUOTE>
\see peakHeight for more information */
inline virtual double get_peakHeight() const
{
return this->peakHeight;
}
/*! \brief sets the property yPeaks to the specified \a __value.
\details Description of the parameter yPeaks is: <BLOCKQUOTE>\copybrief yPeaks </BLOCKQUOTE>
\see yPeaks for more information */
inline virtual void set_yPeaks(bool __value)
{
this->yPeaks = __value;
}
/*! \brief returns the property yPeaks.
\details Description of the parameter yPeaks is: <BLOCKQUOTE>\copybrief yPeaks </BLOCKQUOTE>
\see yPeaks for more information */
inline virtual bool get_yPeaks() const
{
return this->yPeaks;
}
/*! \brief sets the property drawBaseline to the specified \a __value.
\details Description of the parameter drawBaseline is: <BLOCKQUOTE>\copybrief drawBaseline </BLOCKQUOTE>
\see drawBaseline for more information */
inline virtual void set_drawBaseline(bool __value)
{
this->drawBaseline = __value;
}
/*! \brief returns the property drawBaseline.
\details Description of the parameter drawBaseline is: <BLOCKQUOTE>\copybrief drawBaseline </BLOCKQUOTE>
\see drawBaseline for more information */
inline virtual bool get_drawBaseline() const
{
return this->drawBaseline;
}
protected:
/** \brief position of the baseline */
double baseline;
/** \brief height of each peak */
double peakHeight;
/** \brief if set \c true the peaks are in Y direction (default: true)*/
bool yPeaks;
/** \brief indicates whether to draw the basleine (default: \c true ) */
bool drawBaseline;
};
#endif // jkqtpgraphspeakstream_H_INCLUDED