interprets data as a stream of x- or y-positions (depending in yPeaks ) ans plots a line on the height baseline and upright lines from baseline to baseline+peakHeight at each position . This can be used to display a stream of photons with given arrivaltimes . More...

#include <jkqtppeakstream.h>

Inheritance diagram for JKQTPPeakStreamGraph:

[legend]

Collaboration diagram for JKQTPPeakStreamGraph:

[legend]

Public Member Functions
	JKQTPPeakStreamGraph (JKQTBasePlotter *parent=nullptr)
	class constructor
	JKQTPPeakStreamGraph (JKQTPlotter *parent)
virtual void	draw (JKQTPEnhancedPainter &painter) override
	plots the graph to the plotter object specified as parent
virtual void	drawKeyMarker (JKQTPEnhancedPainter &painter, const QRectF &rect) override
	plots a key marker inside the specified rectangle rect
double	getBaseline () const
	position of the baseline
bool	getDrawBaseline () const
	indicates whether to draw the basleine (default: `true` )
virtual QColor	getKeyLabelColor () const override
	returns the color to be used for the key label
double	getPeakHeight () const
	height of each peak
virtual bool	getXMinMax (double &minx, double &maxx, double &smallestGreaterZero) override
	get the maximum and minimum x-value of the graph
virtual bool	getYMinMax (double &miny, double &maxy, double &smallestGreaterZero) override
	get the maximum and minimum y-value of the graph
bool	getYPeaks () const
	if set `true` the peaks are in Y direction (default: true)
void	setBaseline (double __value)
	position of the baseline
void	setColor (QColor col)
	set symbol color and fill color at the same time
void	setDrawBaseline (bool __value)
	indicates whether to draw the basleine (default: `true` )
void	setPeakHeight (double __value)
	height of each peak
void	setYPeaks (bool __value)
	if set `true` the peaks are in Y direction (default: true)
Public Member Functions inherited from JKQTPSingleColumnGraph
	JKQTPSingleColumnGraph (JKQTBasePlotter *parent=nullptr)
	class constructor
int	getDataColumn () const
	the column that contains the datapoints
DataDirection	getDataDirection () const
	interpret the data from dataColumn either as X- or Y-data
DataSortOrder	getDataSortOrder () const
	if `!=Unsorted`, the data is sorted before plotting
virtual bool	usesColumn (int c) const override
	returns `true` if the given column is used by the graph
Public Member Functions inherited from JKQTPGraph
	JKQTPGraph (JKQTBasePlotter *parent=nullptr)
	class constructor
virtual	~JKQTPGraph ()=default
	default wirtual destructor
Public Member Functions inherited from JKQTPPlotElement
	JKQTPPlotElement (JKQTBasePlotter *parent=nullptr)
	class constructor
virtual	~JKQTPPlotElement ()=default
	default wirtual destructor
QPointF	backTransform (const QPointF &x) const
	tool routine that back-transforms a QPointF according to the parent's transformation rules (pixels --> plot coordinate)
QPointF	backTransform (double x, double y) const
	tool routine that back-transforms a QPointF according to the parent's transformation rules (pixels --> plot coordinate)
double	backtransformX (double x) const
	tool routine that backtransforms an x-coordinate (pixels --> plot coordinate) for this plot element, uses the axis referenced in xAxisRef
double	backtransformY (double y) const
	tool routine that backtransforms a y-coordinate (pixels --> plot coordinate) for this plot element, uses the axis referenced in yAxisRef
virtual void	drawOutside (JKQTPEnhancedPainter &painter, QRect leftSpace, QRect rightSpace, QRect topSpace, QRect bottomSpace)
	plots outside the actual plot field of view (e.g. color bars, scale bars, ...)
QImage	generateKeyMarker (QSize size=QSize(16, 16))
	returns an image with a key marker inside
virtual void	getOutsideSize (JKQTPEnhancedPainter &painter, int &leftSpace, int &rightSpace, int &topSpace, int &bottomSpace)
	if the graph plots outside the actual plot field of view (e.g. color bars, scale bars, ...)
JKQTBasePlotter *	getParent ()
	returns the parent painter class
const JKQTBasePlotter *	getParent () const
	returns the parent painter class
QString	getTitle () const
	returns the the title of the plot
const JKQTPCoordinateAxis *	getXAxis () const
	returns the actual x-Axis-object from the parent plotter, referenced in xAxisRef
JKQTPCoordinateAxisRef	getXAxisRef () const
	indicates which coordinate axis to use for coordinate transforms in x-direction
const JKQTPCoordinateAxis *	getYAxis () const
	returns the actual y-Axis-object from the parent plotter, referenced in yAxisRef
JKQTPCoordinateAxisRef	getYAxisRef () const
	indicates which coordinate axis to use for coordinate transforms in y-direction
virtual double	hitTest (const QPointF &posSystem, QPointF closestSpotSystem=nullptr, QString label=nullptr, HitTestMode mode=HitTestXY) const
	returns the closest distance of the plot element to the (screen pixel) position pos, or `NAN`
bool	isHighlighted () const
	returns whether the graph is shown in a highlighted style in the plot
bool	isVisible () const
	returns whether the graph is visible in the plot
void	setAxes (JKQTPCoordinateAxisRef ref)
	set the coordinate axes to use for this plot element
virtual void	setParent (JKQTBasePlotter *parent)
	sets the parent painter class
virtual void	setParent (JKQTPlotter *parent)
	sets the parent painter class
void	setXAxis (JKQTPCoordinateAxisRef ref)
	indicates which coordinate axis to use for coordinate transforms in x-direction
void	setYAxis (JKQTPCoordinateAxisRef ref)
	indicates which coordinate axis to use for coordinate transforms in y-direction
QPointF	transform (const QPointF &x) const
	tool routine that transforms a QPointF according to the parent's transformation rules (plot coordinate --> pixels)
QPolygonF	transform (const QPolygonF &x) const
	tool routine that transforms a QPolygonF according to the parent's transformation rules (plot coordinate --> pixels)
QPointF	transform (double x, double y) const
	tool routine that transforms a QPointF according to the parent's transformation rules (plot coordinate --> pixels)
QPainterPath	transformToLinePath (const QPolygonF &x) const
	tool routine that transforms a QPolygonF according to the parent's transformation rules and returns a (non-closed) path consisting of lines (plot coordinate --> pixels)
QVector< double >	transformX (const QVector< double > &x) const
	transform all x-coordinates in a vector x
double	transformX (double x) const
	tool routine that transforms an x-coordinate (plot coordinate --> pixels) for this plot element, uses the axis referenced in xAxisRef
QVector< double >	transformY (const QVector< double > &x) const
	transform all y-coordinates in a vector x
double	transformY (double y) const
	tool routine that transforms a y-coordinate (plot coordinate --> pixels) for this plot element, uses the axis referenced in yAxisRef
Public Member Functions inherited from JKQTPGraphLineStyleMixin
	JKQTPGraphLineStyleMixin ()
	class constructor
virtual	~JKQTPGraphLineStyleMixin ()
QColor	getHighlightingLineColor () const
	get the color of the graph line when highlighted
QPen	getHighlightingLinePen (JKQTPEnhancedPainter &painter, JKQTBasePlotter *parent) const
	constructs a QPen from the line styling properties
QPen	getHighlightingLinePenForRects (JKQTPEnhancedPainter &painter, JKQTBasePlotter *parent) const
	constructs a QPen from the line styling properties, suitable for drawing rectangle with sharp corners
QPen	getKeyLinePen (JKQTPEnhancedPainter &painter, const QRectF &rect, JKQTBasePlotter *parent) const
	constructs a QPen from the line styling properties, but uses getKeyLineWidthPx() for the width, i.e. constructs a pen for drawing lines in key-symbols
double	getKeyLineWidthPx (JKQTPEnhancedPainter &painter, const QRectF &keyRect, const JKQTBasePlotter *parent) const
	returns the linewidth for drawing lines in a key entry with keyRect for the symbol, using painter and parent .
QBrush	getLineBrush () const
	gets the brush used to fill the line area
Qt::PenCapStyle	getLineCapStyle () const
	gets the cap style
QColor	getLineColor () const
	get the color of the graph line
qreal	getLineDashOffset () const
	returns the dash offset for a custom dash style
QVector< qreal >	getLineDashPattern () const
	gets the dash pattern for a custom dash style
Qt::PenJoinStyle	getLineJoinStyle () const
	returns the join style
QPen	getLinePen (JKQTPEnhancedPainter &painter, JKQTBasePlotter *parent) const
	constructs a QPen from the line styling properties
QPen	getLinePenForRects (JKQTPEnhancedPainter &painter, JKQTBasePlotter *parent) const
	constructs a QPen from the line styling properties, suitable for drawing rectangles with sharp edges
Qt::PenStyle	getLineStyle () const
	get the style of the graph line
double	getLineWidth () const
	get the line width of the graph line (in pt)
void	initLineStyle (JKQTBasePlotter *parent, int &parentPlotStyle, JKQTPPlotStyleType styletype=JKQTPPlotStyleType::Default)
	initiaize the line style (from the parent plotter)
void	setHighlightingLineColor (const QColor &__value)
	set the color of the graph line when highlighted
void	setHighlightingLineColor (const QColor &__value, double alpha)
	set the color of the graph line when highlighted
void	setLineBrush (const QBrush &style)
	sets the brush used to fill the line area
void	setLineCapStyle (Qt::PenCapStyle style)
	sets the cap style
void	setLineColor (const QColor &__value)
	set the color of the graph line
void	setLineColor (const QColor &__value, double alpha)
	set the color of the graph line
void	setLineColorInvertedFrom (QColor __noninvertedColor)
	sets the line-color as an inverted version of the given color
void	setLineDashOffset (qreal offset)
	sets the dash offset for a custom dash style
void	setLineDashPattern (const QVector< qreal > &pattern)
	sets the dash pattern for a custom dash style
void	setLineJoinStyle (Qt::PenJoinStyle style)
	sets the join style
void	setLineStyle (Qt::PenStyle __value)
	set the style of the graph line
void	setLineWidth (double __value)
	set the line width of the graph line (in pt)

Protected Attributes
double	baseline
	position of the baseline
bool	drawBaseline
	indicates whether to draw the basleine (default: `true` )
double	peakHeight
	height of each peak
bool	yPeaks
	if set `true` the peaks are in Y direction (default: true)
Protected Attributes inherited from JKQTPSingleColumnGraph
QVector< int >	sortedIndices
	this array contains the order of indices, in which to access the data in the data columns
Protected Attributes inherited from JKQTPPlotElement
QVector< HitTestLocation >	m_hitTestData
	dataset with graph-points and associated data from the function hitTest()
JKQTBasePlotter *	parent
	the plotter object this object belongs to
int	parentPlotStyle
	internal storage for the used parent plot style

Additional Inherited Members
Public Types inherited from JKQTPSingleColumnGraph
enum class	DataDirection { X , Y }
	specifies whether the data for a JKQTPSingleColumnGraph represent x-axis or y-axis values More...
enum	DataSortOrder { Unsorted =0 , Sorted =1 }
	specifies how to sort the data for a JKQTPSingleColumnGraph before drawing More...
Public Types inherited from JKQTPPlotElement
enum	HitTestMode { HitTestXY , HitTestXOnly , HitTestYOnly }
	modes of operation for the function hitTest() More...
Public Slots inherited from JKQTPSingleColumnGraph
void	setDataColumn (int __value)
	the column that contains the datapoints
void	setDataColumn (size_t __value)
	the column that contains the datapoints
void	setDataDirection (DataDirection __value)
	interpret the data from dataColumn either as X- or Y-data
void	setDataSortOrder (DataSortOrder __value)
	if `!=Unsorted`, the data is sorted before plotting
void	setDataSortOrder (int __value)
	if `!=Unsorted`, the data is sorted before plotting
Public Slots inherited from JKQTPPlotElement
void	setHighlighted (bool __value)
	sets whether the graph is drawn in a highlighted style in the plot
virtual void	setTitle (const QString &__value)
	sets the title of the plot (for display in key!).
void	setVisible (bool __value)
	sets whether the graph is visible in the plot
Protected Member Functions inherited from JKQTPSingleColumnGraph
int	getDataIndex (int i) const
	returns the index of the i-th datapoint (where i is an index into the SORTED datapoints)
virtual bool	getIndexRange (int &imin, int &imax) const
	determines the range of row indexes available in the data columns of this graph
virtual void	intSortData ()
Protected Member Functions inherited from JKQTPGraph
virtual void	drawErrorsAfter (JKQTPEnhancedPainter &)
	this function is used to plot error inidcators after plotting the graphs.
virtual void	drawErrorsBefore (JKQTPEnhancedPainter &)
	this function is used to plot error inidcators before plotting the graphs.
bool	getDataMinMax (int column, double &minx, double &maxx, double &smallestGreaterZero)
	get the maximum and minimum value of the given column
Protected Member Functions inherited from JKQTPPlotElement
void	addHitTestData (const HitTestLocation &loc)
	clear the internal datastore for hitTest()
void	addHitTestData (const QPointF &pos_, const QString &label_)
	clear the internal datastore for hitTest()
void	addHitTestData (const QPointF &pos_, int index_, const QString &label_)
	clear the internal datastore for hitTest()
void	addHitTestData (const QPointF &pos_, int index_=-1, const JKQTPDatastore *datastore=nullptr)
	clear the internal datastore for hitTest(), this variant uses formatHitTestDefaultLabel() to auto-generate the label
void	addHitTestData (double x_, double y_, const QString &label_)
	add a new point on the graph to the internal datastore for hitTest()
void	addHitTestData (double x_, double y_, int index_, const QString &label_)
	clear the internal datastore for hitTest()
void	addHitTestData (double x_, double y_, int index_=-1, const JKQTPDatastore *datastore=nullptr)
	add a new point on the graph to the internal datastore for hitTest(), this variant uses formatHitTestDefaultLabel() to auto-generate the label
void	clearHitTestData ()
	clear the internal datastore for hitTest()
virtual QString	formatHitTestDefaultLabel (double x, double y, int index=-1, const JKQTPDatastore *datastore=nullptr) const
	tool-function for hitTest(), which formats a default label, taking into account the x- and y-position (both provided) and optionally the errors of these positions.
void	reserveHitTestData (int points)
	reserve list entries for up to points graph points in the internal datastore for hitTest()
QString	xFloatToString (double v, int past_comma=-1) const
	converts a x-value v into a string, taking into account the type of x-axis
QString	yFloatToString (double v, int past_comma=-1) const
	converts a x-value v into a string, taking into account the type of x-axis
Properties inherited from JKQTPSingleColumnGraph
int	dataColumn
	the column that contains the datapoints
DataDirection	dataDirection
	interpret the data from dataColumn either as X- or Y-data
DataSortOrder	sortData
	if `!=Unsorted`, the data is sorted before plotting
Properties inherited from JKQTPPlotElement
bool	highlighted
	indicates whether the graph is shown in a "highlghted" in the plot
QString	title
	title of the plot (for display in key!). If no title is supplied, no key entry is drawn.
bool	visible
	indicates whether the graph is visible in the plot
JKQTPCoordinateAxisRef	xAxisRef
	indicates which coordinate axis to use for coordinate transforms in x-direction
JKQTPCoordinateAxisRef	yAxisRef
	indicates which coordinate axis to use for coordinate transforms in y-direction
Properties inherited from JKQTPGraphLineStyleMixin
QColor	highlightingLineColor
QColor	lineColor
Qt::PenStyle	lineStyle
double	lineWidth

Detailed Description

interprets data as a stream of x- or y-positions (depending in yPeaks ) ans plots a line on the height baseline and upright lines from baseline to baseline+peakHeight at each position . This can be used to display a stream of photons with given arrivaltimes .

yPeaks=true

yPeaks=false

See also: Tutorial (JKQTPDatastore): Advanced 1-Dimensional Statistics with JKQTPDatastore

Constructor & Destructor Documentation

◆ JKQTPPeakStreamGraph() [1/2]

JKQTPPeakStreamGraph::JKQTPPeakStreamGraph ( JKQTBasePlotter * parent = nullptr )

class constructor

◆ JKQTPPeakStreamGraph() [2/2]

JKQTPPeakStreamGraph::JKQTPPeakStreamGraph ( JKQTPlotter * parent )

Member Function Documentation

◆ draw()

virtual void JKQTPPeakStreamGraph::draw ( JKQTPEnhancedPainter & painter )

overridevirtual

plots the graph to the plotter object specified as parent

Implements JKQTPPlotElement.

◆ drawKeyMarker()

virtual void JKQTPPeakStreamGraph::drawKeyMarker	(	JKQTPEnhancedPainter &	painter,
		const QRectF &	rect )

overridevirtual

plots a key marker inside the specified rectangle rect

Implements JKQTPPlotElement.

◆ getBaseline()

double JKQTPPeakStreamGraph::getBaseline ( ) const

position of the baseline

◆ getDrawBaseline()

bool JKQTPPeakStreamGraph::getDrawBaseline ( ) const

indicates whether to draw the basleine (default: true )

◆ getKeyLabelColor()

virtual QColor JKQTPPeakStreamGraph::getKeyLabelColor ( ) const

overridevirtual

returns the color to be used for the key label

Implements JKQTPPlotElement.

◆ getPeakHeight()

double JKQTPPeakStreamGraph::getPeakHeight ( ) const

height of each peak

◆ getXMinMax()

virtual bool JKQTPPeakStreamGraph::getXMinMax	(	double &	minx,
		double &	maxx,
		double &	smallestGreaterZero )

overridevirtual

get the maximum and minimum x-value of the graph

The result is given in the two parameters which are call-by-reference parameters!

Parameters

[out]	minx	minimal x-value used in the graph
[out]	maxx	maximal x-value used in the graph
[out]	smallestGreaterZero	the smalles x-value in the graph, which is larger than 0 (this is used in auto-sizing for logarithmic axes)

Returns: true on success, i.e. if there were datapoints in the plot, or false on failure (e.g. when the graph is empty)

Implements JKQTPPlotElement.

◆ getYMinMax()

virtual bool JKQTPPeakStreamGraph::getYMinMax	(	double &	miny,
		double &	maxy,
		double &	smallestGreaterZero )

overridevirtual

get the maximum and minimum y-value of the graph

The result is given in the two parameters which are call-by-reference parameters!

Parameters

[out]	miny	minimal y-value used in the graph
[out]	maxy	maximal y-value used in the graph
[out]	smallestGreaterZero	the smalles y-value in the graph, which is larger than 0 (this is used in auto-sizing for logarithmic axes)

Returns: true on success, i.e. if there were datapoints in the plot, or false on failure (e.g. when the graph is empty)

Implements JKQTPPlotElement.

◆ getYPeaks()

bool JKQTPPeakStreamGraph::getYPeaks ( ) const

if set true the peaks are in Y direction (default: true)

◆ setBaseline()

void JKQTPPeakStreamGraph::setBaseline ( double __value )

position of the baseline

◆ setColor()

void JKQTPPeakStreamGraph::setColor ( QColor col )

set symbol color and fill color at the same time

◆ setDrawBaseline()

void JKQTPPeakStreamGraph::setDrawBaseline ( bool __value )

indicates whether to draw the basleine (default: true )

◆ setPeakHeight()

void JKQTPPeakStreamGraph::setPeakHeight ( double __value )

height of each peak

◆ setYPeaks()

void JKQTPPeakStreamGraph::setYPeaks ( bool __value )

if set true the peaks are in Y direction (default: true)

Member Data Documentation

◆ baseline

double JKQTPPeakStreamGraph::baseline

protected

position of the baseline

◆ drawBaseline

bool JKQTPPeakStreamGraph::drawBaseline

protected

indicates whether to draw the basleine (default: true )

◆ peakHeight

double JKQTPPeakStreamGraph::peakHeight

protected

height of each peak

◆ yPeaks

bool JKQTPPeakStreamGraph::yPeaks

protected

if set true the peaks are in Y direction (default: true)

The documentation for this class was generated from the following file:

jkqtppeakstream.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ JKQTPPeakStreamGraph() [1/2]

◆ JKQTPPeakStreamGraph() [2/2]

Member Function Documentation

◆ draw()

◆ drawKeyMarker()

◆ getBaseline()

◆ getDrawBaseline()

◆ getKeyLabelColor()

◆ getPeakHeight()

◆ getXMinMax()

◆ getYMinMax()

◆ getYPeaks()

◆ setBaseline()

◆ setColor()

◆ setDrawBaseline()

◆ setPeakHeight()

◆ setYPeaks()

Member Data Documentation

◆ baseline

◆ drawBaseline

◆ peakHeight

◆ yPeaks