class to plot an image from an 2-dimensional array of values stored in a column of the datastore More...

#include <jkqtpimage.h>

Inheritance diagram for JKQTPColumnMathImage:

Collaboration diagram for JKQTPColumnMathImage:

Public Member Functions
	JKQTPColumnMathImage (double x, double y, double width, double height, int imageColumn, JKQTPlotter *parent)
	class constructor

	JKQTPColumnMathImage (double x, double y, double width, double height, int imageColumn, JKQTPMathImageColorPalette palette, JKQTPlotter *parent)
	class constructor

	JKQTPColumnMathImage (double x, double y, double width, double height, int imageColumn, JKQTPMathImageColorPalette palette=JKQTPMathImageGRAY, JKQTBasePlotter *parent=nullptr)
	class constructor

	JKQTPColumnMathImage (double x, double y, double width, double height, JKQTBasePlotter *parent=nullptr)
	class constructor

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

	JKQTPColumnMathImage (JKQTBasePlotter *parent=nullptr)
	class constructor

	JKQTPColumnMathImage (JKQTPlotter *parent)
	class constructor

int	getImageColumn () const
	column containing the displayed image

int	getModifierColumn () const
	column containing the modifier image

virtual void	setImageColumn (int __value)
	column containing the displayed image

virtual void	setImageColumn (size_t __value)
	column containing the displayed image

virtual void	setModifierColumn (int __value)
	column containing the modifier image

virtual void	setModifierColumn (size_t __value)
	column containing the modifier image

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

Public Member Functions inherited from JKQTPMathImage
	JKQTPMathImage (double x, double y, double width, double height, JKQTPMathImageDataType datatype, const void data, int Nx, int Ny, JKQTPMathImageColorPalette palette, JKQTPlotter parent)
	class constructor

	JKQTPMathImage (double x, double y, double width, double height, JKQTPMathImageDataType datatype, const void data, int Nx, int Ny, JKQTPMathImageColorPalette palette=JKQTPMathImageGRAY, JKQTBasePlotter parent=nullptr)
	class constructor

	JKQTPMathImage (JKQTBasePlotter *parent=nullptr)
	class constructor

	JKQTPMathImage (JKQTPlotter *parent)
	class constructor

virtual void	cbGetDataMinMax (double &imin, double &imax) override
	determine min/max data value of the image

virtual void	cbGetModifierDataMinMax (double &imin, double &imax) override
	determine min/max data value of the modifier image

virtual void	draw (JKQTPEnhancedPainter &painter) override
	plots the graph to the plotter object specified as parent

virtual QImage	drawImage ()
	return the plotted image only as a QImage

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

virtual void	drawOutside (JKQTPEnhancedPainter &painter, QRect leftSpace, QRect rightSpace, QRect topSpace, QRect bottomSpace) override
	plots outside the actual plot field of view (e.g. color bars, scale bars, ...)

virtual QImage	drawOutsidePalette (uint8_t steps=200)
	returns a QImage, which contains the plaette drawn outside the plot. steps is the number of data-setps (and the size of the output image) used for the palette image.

virtual void	getDataMinMax (double &imin, double &imax) override
	determine min/max data value of the image

virtual void	getModifierMinMax (double &imin, double &imax) override
	determine min/max data value of the image

double	getModifierPixelValue (int xIdx, int yIdx) const
	retrieve modifier image data at a given position as double

int	getModifierSampleSize () const
	retrieve size of a single sample in the modifier image data (i.e. size of the datatype)

double	getModifierValueAt (double x, double y)
	return the value (raw data!) of the contained modifier image at the given coordinate

virtual void	getOutsideSize (JKQTPEnhancedPainter &painter, int &leftSpace, int &rightSpace, int &topSpace, int &bottomSpace) override
	if the graph plots outside the actual plot field of view (e.g. color bars, scale bars, ...)

double	getPixelValue (int xIdx, int yIdx) const
	retrieve image data at a given position as double

int	getSampleSize () const
	retrieve size of a single sample in the image data (i.e. size of the datatype)

double	getValueAt (double x, double y)
	return the value (raw data!) of the contained image at the given coordinate

virtual void	setParent (JKQTBasePlotter *parent) override
	sets the parent painter class

virtual void	setTitle (const QString &title) override
	sets the title of the plot (for display in key!).

Public Member Functions inherited from JKQTPMathImageBase
	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 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 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

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

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

QImage	generateKeyMarker (QSize size=QSize(16, 16))
	returns an image with a key marker inside

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 (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 JKQTPColorPaletteWithModifierStyleAndToolsMixin
	JKQTPColorPaletteWithModifierStyleAndToolsMixin (JKQTBasePlotter *parent)

virtual	~JKQTPColorPaletteWithModifierStyleAndToolsMixin ()=default

virtual void	cbDrawOutside (JKQTPEnhancedPainter &painter, QRect leftSpace, QRect rightSpace, QRect topSpace, QRect bottomSpace) override
	plots outside the actual plot field of view (e.g. color bars, scale bars, ...)

virtual void	cbGetOutsideSize (JKQTPEnhancedPainter &painter, int &leftSpace, int &rightSpace, int &topSpace, int &bottomSpace) override
	if the graph plots outside the actual plot field of view (e.g. color bars, scale bars, ...)

virtual void	cbSetParent (JKQTBasePlotter *parent) override
	set the parent class for internal objects (e.g. color bars)

bool	getAutoModifierRange () const
	indicates whether to estimate min/max of the modifier automatically

double	getColorBarModifiedWidth () const
	width of the color bar when modifier is on

JKQTPHorizontalIndependentAxis *	getModifierColorBarRightAxis ()
	object used for color bar axes (top border, modifier image data)

const JKQTPHorizontalIndependentAxis *	getModifierColorBarRightAxis () const
	object used for color bar axes (top border, modifier image data)

JKQTPVerticalIndependentAxis *	getModifierColorBarTopAxis ()
	object used for color bar axes (right border, modifier image data)

const JKQTPVerticalIndependentAxis *	getModifierColorBarTopAxis () const
	object used for color bar axes (right border, modifier image data)

double	getModifierMax () const
	modifier value range maximum

double	getModifierMin () const
	modifier value range minimum

JKQTPMathImageModifierMode	getModifierMode () const
	how to apply the modifier column dataModifier

void	modifyImage (QImage &img, const void *dataModifier, JKQTPMathImageDataType datatypeModifier, int Nx, int Ny, double internalModifierMin, double internalModifierMax)
	modify the given image img, using modifier image dataModifier (of type datatypeModifier and size Nx * Ny), using values in the range internalModifierMin ... internalModifierMax

void	setAutoModifierRange (bool __value)
	indicates whether to estimate min/max of the modifier automatically

void	setColorBarModifiedWidth (double __value)
	width of the color bar when modifier is on

void	setModifierMax (double __value)
	modifier value range maximum

void	setModifierMin (double __value)
	modifier value range minimum

void	setModifierMode (const JKQTPMathImageModifierMode &__value)
	how to apply the modifier column dataModifier

Public Member Functions inherited from JKQTPColorPaletteStyleAndToolsMixin
	JKQTPColorPaletteStyleAndToolsMixin (JKQTBasePlotter *parent)

virtual	~JKQTPColorPaletteStyleAndToolsMixin ()

JKQTPMathImageColorRangeFailAction	getActionRangeMaxFail () const
	which action to take if a color is above imageMax and autoImageRange `==false`

JKQTPMathImageColorRangeFailAction	getActionRangeMinFail () const
	which action to take if a color is below imageMin and autoImageRange `==false`

bool	getAutoImageRange () const
	indicates whether to estimate min/max of the image automatically

int	getColorBarOffset () const
	offset between outside space border and color bar

double	getColorBarRelativeHeight () const
	height of the color bar, as multiple of plotHeight

JKQTPVerticalIndependentAxis *	getColorBarRightAxis ()
	object used for color bar axes at the right

const JKQTPVerticalIndependentAxis *	getColorBarRightAxis () const
	object used for color bar axes at the right

bool	getColorBarRightVisible () const
	right color bar visible

JKQTPHorizontalIndependentAxis *	getColorBarTopAxis ()
	object used for color bar axes at the top

const JKQTPHorizontalIndependentAxis *	getColorBarTopAxis () const
	object used for color bar axes at the top

bool	getColorBarTopVisible () const
	top color bar visible

int	getColorBarWidth () const
	width of the color bar

JKQTPMathImageColorPalette	getColorPalette () const
	palette for plotting an image

double	getImageMax () const
	image value range maximum

double	getImageMin () const
	image value range minimum

QString	getImageName () const
	name of the image displayed above color bar (may contain LaTeX markup!)

QString	getImageNameFontName () const
	font name when displaying imageName

double	getImageNameFontSize () const
	font size in points when displaying imageName

QColor	getInfColor () const
	color to use for an infinity value

QColor	getNanColor () const
	color to use for a not-a-number value

QColor	getRangeMaxFailColor () const
	color to use for some settings of rangeMaxFailAction

QColor	getRangeMinFailColor () const
	color to use for some settings of rangeMinFailAction

bool	getShowColorBar () const
	indicate whether to display a color bar

void	setAutoImageRange (bool __value)
	indicates whether to estimate min/max of the image automatically

void	setColorBarOffset (int __value)
	offset between outside space border and color bar

void	setColorBarRelativeHeight (double __value)
	height of the color bar, as multiple of plotHeight

void	setColorBarRightVisible (bool __value)
	right color bar visible

void	setColorBarTopVisible (bool __value)
	top color bar visible

void	setColorBarWidth (int __value)
	width of the color bar

void	setColorPalette (const JKQTPMathImageColorPalette &__value)
	palette for plotting an image

void	setColorPalette (int pal)
	palette for plotting an image

void	setImageMax (double __value)
	image value range maximum

void	setImageMin (double __value)
	image value range minimum

void	setImageName (const QString &__value)
	name of the image displayed above color bar (may contain LaTeX markup!)

void	setImageNameFontName (const QString &__value)
	font name when displaying imageName

void	setImageNameFontSize (double __value)
	font size in points when displaying imageName

void	setInfColor (const QColor &__value)
	color to use for an infinity value

void	setNanColor (const QColor &__value)
	color to use for a not-a-number value

void	setRangeMaxFailAction (const JKQTPMathImageColorRangeFailAction &__value)
	which action to take if a color is above imageMax and autoImageRange `==false`

void	setRangeMaxFailColor (const QColor &__value)
	color to use for some settings of rangeMaxFailAction

void	setRangeMinFailAction (const JKQTPMathImageColorRangeFailAction &__value)
	which action to take if a color is below imageMin and autoImageRange `==false`

void	setRangeMinFailColor (const QColor &__value)
	color to use for some settings of rangeMinFailAction

void	setShowColorBar (bool __value)
	indicate whether to display a color bar

Protected Member Functions
virtual void	ensureImageData () override
	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 JKQTPMathImage
void	initJKQTPMathImage ()

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
int	imageColumn
	column containing the displayed image

int	modifierColumn
	column containing the modifier image

Protected Attributes inherited from JKQTPMathImage
QAction *	actCopyImage
	QActions that copies the image into the clipboard.

QAction *	actCopyPalette
	QActions that copies the current palette.

QAction *	actSaveImage
	QActions that saves the image (asking the user for a filename)

QAction *	actSavePalette
	QActions that saves the current palette.

Protected Attributes inherited from JKQTPMathImageBase
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

Protected Attributes inherited from JKQTPColorPaletteWithModifierStyleAndToolsMixin
bool	autoModifierRange
	indicates whether to estimate min/max of the modifier automatically

double	colorBarModifiedWidth
	width of the color bar when modifier is on

JKQTPHorizontalIndependentAxis *	modifierColorBarRightAxis
	object used for color bar axes (top border, modifier image data)

JKQTPVerticalIndependentAxis *	modifierColorBarTopAxis
	object used for color bar axes (right border, modifier image data)

double	modifierMax
	modifier value range maximum

double	modifierMin
	modifier value range minimum

JKQTPMathImageModifierMode	modifierMode
	how to apply the modifier column dataModifier

Protected Attributes inherited from JKQTPColorPaletteStyleAndToolsMixin
bool	autoImageRange
	indicates whether to estimate min/max of the image automatically

JKQTBasePlotter *	cbParent

int	colorBarOffset
	offset between outside space border and color bar

double	colorBarRelativeHeight
	height of the color bar, as multiple of plotHeight

JKQTPVerticalIndependentAxis *	colorBarRightAxis
	object used for color bar axes at the right

bool	colorBarRightVisible
	right color bar visible

JKQTPHorizontalIndependentAxis *	colorBarTopAxis
	object used for color bar axes at the top

bool	colorBarTopVisible
	top color bar visible

int	colorBarWidth
	width of the color bar

double	imageMax
	image value range maximum

double	imageMin
	image value range minimum

QString	imageName
	name of the image displayed above color bar (may contain LaTeX markup!)

QString	imageNameFontName
	font name when displaying imageName

double	imageNameFontSize
	font size in points when displaying imageName

QColor	infColor
	color to use for an infinity value

QColor	nanColor
	color to use for a not-a-number value

JKQTPMathImageColorPalette	palette
	palette for plotting an image

JKQTPMathImageColorRangeFailAction	rangeMaxFailAction
	which action to take if a color is above imageMax and autoImageRange `==false`

QColor	rangeMaxFailColor
	color to use for some settings of rangeMaxFailAction

JKQTPMathImageColorRangeFailAction	rangeMinFailAction
	which action to take if a color is below imageMin and autoImageRange `==false`

QColor	rangeMinFailColor
	color to use for some settings of rangeMinFailAction

bool	showColorBar
	indicate whether to display a color bar

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 JKQTPMathImage
void	copyColorbarPlotAsImage ()
	copies an image of the current palette into the clipboard

void	copyImagePlotAsImage ()
	copies the image into the clipboard

void	saveColorbarPlotAsImage (const QString &filename=QString(""), const QByteArray &outputFormat=QByteArray())
	saves an image of the current palette (asking the user for a filename, if filename is empty)

void	saveImagePlotAsImage (const QString &filename=QString(""), const QByteArray &outputFormat=QByteArray())
	saves the image (asking the user for a filename, if filename is empty)

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

void	setVisible (bool __value)
	sets whether the graph is visible in the plot

Static Public Member Functions inherited from JKQTPColorPaletteStyleAndToolsMixin
static QIcon	getPaletteIcon (int i)
	get QIcon representing the given palette

static QIcon	getPaletteIcon (JKQTPMathImageColorPalette palette)
	get QIcon representing the given palette

static QImage	getPaletteImage (int i, size_t width)
	get QIcon representing the given palette

static QImage	getPaletteImage (JKQTPMathImageColorPalette palette, size_t width)
	get QIcon representing the given palette

static QIcon	getPaletteKeyIcon (int i)
	get QIcon representing the given palette

static QIcon	getPaletteKeyIcon (JKQTPMathImageColorPalette palette)
	get QIcon representing the given palette

static QImage	getPaletteKeyImage (int i, size_t width, size_t height)
	get QIcon representing the given palette

static QImage	getPaletteKeyImage (JKQTPMathImageColorPalette palette, size_t width, size_t height)
	get QIcon representing the given palette

static QStringList	getPalettes ()
	get list with all available palettes

static int	getPalettesCount ()
	get list with all available palettes

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

class to plot an image from an 2-dimensional array of values stored in a column of the datastore

See also: jkqtpstatAddKDE2DImage(), jkqtpstatAddHistogram2DImage(), Example (JKQTPlotter): Simple math image plot, Example (JKQTPlotter): Simple math image plot with modifier datat, Example (JKQTPlotter): Simple math image plot, showin a 1-channel OpenCV cv::Mat

Constructor & Destructor Documentation

◆ JKQTPColumnMathImage() [1/7]

JKQTPColumnMathImage::JKQTPColumnMathImage ( JKQTBasePlotter * parent = nullptr )

class constructor

Parameters

parent parent plotter object

◆ JKQTPColumnMathImage() [2/7]

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

◆ JKQTPColumnMathImage() [3/7]

JKQTPColumnMathImage::JKQTPColumnMathImage	(	double	x,
		double	y,
		double	width,
		double	height,
		int	imageColumn,
		JKQTPMathImageColorPalette	palette = `JKQTPMathImageGRAY`,
		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
imageColumn	column to be plotted
palette	color palette to use for the plotting
parent	parent plotter object

◆ JKQTPColumnMathImage() [4/7]

JKQTPColumnMathImage::JKQTPColumnMathImage ( JKQTPlotter * parent )

class constructor

Parameters

parent parent plotter object

◆ JKQTPColumnMathImage() [5/7]

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

◆ JKQTPColumnMathImage() [6/7]

JKQTPColumnMathImage::JKQTPColumnMathImage	(	double	x,
		double	y,
		double	width,
		double	height,
		int	imageColumn,
		JKQTPMathImageColorPalette	palette,
		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
imageColumn	column to be plotted
palette	color palette to use for the plotting
parent	parent plotter object

◆ JKQTPColumnMathImage() [7/7]

JKQTPColumnMathImage::JKQTPColumnMathImage	(	double	x,
		double	y,
		double	width,
		double	height,
		int	imageColumn,
		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
imageColumn	column to be plotted
parent	parent plotter object

Member Function Documentation

◆ ensureImageData()

virtual void JKQTPColumnMathImage::ensureImageData ( )

overrideprotectedvirtual

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

Reimplemented from JKQTPMathImageBase.

◆ getImageColumn()

int JKQTPColumnMathImage::getImageColumn ( ) const

column containing the displayed image

◆ getModifierColumn()

int JKQTPColumnMathImage::getModifierColumn ( ) const

column containing the modifier image

◆ setImageColumn() [1/2]

virtual void JKQTPColumnMathImage::setImageColumn ( int __value )

virtual

column containing the displayed image

◆ setImageColumn() [2/2]

virtual void JKQTPColumnMathImage::setImageColumn ( size_t __value )

virtual

column containing the displayed image

◆ setModifierColumn() [1/2]

virtual void JKQTPColumnMathImage::setModifierColumn ( int __value )

virtual

column containing the modifier image

◆ setModifierColumn() [2/2]

virtual void JKQTPColumnMathImage::setModifierColumn ( size_t __value )

virtual

column containing the modifier image

◆ usesColumn()

virtual bool JKQTPColumnMathImage::usesColumn ( int c ) const

overridevirtual

returns true if the given column is used by the graph

This virtual function indicates whether a given column is used by this graph. Override this function in your derived graphs to indicate to JKQTPlotter / JKQTBasePlotter , which columns from the internal JKQTPDatastore are actually used. This information can be used e.g. for graph-specific data-export.

Reimplemented from JKQTPGraph.

Member Data Documentation

◆ imageColumn

int JKQTPColumnMathImage::imageColumn

protected

column containing the displayed image

◆ modifierColumn

int JKQTPColumnMathImage::modifierColumn

protected

column containing the modifier image

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

jkqtpimage.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ JKQTPColumnMathImage() [1/7]

◆ JKQTPColumnMathImage() [2/7]

◆ JKQTPColumnMathImage() [3/7]

◆ JKQTPColumnMathImage() [4/7]

◆ JKQTPColumnMathImage() [5/7]

◆ JKQTPColumnMathImage() [6/7]

◆ JKQTPColumnMathImage() [7/7]

Member Function Documentation

◆ ensureImageData()

◆ getImageColumn()

◆ getModifierColumn()

◆ setImageColumn() [1/2]

◆ setImageColumn() [2/2]

◆ setModifierColumn() [1/2]

◆ setModifierColumn() [2/2]

◆ usesColumn()

Member Data Documentation

◆ imageColumn

◆ modifierColumn