class to plot an image from an 2-dimensional array of RGB values More...

#include <jkqtpimagergb.h>

Inheritance diagram for JKQTPRGBMathImage:

Collaboration diagram for JKQTPRGBMathImage:

Public Slots
void	copyImagePlotAsImage ()
	copy the plotted image as an image into the clipboard

void	saveImagePlotAsImage (const QString &filename=QString(""), const QByteArray &outputFormat=QByteArray())
	save the plotted image as a file with filename and format outputFormat

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

Public Member Functions
	JKQTPRGBMathImage (double x, double y, double width, double height, JKQTPMathImageDataType datatype, const void data, int Nx, int Ny, JKQTBasePlotter parent=nullptr)
	class constructor

	JKQTPRGBMathImage (double x, double y, double width, double height, JKQTPMathImageDataType datatype, const void data, int Nx, int Ny, JKQTPlotter parent)
	class constructor

	JKQTPRGBMathImage (JKQTBasePlotter *parent=nullptr)
	class constructor

	JKQTPRGBMathImage (JKQTPlotter *parent)
	class constructor

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, ...)

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

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

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 (right border, red image data)

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

JKQTPVerticalIndependentAxis *	getColorBarRightAxisB ()
	object used for color bar axes (right border, blue image data)

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

JKQTPVerticalIndependentAxis *	getColorBarRightAxisG ()
	object used for color bar axes (right border, green image data)

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

JKQTPVerticalIndependentAxis *	getColorBarRightAxisR ()
	object used for color bar axes (right border, red image data)

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

bool	getColorBarRightVisible () const
	right color bar visible

bool	getColorbarsSideBySide () const
	if `true` the different color bars share the space of a single color bar, if set `false` each colorbar uses the space of a single colorbar

JKQTPHorizontalIndependentAxis *	getColorBarTopAxis ()
	object used for color bar axes (top border, red image data)

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

JKQTPHorizontalIndependentAxis *	getColorBarTopAxisB ()
	object used for color bar axes (top border, blue image data)

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

JKQTPHorizontalIndependentAxis *	getColorBarTopAxisG ()
	object used for color bar axes (top border, green image data)

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

JKQTPHorizontalIndependentAxis *	getColorBarTopAxisR ()
	object used for color bar axes (top border, red image data)

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

bool	getColorBarTopVisible () const
	top color bar visible

int	getColorBarWidth () const
	width of the color bar

const void *	getDataB () const
	points to the data array, holding the image

QVector< double >	getDataBAsDoubleVector () const
	return the data of the blue channel used for plotting as a QVector<double> in row-major data-ordering

const void *	getDataG () const
	points to the data array, holding the image

QVector< double >	getDataGAsDoubleVector () const
	return the data of the green channel used for plotting as a QVector<double> in row-major data-ordering

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

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

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

const void *	getDataR () const
	points to the data array, holding the image

JKQTPMathImageDataType	getDatatypeB () const
	datatype of the data array data

JKQTPMathImageDataType	getDatatypeG () const
	datatype of the data array data

JKQTPMathImageDataType	getDatatypeR () const
	datatype of the data array data

double	getImageMax () const
	red image value range maximum

double	getImageMaxB () const
	blue image value range maximum

double	getImageMaxG () const
	green image value range maximum

double	getImageMin () const
	red image value range minimum

double	getImageMinB () const
	blue image value range minimum

double	getImageMinG () const
	green image value range minimum

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

QString	getImageNameB () const
	name of the blue image channel 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

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

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

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

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, ...)

JKQTPRGBMathImageRGBMode	getRgbMode () const
	how to interpret the three data channels red, green and blue

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

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

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

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	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	setColorbarsSideBySide (bool __value)
	if `true` the different color bars share the space of a single color bar, if set `false` each colorbar uses the space of a single colorbar

void	setColorBarTopVisible (bool __value)
	top color bar visible

void	setColorBarWidth (int __value)
	width of the color bar

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	setData (const void dataR, const void dataG, const void *dataB, int Nx, int Ny)
	set the plot-data to a given array data (red), dataG (green), dataB (blue) with size Nx * Ny in row-major ordering

virtual void	setData (const void dataR, const void dataG, const void *dataB, int Nx, int Ny, JKQTPMathImageDataType datatype)
	set the plot-data to a given array data (red), dataG (green), dataB (blue) with size Nx * Ny in row-major ordering and with the given datatype

virtual void	setData (const void *dataR, int Nx, int Ny) override
	set the plot-data to a given array data (red) with size Nx * Ny in row-major ordering

virtual void	setData (const void *dataR, int Nx, int Ny, JKQTPMathImageDataType datatype) override
	set the plot-data to a given array data (red) with size Nx * Ny in row-major ordering and with the given datatype

virtual void	setDataB (const void *__value)
	points to the data array, holding the image

virtual void	setDataG (const void *__value)
	points to the data array, holding the image

virtual void	setDataR (const void *__value)
	points to the data array, holding the image

void	setDatatypeB (JKQTPMathImageDataType __value)
	datatype of the data array data

void	setDatatypeG (JKQTPMathImageDataType __value)
	datatype of the data array data

void	setDatatypeR (JKQTPMathImageDataType __value)
	datatype of the data array data

void	setImageMax (double __value)
	red image value range maximum

void	setImageMaxB (double __value)
	blue image value range maximum

void	setImageMaxG (double __value)
	green image value range maximum

void	setImageMaxR (double m)
	red image value range maximum

void	setImageMin (double __value)
	red image value range minimum

void	setImageMinB (double __value)
	blue image value range minimum

void	setImageMinG (double __value)
	green image value range minimum

void	setImageMinR (double m)
	red image value range minimum

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

void	setImageNameB (const QString &__value)
	name of the blue image channel 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	setImageNameG (const QString &__value)
	name of the green image channel displayed above color bar (may contain LaTeX markup!)

void	setImageNameR (const QString &m)
	name of the red image channel displayed above color bar (may contain LaTeX markup!)

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

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

void	setRgbMode (JKQTPRGBMathImageRGBMode __value)
	how to interpret the three data channels red, green and blue

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

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

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	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

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

Protected Member Functions
void	initObject ()

Protected Member Functions inherited from JKQTPMathImageBase
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
QAction *	actCopyImage
	action that calls copyImagePlotAsImage()

QAction *	actSaveImage
	action that calls saveImagePlotAsImage()

bool	autoImageRange
	indicates whether to estimate min/max of the image automatically

bool	autoModifierRange
	indicates whether to estimate min/max of the modifier automatically

double	colorBarModifiedWidth
	width of the color bar when modifier is on

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 (right border, red image data)

JKQTPVerticalIndependentAxis *	colorBarRightAxisB
	object used for color bar axes (right border, blue image data)

JKQTPVerticalIndependentAxis *	colorBarRightAxisG
	object used for color bar axes (right border, green image data)

bool	colorBarRightVisible
	right color bar visible

bool	colorbarsSideBySide
	if `true` the different color bars share the space of a single color bar, if set `false` each colorbar uses the space of a single colorbar

JKQTPHorizontalIndependentAxis *	colorBarTopAxis
	object used for color bar axes (top border, red image data)

JKQTPHorizontalIndependentAxis *	colorBarTopAxisB
	object used for color bar axes (top border, blue image data)

JKQTPHorizontalIndependentAxis *	colorBarTopAxisG
	object used for color bar axes (top border, green image data)

bool	colorBarTopVisible
	top color bar visible

int	colorBarWidth
	width of the color bar

const void *	dataB
	points to the data array, holding the image

const void *	dataG
	points to the data array, holding the image

JKQTPMathImageDataType	datatypeB
	datatype of the data array data

JKQTPMathImageDataType	datatypeG
	datatype of the data array data

double	imageMaxB
	blue image value range maximum

double	imageMaxG
	green image value range maximum

double	imageMaxR
	red image value range maximum

double	imageMinB
	blue image value range minimum

double	imageMinG
	green image value range minimum

double	imageMinR
	red image value range minimum

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

QString	imageNameFontName
	font name when displaying imageName

double	imageNameFontSize
	font size in points when displaying imageName

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

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

double	internalDataMaxB
	internal storage for maximum of the blue image value range

double	internalDataMaxG
	internal storage for maximum of the green image value range

double	internalDataMinB
	internal storage for minimum of the blue image value range

double	internalDataMinG
	internal storage for minimum of the green image value range

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

JKQTPRGBMathImageRGBMode	rgbMode
	how to interpret the three data channels red, green and blue

bool	showColorBar
	indicate whether to display a color bar

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

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

class to plot an image from an 2-dimensional array of RGB values

This class extends JKQTPMathImageBase and interprets the data array JKQTPMathImageBase::data as the 1st (RED) color channel and adds two more channels for GREEN and BLUE.

Using setRgbMode() you can also use a different color system than RGB.

See also: Examples: Example (JKQTPlotter): Simple Math RGB/CMY Image Plot and Example (JKQTPlotter): Simple RGB image plot, showing a 3-channel OpenCV cv::Mat

Constructor & Destructor Documentation

◆ JKQTPRGBMathImage() [1/4]

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

◆ JKQTPRGBMathImage() [2/4]

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

◆ JKQTPRGBMathImage() [3/4]

JKQTPRGBMathImage::JKQTPRGBMathImage ( JKQTBasePlotter * parent = nullptr )

class constructor

Parameters

parent parent plotter object

◆ JKQTPRGBMathImage() [4/4]

JKQTPRGBMathImage::JKQTPRGBMathImage ( JKQTPlotter * parent )

class constructor

Parameters

parent parent plotter object

Member Function Documentation

◆ copyImagePlotAsImage

void JKQTPRGBMathImage::copyImagePlotAsImage ( )

slot

copy the plotted image as an image into the clipboard

◆ draw()

virtual void JKQTPRGBMathImage::draw ( JKQTPEnhancedPainter & painter )

overridevirtual

plots the graph to the plotter object specified as parent

Implements JKQTPPlotElement.

◆ drawImage()

virtual QImage JKQTPRGBMathImage::drawImage ( )

virtual

return the plotted image only as a QImage

◆ drawKeyMarker()

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

overridevirtual

plots a key marker inside the specified rectangle rect

Reimplemented from JKQTPMathImageBase.

◆ drawOutside()

virtual void JKQTPRGBMathImage::drawOutside	(	JKQTPEnhancedPainter &	painter,
		QRect	leftSpace,
		QRect	rightSpace,
		QRect	topSpace,
		QRect	bottomSpace
	)

overridevirtual

plots outside the actual plot field of view (e.g. color bars, scale bars, ...)

Note: If you want to draw outside, then you'll also have to implement getOutsideSize(), so enough space is reserved

The four value supplied tell the method where to draw (inside one of the rectangles).

Reimplemented from JKQTPPlotElement.

◆ getAutoImageRange()

bool JKQTPRGBMathImage::getAutoImageRange ( ) const

indicates whether to estimate min/max of the image automatically

◆ getAutoModifierRange()

bool JKQTPRGBMathImage::getAutoModifierRange ( ) const

indicates whether to estimate min/max of the modifier automatically

◆ getColorBarModifiedWidth()

double JKQTPRGBMathImage::getColorBarModifiedWidth ( ) const

width of the color bar when modifier is on

◆ getColorBarOffset()

int JKQTPRGBMathImage::getColorBarOffset ( ) const

offset between outside space border and color bar

◆ getColorBarRelativeHeight()

double JKQTPRGBMathImage::getColorBarRelativeHeight ( ) const

height of the color bar, as multiple of plotHeight

◆ getColorBarRightAxis() [1/2]

JKQTPVerticalIndependentAxis * JKQTPRGBMathImage::getColorBarRightAxis ( )

object used for color bar axes (right border, red image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarRightAxis() [2/2]

const JKQTPVerticalIndependentAxis * JKQTPRGBMathImage::getColorBarRightAxis ( ) const

object used for color bar axes (right border, red image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarRightAxisB() [1/2]

JKQTPVerticalIndependentAxis * JKQTPRGBMathImage::getColorBarRightAxisB ( )

object used for color bar axes (right border, blue image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarRightAxisB() [2/2]

const JKQTPVerticalIndependentAxis * JKQTPRGBMathImage::getColorBarRightAxisB ( ) const

object used for color bar axes (right border, blue image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarRightAxisG() [1/2]

JKQTPVerticalIndependentAxis * JKQTPRGBMathImage::getColorBarRightAxisG ( )

object used for color bar axes (right border, green image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarRightAxisG() [2/2]

const JKQTPVerticalIndependentAxis * JKQTPRGBMathImage::getColorBarRightAxisG ( ) const

object used for color bar axes (right border, green image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarRightAxisR() [1/2]

JKQTPVerticalIndependentAxis * JKQTPRGBMathImage::getColorBarRightAxisR ( )

object used for color bar axes (right border, red image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarRightAxisR() [2/2]

const JKQTPVerticalIndependentAxis * JKQTPRGBMathImage::getColorBarRightAxisR ( ) const

object used for color bar axes (right border, red image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarRightVisible()

bool JKQTPRGBMathImage::getColorBarRightVisible ( ) const

right color bar visible

◆ getColorbarsSideBySide()

bool JKQTPRGBMathImage::getColorbarsSideBySide ( ) const

if true the different color bars share the space of a single color bar, if set false each colorbar uses the space of a single colorbar

◆ getColorBarTopAxis() [1/2]

JKQTPHorizontalIndependentAxis * JKQTPRGBMathImage::getColorBarTopAxis ( )

object used for color bar axes (top border, red image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarTopAxis() [2/2]

const JKQTPHorizontalIndependentAxis * JKQTPRGBMathImage::getColorBarTopAxis ( ) const

object used for color bar axes (top border, red image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarTopAxisB() [1/2]

JKQTPHorizontalIndependentAxis * JKQTPRGBMathImage::getColorBarTopAxisB ( )

object used for color bar axes (top border, blue image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarTopAxisB() [2/2]

const JKQTPHorizontalIndependentAxis * JKQTPRGBMathImage::getColorBarTopAxisB ( ) const

object used for color bar axes (top border, blue image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarTopAxisG() [1/2]

JKQTPHorizontalIndependentAxis * JKQTPRGBMathImage::getColorBarTopAxisG ( )

object used for color bar axes (top border, green image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarTopAxisG() [2/2]

const JKQTPHorizontalIndependentAxis * JKQTPRGBMathImage::getColorBarTopAxisG ( ) const

object used for color bar axes (top border, green image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarTopAxisR() [1/2]

JKQTPHorizontalIndependentAxis * JKQTPRGBMathImage::getColorBarTopAxisR ( )

object used for color bar axes (top border, red image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarTopAxisR() [2/2]

const JKQTPHorizontalIndependentAxis * JKQTPRGBMathImage::getColorBarTopAxisR ( ) const

object used for color bar axes (top border, red image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarTopVisible()

bool JKQTPRGBMathImage::getColorBarTopVisible ( ) const

top color bar visible

◆ getColorBarWidth()

int JKQTPRGBMathImage::getColorBarWidth ( ) const

width of the color bar

◆ getDataB()

const void * JKQTPRGBMathImage::getDataB ( ) const

points to the data array, holding the image

◆ getDataBAsDoubleVector()

QVector< double > JKQTPRGBMathImage::getDataBAsDoubleVector ( ) const

return the data of the blue channel used for plotting as a QVector<double> in row-major data-ordering

◆ getDataG()

const void * JKQTPRGBMathImage::getDataG ( ) const

points to the data array, holding the image

◆ getDataGAsDoubleVector()

QVector< double > JKQTPRGBMathImage::getDataGAsDoubleVector ( ) const

return the data of the green channel used for plotting as a QVector<double> in row-major data-ordering

◆ getDataMinMax()

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

overridevirtual

determine min/max data value of the image

Reimplemented from JKQTPMathImageBase.

◆ getDataMinMaxB()

virtual void JKQTPRGBMathImage::getDataMinMaxB	(	double &	imin,
		double &	imax
	)

virtual

determine min/max data value of the image

◆ getDataMinMaxG()

virtual void JKQTPRGBMathImage::getDataMinMaxG	(	double &	imin,
		double &	imax
	)

virtual

determine min/max data value of the image

◆ getDataR()

const void * JKQTPRGBMathImage::getDataR ( ) const

points to the data array, holding the image

◆ getDatatypeB()

JKQTPMathImageDataType JKQTPRGBMathImage::getDatatypeB ( ) const

datatype of the data array data

◆ getDatatypeG()

JKQTPMathImageDataType JKQTPRGBMathImage::getDatatypeG ( ) const

datatype of the data array data

◆ getDatatypeR()

JKQTPMathImageDataType JKQTPRGBMathImage::getDatatypeR ( ) const

datatype of the data array data

◆ getImageMax()

double JKQTPRGBMathImage::getImageMax ( ) const

red image value range maximum

◆ getImageMaxB()

double JKQTPRGBMathImage::getImageMaxB ( ) const

blue image value range maximum

◆ getImageMaxG()

double JKQTPRGBMathImage::getImageMaxG ( ) const

green image value range maximum

◆ getImageMin()

double JKQTPRGBMathImage::getImageMin ( ) const

red image value range minimum

◆ getImageMinB()

double JKQTPRGBMathImage::getImageMinB ( ) const

blue image value range minimum

◆ getImageMinG()

double JKQTPRGBMathImage::getImageMinG ( ) const

green image value range minimum

◆ getImageName()

QString JKQTPRGBMathImage::getImageName ( ) const

name of the red image channel displayed above color bar (may contain LaTeX markup!)

◆ getImageNameB()

QString JKQTPRGBMathImage::getImageNameB ( ) const

name of the blue image channel displayed above color bar (may contain LaTeX markup!)

◆ getImageNameFontName()

QString JKQTPRGBMathImage::getImageNameFontName ( ) const

font name when displaying imageName

◆ getImageNameFontSize()

double JKQTPRGBMathImage::getImageNameFontSize ( ) const

font size in points when displaying imageName

◆ getImageNameG()

QString JKQTPRGBMathImage::getImageNameG ( ) const

name of the green image channel displayed above color bar (may contain LaTeX markup!)

◆ getImageNameR()

QString JKQTPRGBMathImage::getImageNameR ( ) const

name of the red image channel displayed above color bar (may contain LaTeX markup!)

◆ getModifierColorBarRightAxis() [1/2]

JKQTPHorizontalIndependentAxis * JKQTPRGBMathImage::getModifierColorBarRightAxis ( )

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

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getModifierColorBarRightAxis() [2/2]

const JKQTPHorizontalIndependentAxis * JKQTPRGBMathImage::getModifierColorBarRightAxis ( ) const

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

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getModifierColorBarTopAxis() [1/2]

JKQTPVerticalIndependentAxis * JKQTPRGBMathImage::getModifierColorBarTopAxis ( )

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

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getModifierColorBarTopAxis() [2/2]

const JKQTPVerticalIndependentAxis * JKQTPRGBMathImage::getModifierColorBarTopAxis ( ) const

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

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getModifierMax()

double JKQTPRGBMathImage::getModifierMax ( ) const

modifier value range maximum

◆ getModifierMin()

double JKQTPRGBMathImage::getModifierMin ( ) const

modifier value range minimum

◆ getModifierMode()

JKQTPMathImageModifierMode JKQTPRGBMathImage::getModifierMode ( ) const

how to apply the modifier column dataModifier

See also: ModifierMode

◆ getOutsideSize()

virtual void JKQTPRGBMathImage::getOutsideSize	(	JKQTPEnhancedPainter &	painter,
		int &	leftSpace,
		int &	rightSpace,
		int &	topSpace,
		int &	bottomSpace
	)

overridevirtual

if the graph plots outside the actual plot field of view (e.g. color bars, scale bars, ...)

Note: If you want to draw outside, then you'll also have to implement drawOutside()

Reimplemented from JKQTPPlotElement.

◆ getRgbMode()

JKQTPRGBMathImageRGBMode JKQTPRGBMathImage::getRgbMode ( ) const

how to interpret the three data channels red, green and blue

◆ getShowColorBar()

bool JKQTPRGBMathImage::getShowColorBar ( ) const

indicate whether to display a color bar

◆ getValueAt()

double JKQTPRGBMathImage::getValueAt	(	double	x,
		double	y,
		int	channel = `0`
	)

return the value (raw data!) of the contained image at the given coordinate

◆ initObject()

void JKQTPRGBMathImage::initObject ( )

protected

◆ saveImagePlotAsImage

void JKQTPRGBMathImage::saveImagePlotAsImage	(	const QString &	filename = `QString("")`,
		const QByteArray &	outputFormat = `QByteArray()`
	)

slot

save the plotted image as a file with filename and format outputFormat

◆ setAutoImageRange()

void JKQTPRGBMathImage::setAutoImageRange ( bool __value )

indicates whether to estimate min/max of the image automatically

◆ setAutoModifierRange()

void JKQTPRGBMathImage::setAutoModifierRange ( bool __value )

indicates whether to estimate min/max of the modifier automatically

◆ setColorBarModifiedWidth()

void JKQTPRGBMathImage::setColorBarModifiedWidth ( double __value )

width of the color bar when modifier is on

◆ setColorBarOffset()

void JKQTPRGBMathImage::setColorBarOffset ( int __value )

offset between outside space border and color bar

◆ setColorBarRelativeHeight()

void JKQTPRGBMathImage::setColorBarRelativeHeight ( double __value )

height of the color bar, as multiple of plotHeight

◆ setColorBarRightVisible()

void JKQTPRGBMathImage::setColorBarRightVisible ( bool __value )

right color bar visible

◆ setColorbarsSideBySide()

void JKQTPRGBMathImage::setColorbarsSideBySide ( bool __value )

if true the different color bars share the space of a single color bar, if set false each colorbar uses the space of a single colorbar

◆ setColorBarTopVisible()

void JKQTPRGBMathImage::setColorBarTopVisible ( bool __value )

top color bar visible

◆ setColorBarWidth()

void JKQTPRGBMathImage::setColorBarWidth ( int __value )

width of the color bar

◆ setData() [1/7]

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

virtual

points to the data array, holding the image

Reimplemented from JKQTPMathImageBase.

◆ setData() [2/7]

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 from JKQTPMathImageBase.

◆ setData() [3/7]

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 from JKQTPMathImageBase.

◆ setData() [4/7]

virtual void JKQTPRGBMathImage::setData	(	const void *	dataR,
		const void *	dataG,
		const void *	dataB,
		int	Nx,
		int	Ny
	)

virtual

set the plot-data to a given array data (red), dataG (green), dataB (blue) with size Nx * Ny in row-major ordering

Reimplemented in JKQTPColumnRGBMathImage.

◆ setData() [5/7]

virtual void JKQTPRGBMathImage::setData	(	const void *	dataR,
		const void *	dataG,
		const void *	dataB,
		int	Nx,
		int	Ny,
		JKQTPMathImageDataType	datatype
	)

virtual

set the plot-data to a given array data (red), dataG (green), dataB (blue) with size Nx * Ny in row-major ordering and with the given datatype

Reimplemented in JKQTPColumnRGBMathImage.

◆ setData() [6/7]

virtual void JKQTPRGBMathImage::setData	(	const void *	dataR,
		int	Nx,
		int	Ny
	)

overridevirtual

set the plot-data to a given array data (red) with size Nx * Ny in row-major ordering

Reimplemented from JKQTPMathImageBase.

Reimplemented in JKQTPColumnRGBMathImage, and JKQTPColumnRGBMathImage.

◆ setData() [7/7]

virtual void JKQTPRGBMathImage::setData	(	const void *	dataR,
		int	Nx,
		int	Ny,
		JKQTPMathImageDataType	datatype
	)

overridevirtual

set the plot-data to a given array data (red) with size Nx * Ny in row-major ordering and with the given datatype

Reimplemented from JKQTPMathImageBase.

Reimplemented in JKQTPColumnRGBMathImage, and JKQTPColumnRGBMathImage.

◆ setDataB()

virtual void JKQTPRGBMathImage::setDataB ( const void * __value )

virtual

points to the data array, holding the image

Reimplemented in JKQTPColumnRGBMathImage.

◆ setDataG()

virtual void JKQTPRGBMathImage::setDataG ( const void * __value )

virtual

points to the data array, holding the image

Reimplemented in JKQTPColumnRGBMathImage.

◆ setDataR()

virtual void JKQTPRGBMathImage::setDataR ( const void * __value )

virtual

points to the data array, holding the image

Reimplemented in JKQTPColumnRGBMathImage.

◆ setDatatypeB()

void JKQTPRGBMathImage::setDatatypeB ( JKQTPMathImageDataType __value )

datatype of the data array data

◆ setDatatypeG()

void JKQTPRGBMathImage::setDatatypeG ( JKQTPMathImageDataType __value )

datatype of the data array data

◆ setDatatypeR()

void JKQTPRGBMathImage::setDatatypeR ( JKQTPMathImageDataType __value )

datatype of the data array data

◆ setImageMax()

void JKQTPRGBMathImage::setImageMax ( double __value )

red image value range maximum

◆ setImageMaxB()

void JKQTPRGBMathImage::setImageMaxB ( double __value )

blue image value range maximum

◆ setImageMaxG()

void JKQTPRGBMathImage::setImageMaxG ( double __value )

green image value range maximum

◆ setImageMaxR()

void JKQTPRGBMathImage::setImageMaxR ( double m )

red image value range maximum

◆ setImageMin()

void JKQTPRGBMathImage::setImageMin ( double __value )

red image value range minimum

◆ setImageMinB()

void JKQTPRGBMathImage::setImageMinB ( double __value )

blue image value range minimum

◆ setImageMinG()

void JKQTPRGBMathImage::setImageMinG ( double __value )

green image value range minimum

◆ setImageMinR()

void JKQTPRGBMathImage::setImageMinR ( double m )

red image value range minimum

◆ setImageName()

void JKQTPRGBMathImage::setImageName ( const QString & __value )

name of the red image channel displayed above color bar (may contain LaTeX markup!)

◆ setImageNameB()

void JKQTPRGBMathImage::setImageNameB ( const QString & __value )

name of the blue image channel displayed above color bar (may contain LaTeX markup!)

◆ setImageNameFontName()

void JKQTPRGBMathImage::setImageNameFontName ( const QString & __value )

font name when displaying imageName

◆ setImageNameFontSize()

void JKQTPRGBMathImage::setImageNameFontSize ( double __value )

font size in points when displaying imageName

◆ setImageNameG()

void JKQTPRGBMathImage::setImageNameG ( const QString & __value )

name of the green image channel displayed above color bar (may contain LaTeX markup!)

◆ setImageNameR()

void JKQTPRGBMathImage::setImageNameR ( const QString & m )

name of the red image channel displayed above color bar (may contain LaTeX markup!)

◆ setModifierMax()

void JKQTPRGBMathImage::setModifierMax ( double __value )

modifier value range maximum

◆ setModifierMin()

void JKQTPRGBMathImage::setModifierMin ( double __value )

modifier value range minimum

◆ setModifierMode()

void JKQTPRGBMathImage::setModifierMode ( const JKQTPMathImageModifierMode & __value )

how to apply the modifier column dataModifier

See also: ModifierMode

◆ setParent()

virtual void JKQTPRGBMathImage::setParent ( JKQTBasePlotter * parent )

overridevirtual

sets the parent painter class

Reimplemented from JKQTPPlotElement.

◆ setRgbMode()

void JKQTPRGBMathImage::setRgbMode ( JKQTPRGBMathImageRGBMode __value )

how to interpret the three data channels red, green and blue

◆ setShowColorBar()

void JKQTPRGBMathImage::setShowColorBar ( bool __value )

indicate whether to display a color bar

◆ setTitle()

virtual void JKQTPRGBMathImage::setTitle ( const QString & title )

overridevirtual

sets the title of the plot (for display in key!).

Note: If no title is supplied, no key entry is drawn.

Reimplemented from JKQTPPlotElement.

Member Data Documentation

◆ actCopyImage

QAction* JKQTPRGBMathImage::actCopyImage

protected

action that calls copyImagePlotAsImage()

◆ actSaveImage

QAction* JKQTPRGBMathImage::actSaveImage

protected

action that calls saveImagePlotAsImage()

◆ autoImageRange

bool JKQTPRGBMathImage::autoImageRange

protected

indicates whether to estimate min/max of the image automatically

◆ autoModifierRange

bool JKQTPRGBMathImage::autoModifierRange

protected

indicates whether to estimate min/max of the modifier automatically

◆ colorBarModifiedWidth

double JKQTPRGBMathImage::colorBarModifiedWidth

protected

width of the color bar when modifier is on

◆ colorBarOffset

int JKQTPRGBMathImage::colorBarOffset

protected

offset between outside space border and color bar

◆ colorBarRelativeHeight

double JKQTPRGBMathImage::colorBarRelativeHeight

protected

height of the color bar, as multiple of plotHeight

◆ colorBarRightAxis

JKQTPVerticalIndependentAxis* JKQTPRGBMathImage::colorBarRightAxis

protected

object used for color bar axes (right border, red image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ colorBarRightAxisB

JKQTPVerticalIndependentAxis* JKQTPRGBMathImage::colorBarRightAxisB

protected

object used for color bar axes (right border, blue image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ colorBarRightAxisG

JKQTPVerticalIndependentAxis* JKQTPRGBMathImage::colorBarRightAxisG

protected

object used for color bar axes (right border, green image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ colorBarRightVisible

bool JKQTPRGBMathImage::colorBarRightVisible

protected

right color bar visible

◆ colorbarsSideBySide

bool JKQTPRGBMathImage::colorbarsSideBySide

protected

if true the different color bars share the space of a single color bar, if set false each colorbar uses the space of a single colorbar

◆ colorBarTopAxis

JKQTPHorizontalIndependentAxis* JKQTPRGBMathImage::colorBarTopAxis

protected

object used for color bar axes (top border, red image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ colorBarTopAxisB

JKQTPHorizontalIndependentAxis* JKQTPRGBMathImage::colorBarTopAxisB

protected

object used for color bar axes (top border, blue image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ colorBarTopAxisG

JKQTPHorizontalIndependentAxis* JKQTPRGBMathImage::colorBarTopAxisG

protected

object used for color bar axes (top border, green image data)

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ colorBarTopVisible

bool JKQTPRGBMathImage::colorBarTopVisible

protected

top color bar visible

◆ colorBarWidth

int JKQTPRGBMathImage::colorBarWidth

protected

width of the color bar

◆ dataB

const void* JKQTPRGBMathImage::dataB

protected

points to the data array, holding the image

◆ dataG

const void* JKQTPRGBMathImage::dataG

protected

points to the data array, holding the image

◆ datatypeB

JKQTPMathImageDataType JKQTPRGBMathImage::datatypeB

protected

datatype of the data array data

◆ datatypeG

JKQTPMathImageDataType JKQTPRGBMathImage::datatypeG

protected

datatype of the data array data

◆ imageMaxB

double JKQTPRGBMathImage::imageMaxB

protected

blue image value range maximum

◆ imageMaxG

double JKQTPRGBMathImage::imageMaxG

protected

green image value range maximum

◆ imageMaxR

double JKQTPRGBMathImage::imageMaxR

protected

red image value range maximum

◆ imageMinB

double JKQTPRGBMathImage::imageMinB

protected

blue image value range minimum

◆ imageMinG

double JKQTPRGBMathImage::imageMinG

protected

green image value range minimum

◆ imageMinR

double JKQTPRGBMathImage::imageMinR

protected

red image value range minimum

◆ imageNameB

QString JKQTPRGBMathImage::imageNameB

protected

name of the blue image channel displayed above color bar (may contain LaTeX markup!)

◆ imageNameFontName

QString JKQTPRGBMathImage::imageNameFontName

protected

font name when displaying imageName

◆ imageNameFontSize

double JKQTPRGBMathImage::imageNameFontSize

protected

font size in points when displaying imageName

◆ imageNameG

QString JKQTPRGBMathImage::imageNameG

protected

name of the green image channel displayed above color bar (may contain LaTeX markup!)

◆ imageNameR

QString JKQTPRGBMathImage::imageNameR

protected

name of the red image channel displayed above color bar (may contain LaTeX markup!)

◆ internalDataMaxB

double JKQTPRGBMathImage::internalDataMaxB

protected

internal storage for maximum of the blue image value range

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

◆ internalDataMaxG

double JKQTPRGBMathImage::internalDataMaxG

protected

internal storage for maximum of the green image value range

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

◆ internalDataMinB

double JKQTPRGBMathImage::internalDataMinB

protected

internal storage for minimum of the blue image value range

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

◆ internalDataMinG

double JKQTPRGBMathImage::internalDataMinG

protected

internal storage for minimum of the green image value range

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

◆ modifierColorBarRightAxis

JKQTPHorizontalIndependentAxis* JKQTPRGBMathImage::modifierColorBarRightAxis

protected

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

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ modifierColorBarTopAxis

JKQTPVerticalIndependentAxis* JKQTPRGBMathImage::modifierColorBarTopAxis

protected

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

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ modifierMax

double JKQTPRGBMathImage::modifierMax

protected

modifier value range maximum

◆ modifierMin

double JKQTPRGBMathImage::modifierMin

protected

modifier value range minimum

◆ modifierMode

JKQTPMathImageModifierMode JKQTPRGBMathImage::modifierMode

protected

how to apply the modifier column dataModifier

See also: ModifierMode

◆ rgbMode

JKQTPRGBMathImageRGBMode JKQTPRGBMathImage::rgbMode

protected

how to interpret the three data channels red, green and blue

◆ showColorBar

bool JKQTPRGBMathImage::showColorBar

protected

indicate whether to display a color bar

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

jkqtpimagergb.h

Public Slots

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ JKQTPRGBMathImage() [1/4]

◆ JKQTPRGBMathImage() [2/4]

◆ JKQTPRGBMathImage() [3/4]

◆ JKQTPRGBMathImage() [4/4]

Member Function Documentation

◆ copyImagePlotAsImage

◆ draw()

◆ drawImage()

◆ drawKeyMarker()

◆ drawOutside()

◆ getAutoImageRange()

◆ getAutoModifierRange()

◆ getColorBarModifiedWidth()

◆ getColorBarOffset()

◆ getColorBarRelativeHeight()

◆ getColorBarRightAxis() [1/2]

◆ getColorBarRightAxis() [2/2]

◆ getColorBarRightAxisB() [1/2]

◆ getColorBarRightAxisB() [2/2]

◆ getColorBarRightAxisG() [1/2]

◆ getColorBarRightAxisG() [2/2]

◆ getColorBarRightAxisR() [1/2]

◆ getColorBarRightAxisR() [2/2]

◆ getColorBarRightVisible()

◆ getColorbarsSideBySide()

◆ getColorBarTopAxis() [1/2]

◆ getColorBarTopAxis() [2/2]

◆ getColorBarTopAxisB() [1/2]

◆ getColorBarTopAxisB() [2/2]

◆ getColorBarTopAxisG() [1/2]

◆ getColorBarTopAxisG() [2/2]

◆ getColorBarTopAxisR() [1/2]

◆ getColorBarTopAxisR() [2/2]

◆ getColorBarTopVisible()

◆ getColorBarWidth()

◆ getDataB()

◆ getDataBAsDoubleVector()

◆ getDataG()

◆ getDataGAsDoubleVector()

◆ getDataMinMax()

◆ getDataMinMaxB()

◆ getDataMinMaxG()

◆ getDataR()

◆ getDatatypeB()

◆ getDatatypeG()

◆ getDatatypeR()

◆ getImageMax()

◆ getImageMaxB()

◆ getImageMaxG()

◆ getImageMin()

◆ getImageMinB()

◆ getImageMinG()

◆ getImageName()

◆ getImageNameB()

◆ getImageNameFontName()

◆ getImageNameFontSize()

◆ getImageNameG()

◆ getImageNameR()

◆ getModifierColorBarRightAxis() [1/2]

◆ getModifierColorBarRightAxis() [2/2]

◆ getModifierColorBarTopAxis() [1/2]

◆ getModifierColorBarTopAxis() [2/2]

◆ getModifierMax()

◆ getModifierMin()

◆ getModifierMode()

◆ getOutsideSize()

◆ getRgbMode()

◆ getShowColorBar()

◆ getValueAt()

◆ initObject()

◆ saveImagePlotAsImage

◆ setAutoImageRange()

◆ setAutoModifierRange()