base class for plotting an image More...

#include <jkqtpimage.h>

Inheritance diagram for JKQTPImageBase:

Collaboration diagram for JKQTPImageBase:

Public Slots
void	setHeight (double __value)
	height of image

void	setWidth (double __value)
	width of image

void	setX (double __value)
	x coordinate of lower left corner

void	setY (double __value)
	y coordinate of lower left corner

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

Public Member Functions
	JKQTPImageBase (double x, double y, double width, double height, JKQTBasePlotter *parent=nullptr)
	class constructor

	JKQTPImageBase (double x, double y, double width, double height, JKQTPlotter *parent)
	class constructor

	JKQTPImageBase (JKQTBasePlotter *parent=nullptr)
	class constructor

	JKQTPImageBase (JKQTPlotter *parent)
	class constructor

virtual void	drawKeyMarker (JKQTPEnhancedPainter &painter, const QRectF &rect) override
	plots a key marker inside the specified rectangle rect

double	getHeight () const
	height of image

virtual QColor	getKeyLabelColor () const override
	returns the color to be used for the key label

double	getWidth () const
	width of image

double	getX () const
	x coordinate of lower left corner

virtual bool	getXMinMax (double &minx, double &maxx, double &smallestGreaterZero) override
	get the maximum and minimum x-value of the graph

double	getY () const
	y coordinate of lower left corner

virtual bool	getYMinMax (double &miny, double &maxy, double &smallestGreaterZero) override
	get the maximum and minimum y-value of the graph

Public Member Functions inherited from JKQTPGraph
	JKQTPGraph (JKQTBasePlotter *parent=nullptr)
	class constructor

virtual	~JKQTPGraph ()=default
	default wirtual destructor

virtual bool	usesColumn (int column) const
	returns `true` if the given column is used by the graph

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	draw (JKQTPEnhancedPainter &painter)=0
	plots the graph to the plotter object specified as parent

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

Protected Member Functions
void	plotImage (JKQTPEnhancedPainter &painter, QImage &image, double x, double y, double width, double height)
	plot the given QImage onto the widget where the QImage fills the area defined by x, y (lower left corner) and width, height in the simplest case your implementation of draw() will call `plotImage(painter, image, this->x, this->y, this->width, this->height);`

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

Protected Attributes
double	height
	height of image

double	width
	width of image

double	x
	x coordinate of lower left corner

double	y
	y coordinate of lower left corner

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 JKQTPPlotElement
enum	HitTestMode { HitTestXY , HitTestXOnly , HitTestYOnly }
	modes of operation for the function hitTest() More...

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

Detailed Description

base class for plotting an image

Constructor & Destructor Documentation

◆ JKQTPImageBase() [1/4]

JKQTPImageBase::JKQTPImageBase ( JKQTBasePlotter * parent = nullptr )

class constructor

Parameters

parent parent plotter object

◆ JKQTPImageBase() [2/4]

JKQTPImageBase::JKQTPImageBase	(	double	x,
		double	y,
		double	width,
		double	height,
		JKQTBasePlotter *	parent = `nullptr`
	)

class constructor

Parameters

x	origin of the image (x-direction) in system coordinates
y	origin of the image (y-direction) in system coordinates
width	width of the image in system coordinates
height	height of the image in system coordinates
parent	parent plotter object

◆ JKQTPImageBase() [3/4]

JKQTPImageBase::JKQTPImageBase ( JKQTPlotter * parent )

class constructor

Parameters

parent parent plotter object

◆ JKQTPImageBase() [4/4]

JKQTPImageBase::JKQTPImageBase	(	double	x,
		double	y,
		double	width,
		double	height,
		JKQTPlotter *	parent
	)

class constructor

Parameters

x	origin of the image (x-direction) in system coordinates
y	origin of the image (y-direction) in system coordinates
width	width of the image in system coordinates
height	height of the image in system coordinates
parent	parent plotter object

Member Function Documentation

◆ drawKeyMarker()

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

overridevirtual

plots a key marker inside the specified rectangle rect

Implements JKQTPPlotElement.

Reimplemented in JKQTPMathImageBase, JKQTPImage, JKQTPMathImage, JKQTPOverlayImage, JKQTPOverlayImageEnhanced, and JKQTPRGBMathImage.

◆ getHeight()

double JKQTPImageBase::getHeight ( ) const

height of image

◆ getKeyLabelColor()

virtual QColor JKQTPImageBase::getKeyLabelColor ( ) const

overridevirtual

returns the color to be used for the key label

Implements JKQTPPlotElement.

Reimplemented in JKQTPOverlayImage.

◆ getWidth()

double JKQTPImageBase::getWidth ( ) const

width of image

◆ getX()

double JKQTPImageBase::getX ( ) const

x coordinate of lower left corner

◆ getXMinMax()

virtual bool JKQTPImageBase::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.

◆ getY()

double JKQTPImageBase::getY ( ) const

y coordinate of lower left corner

◆ getYMinMax()

virtual bool JKQTPImageBase::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.

◆ plotImage()

void JKQTPImageBase::plotImage	(	JKQTPEnhancedPainter &	painter,
		QImage &	image,
		double	x,
		double	y,
		double	width,
		double	height
	)

protected

plot the given QImage onto the widget where the QImage fills the area defined by x, y (lower left corner) and width, height in the simplest case your implementation of draw() will call plotImage(painter, image, this->x, this->y, this->width, this->height);

Parameters

painter	the Painter to use for drawing
image	the image to draw
x	x-coordinate of lower-left corner in coordinate space
y	y-coordinate of lower-left corner in coordinate space
width	width of image in coordinate space
height	height of image in coordinate space

◆ setHeight

void JKQTPImageBase::setHeight ( double __value )

slot

height of image

◆ setWidth

void JKQTPImageBase::setWidth ( double __value )

slot

width of image

◆ setX

void JKQTPImageBase::setX ( double __value )

slot

x coordinate of lower left corner

◆ setY

void JKQTPImageBase::setY ( double __value )

slot

y coordinate of lower left corner

Member Data Documentation

◆ height

double JKQTPImageBase::height

protected

height of image

◆ width

double JKQTPImageBase::width

protected

width of image

◆ x

double JKQTPImageBase::x

protected

x coordinate of lower left corner

◆ y

double JKQTPImageBase::y

protected

y coordinate of lower left corner

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

jkqtpimage.h

Public Slots

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ JKQTPImageBase() [1/4]

◆ JKQTPImageBase() [2/4]

◆ JKQTPImageBase() [3/4]

◆ JKQTPImageBase() [4/4]

Member Function Documentation

◆ drawKeyMarker()

◆ getHeight()

◆ getKeyLabelColor()

◆ getWidth()

◆ getX()

◆ getXMinMax()

◆ getY()

◆ getYMinMax()

◆ plotImage()

◆ setHeight

◆ setWidth

◆ setX

◆ setY

Member Data Documentation

◆ height

◆ width

◆ x

◆ y