JKQTPMathImageBase Class Reference

base class to hold an image from an 2-dimensional array of values More...

#include <jkqtpimage.h>

Inheritance diagram for JKQTPMathImageBase:

Collaboration diagram for JKQTPMathImageBase:

Public Member Functions
	JKQTPMathImageBase (double x, double y, double width, double height, JKQTBasePlotter *parent=nullptr)
	class constructor
	JKQTPMathImageBase (double x, double y, double width, double height, JKQTPlotter *parent=nullptr)
	class constructor
	JKQTPMathImageBase (double x, double y, double width, double height, JKQTPMathImageDataType datatype, const void *data, int Nx, int Ny, JKQTBasePlotter *parent=nullptr)
	class constructor
	JKQTPMathImageBase (double x, double y, double width, double height, JKQTPMathImageDataType datatype, const void *data, int Nx, int Ny, JKQTPlotter *parent)
	class constructor
	JKQTPMathImageBase (JKQTBasePlotter *parent=nullptr)
	class constructor
	JKQTPMathImageBase (JKQTPlotter *parent)
	class constructor
virtual void	drawKeyMarker (JKQTPEnhancedPainter &painter, const QRectF &rect) override
	plots a key marker inside the specified rectangle rect
virtual const void *	getData () const
	points to the data array, holding the image
QVector< double >	getDataAsDoubleVector () const
	returns the contents of the internal data image as a QVector<double>
virtual void	getDataMinMax (double &imin, double &imax)
	determine min/max data value of the image
virtual const void *	getDataModifier () const
	points to the data array, holding the modifier image
QVector< double >	getDataModifierAsDoubleVector () const
	returns the contents of the internal modifier image as a QVector<double>
virtual JKQTPMathImageDataType	getDatatype () const
	datatype of the data array data
virtual JKQTPMathImageDataType	getDatatypeModifier () const
	datatype of the data array data
virtual void	getModifierMinMax (double &imin, double &imax)
	determine min/max data value of the image
int	getNx () const
	width of the data array data in pt
int	getNy () const
	height of the data array data in pt
virtual void	setData (const void *__value)
	points to the data array, holding the image
virtual void	setData (const void *data, int Nx, int Ny)
	sets data ( points to the data array, holding the image ), as well as the size of data (Nx: width of the data array data in pt and Ny: height of the data array data in pt )
virtual void	setData (const void *data, int Nx, int Ny, JKQTPMathImageDataType datatype)
	sets data ( points to the data array, holding the image ) and datatype ( datatype of the data array data ), as well as the size of data (Nx: width of the data array data in pt and Ny: height of the data array data in pt )
virtual void	setDataModifier (const void *__value)
	points to the data array, holding the modifier image
virtual void	setDataModifier (const void *data, JKQTPMathImageDataType datatype)
	sets dataModifier ( points to the data array, holding the modifier image ) and datatypeModifier ( datatype of the data array data )
virtual void	setDatatype (JKQTPMathImageDataType __value)
	datatype of the data array data
virtual void	setDatatypeModifier (JKQTPMathImageDataType __value)
	datatype of the data array data
void	setNx (int __value)
	width of the data array data in pt
void	setNx (size_t __value)
	width of the data array data in pt
void	setNy (int __value)
	height of the data array data in pt
void	setNy (size_t __value)
	height of the data array data in pt
Public Member Functions inherited from JKQTPImageBase
	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
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
virtual void	ensureImageData ()
	overwrite this to fill the data poiters before they are accessed (e.g. to load data from a column in the datastore
Protected Member Functions inherited from JKQTPImageBase
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
const void *	data
	points to the data array, holding the image
const void *	dataModifier
	points to the data array, holding the modifier image
JKQTPMathImageDataType	datatype
	datatype of the data array data
JKQTPMathImageDataType	datatypeModifier
	datatype of the data array data
double	internalDataMax
	internal storage for maximum of the image value range
double	internalDataMin
	internal storage for minimum of the image value range
double	internalModifierMax
	internal storage for maximum of the modifier image value range
double	internalModifierMin
	internal storage for minimum of the modifier image value range
int	Nx
	width of the data array data in pt
int	Ny
	height of the data array data in pt
Protected Attributes inherited from JKQTPImageBase
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...
Public Slots inherited from JKQTPImageBase
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
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 to hold an image from an 2-dimensional array of values

Constructor & Destructor Documentation

JKQTPMathImageBase() [1/6]

JKQTPMathImageBase::JKQTPMathImageBase

(

JKQTBasePlotter *

parent = nullptr

)

class constructor

Parameters

parent

parent plotter object

JKQTPMathImageBase() [2/6]

JKQTPMathImageBase::JKQTPMathImageBase	(	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

JKQTPMathImageBase() [3/6]

JKQTPMathImageBase::JKQTPMathImageBase	(	double	x,
		double	y,
		double	width,
		double	height,
		JKQTPMathImageDataType	datatype,
		const void *	data,
		int	Nx,
		int	Ny,
		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
datatype	datatype of the image given in data
data	points to an image to be plotted (of size Nx * Ny )
Nx	width (in number of pixels) of data
Ny	height (in number of pixels) of data
parent	parent plotter object

JKQTPMathImageBase() [4/6]

JKQTPMathImageBase::JKQTPMathImageBase

(

JKQTPlotter *

parent

)

class constructor

Parameters

parent

parent plotter object

JKQTPMathImageBase() [5/6]

JKQTPMathImageBase::JKQTPMathImageBase	(	double	x,
		double	y,
		double	width,
		double	height,
		JKQTPlotter *	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

JKQTPMathImageBase() [6/6]

JKQTPMathImageBase::JKQTPMathImageBase	(	double	x,
		double	y,
		double	width,
		double	height,
		JKQTPMathImageDataType	datatype,
		const void *	data,
		int	Nx,
		int	Ny,
		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
datatype	datatype of the image given in data
data	points to an image to be plotted (of size Nx * Ny )
Nx	width (in number of pixels) of data
Ny	height (in number of pixels) of data
parent	parent plotter object

Member Function Documentation

drawKeyMarker()

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

overridevirtual

plots a key marker inside the specified rectangle rect

Reimplemented from JKQTPImageBase.

Reimplemented in JKQTPMathImage, and JKQTPRGBMathImage.

ensureImageData()

virtual void JKQTPMathImageBase::ensureImageData ( )

protectedvirtual

overwrite this to fill the data poiters before they are accessed (e.g. to load data from a column in the datastore

Reimplemented in JKQTPColumnContourPlot, JKQTPColumnMathImage, and JKQTPColumnRGBMathImage.

getData()

virtual const void * JKQTPMathImageBase::getData ( ) const

virtual

points to the data array, holding the image

getDataAsDoubleVector()

QVector< double > JKQTPMathImageBase::getDataAsDoubleVector

(

)

const

returns the contents of the internal data image as a QVector<double>

getDataMinMax()

virtual void JKQTPMathImageBase::getDataMinMax ( double & imin, double & imax )

virtual

determine min/max data value of the image

Reimplemented in JKQTPMathImage, and JKQTPRGBMathImage.

getDataModifier()

virtual const void * JKQTPMathImageBase::getDataModifier ( ) const

virtual

points to the data array, holding the modifier image

getDataModifierAsDoubleVector()

QVector< double > JKQTPMathImageBase::getDataModifierAsDoubleVector

(

)

const

returns the contents of the internal modifier image as a QVector<double>

getDatatype()

virtual JKQTPMathImageDataType JKQTPMathImageBase::getDatatype ( ) const

virtual

datatype of the data array data

getDatatypeModifier()

virtual JKQTPMathImageDataType JKQTPMathImageBase::getDatatypeModifier ( ) const

virtual

datatype of the data array data

getModifierMinMax()

virtual void JKQTPMathImageBase::getModifierMinMax ( double & imin, double & imax )

virtual

determine min/max data value of the image

Reimplemented in JKQTPContourPlot, and JKQTPMathImage.

getNx()

int JKQTPMathImageBase::getNx

(

)

const

width of the data array data in pt

getNy()

int JKQTPMathImageBase::getNy

(

)

const

height of the data array data in pt

setData() [1/3]

virtual void JKQTPMathImageBase::setData ( const void * __value )

virtual

points to the data array, holding the image

Reimplemented in JKQTPColumnRGBMathImage, and JKQTPRGBMathImage.

setData() [2/3]

virtual void JKQTPMathImageBase::setData ( const void * data, int Nx, int Ny )

virtual

sets data ( points to the data array, holding the image ), as well as the size of data (Nx: width of the data array data in pt and Ny: height of the data array data in pt )

Reimplemented in JKQTPColumnRGBMathImage, and JKQTPRGBMathImage.

setData() [3/3]

virtual void JKQTPMathImageBase::setData ( const void * data, int Nx, int Ny, JKQTPMathImageDataType datatype )

virtual

sets data ( points to the data array, holding the image ) and datatype ( datatype of the data array data ), as well as the size of data (Nx: width of the data array data in pt and Ny: height of the data array data in pt )

Reimplemented in JKQTPColumnRGBMathImage, and JKQTPRGBMathImage.

setDataModifier() [1/2]

virtual void JKQTPMathImageBase::setDataModifier ( const void * __value )

virtual

points to the data array, holding the modifier image

setDataModifier() [2/2]

virtual void JKQTPMathImageBase::setDataModifier ( const void * data, JKQTPMathImageDataType datatype )

virtual

sets dataModifier ( points to the data array, holding the modifier image ) and datatypeModifier ( datatype of the data array data )

setDatatype()

virtual void JKQTPMathImageBase::setDatatype ( JKQTPMathImageDataType __value )

virtual

datatype of the data array data

setDatatypeModifier()

virtual void JKQTPMathImageBase::setDatatypeModifier ( JKQTPMathImageDataType __value )

virtual

datatype of the data array data

setNx() [1/2]

void JKQTPMathImageBase::setNx

(

int

__value

)

width of the data array data in pt

setNx() [2/2]

void JKQTPMathImageBase::setNx

(

size_t

__value

)

width of the data array data in pt

setNy() [1/2]

void JKQTPMathImageBase::setNy

(

int

__value

)

height of the data array data in pt

setNy() [2/2]

void JKQTPMathImageBase::setNy

(

size_t

__value

)

height of the data array data in pt

Member Data Documentation

data

const void* JKQTPMathImageBase::data

protected

points to the data array, holding the image

dataModifier

const void* JKQTPMathImageBase::dataModifier

protected

points to the data array, holding the modifier image

datatype

JKQTPMathImageDataType JKQTPMathImageBase::datatype

protected

datatype of the data array data

datatypeModifier

JKQTPMathImageDataType JKQTPMathImageBase::datatypeModifier

protected

datatype of the data array data

internalDataMax

double JKQTPMathImageBase::internalDataMax

protected

internal storage for maximum of the image value range

This is set e.g. when calling drawImage() or draw()

internalDataMin

double JKQTPMathImageBase::internalDataMin

protected

internal storage for minimum of the image value range

This is set e.g. when calling drawImage() or draw()

internalModifierMax

double JKQTPMathImageBase::internalModifierMax

protected

internal storage for maximum of the modifier image value range

This is set e.g. when calling modifyImage() or draw()

internalModifierMin

double JKQTPMathImageBase::internalModifierMin

protected

internal storage for minimum of the modifier image value range

This is set e.g. when calling modifyImage() or draw()

Nx

int JKQTPMathImageBase::Nx

protected

width of the data array data in pt

Ny

int JKQTPMathImageBase::Ny

protected

height of the data array data in pt

---

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

• jkqtpimage.h