JKQTPlotter trunk/v5.0.0
an extensive Qt5+Qt6 Plotter framework (including a feature-richt plotter widget, a speed-optimized, but limited variant and a LaTeX equation renderer!), written fully in C/C++ and without external dependencies
Loading...
Searching...
No Matches

class to plot an image from a QImage object More...

#include <jkqtpimage.h>

Inheritance diagram for JKQTPImage:
[legend]
Collaboration diagram for JKQTPImage:
[legend]

Public Slots

void copyImagePlotAsImage ()
 copies the image into the clipboard
 
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

 

Public Member Functions

 JKQTPImage (double x, double y, double width, double height, const QImage &image, JKQTBasePlotter *parent=nullptr)
 class constructor
 
 JKQTPImage (double x, double y, double width, double height, const QImage &image, JKQTPlotter *parent)
 class constructor
 
 JKQTPImage (double x, double y, double width, double height, QImage *image, JKQTBasePlotter *parent=nullptr)
 class constructor
 
 JKQTPImage (double x, double y, double width, double height, QImage *image, JKQTPlotter *parent)
 class constructor
 
 JKQTPImage (JKQTBasePlotter *parent=nullptr)
 class constructor
 
 JKQTPImage (JKQTPlotter *parent)
 class constructor
 
virtual ~JKQTPImage () override
 
void clear_image ()
 deletes the internal image
 
virtual void draw (JKQTPEnhancedPainter &painter) override
 plots the graph to the plotter object specified as parent
 
virtual void drawKeyMarker (JKQTPEnhancedPainter &painter, const QRectF &rect) override
 plots a key marker inside the specified rectangle rect
 
QImage * getImage ()
 the image to be plotted. This is freed by the destructor, iff image_owned is set to true (.e.g by QImage-copy-constructors)
 
const QImage * getImage () const
 the image to be plotted. This is freed by the destructor, iff image_owned is set to true (.e.g by QImage-copy-constructors)
 
virtual void setImage (const QImage &image)
 copy an external image into an internally owned copy
 
virtual void setImage (QImage *image)
 set an external image to be plotted, the image will NOT BE OWNED by the graph-object
 
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 JKQTPImageBase
 JKQTPImageBase (double x, double y, double width, double height, JKQTBasePlotter *parent=nullptr)
 class constructor
 
 JKQTPImageBase (double x, double y, double width, double height, JKQTPlotter *parent)
 class constructor
 
 JKQTPImageBase (JKQTBasePlotter *parent=nullptr)
 class constructor
 
 JKQTPImageBase (JKQTPlotter *parent)
 class constructor
 
double getHeight () const
 height of image
 
virtual QColor getKeyLabelColor () const override
 returns the color to be used for the key label
 
double getWidth () const
 width of image
 
double getX () const
 x coordinate of lower left corner
 
virtual bool getXMinMax (double &minx, double &maxx, double &smallestGreaterZero) override
 get the maximum and minimum x-value of the graph
 
double getY () const
 y coordinate of lower left corner
 
virtual bool getYMinMax (double &miny, double &maxy, double &smallestGreaterZero) override
 get the maximum and minimum y-value of the graph
 
- Public Member Functions inherited from JKQTPGraph
 JKQTPGraph (JKQTBasePlotter *parent=nullptr)
 class constructor
 
virtual ~JKQTPGraph ()=default
 default wirtual destructor
 
virtual bool usesColumn (int column) const
 returns true if the given column is used by the graph
 
- Public Member Functions inherited from JKQTPPlotElement
 JKQTPPlotElement (JKQTBasePlotter *parent=nullptr)
 class constructor
 
virtual ~JKQTPPlotElement ()=default
 default wirtual destructor
 
QPointF backTransform (const QPointF &x) const
 tool routine that back-transforms a QPointF according to the parent's transformation rules (pixels --> plot coordinate)
 
QPointF backTransform (double x, double y) const
 tool routine that back-transforms a QPointF according to the parent's transformation rules (pixels --> plot coordinate)
 
double backtransformX (double x) const
 tool routine that backtransforms an x-coordinate (pixels --> plot coordinate) for this plot element, uses the axis referenced in xAxisRef
 
double backtransformY (double y) const
 tool routine that backtransforms a y-coordinate (pixels --> plot coordinate) for this plot element, uses the axis referenced in yAxisRef
 
virtual void drawOutside (JKQTPEnhancedPainter &painter, QRect leftSpace, QRect rightSpace, QRect topSpace, QRect bottomSpace)
 plots outside the actual plot field of view (e.g. color bars, scale bars, ...)
 
QImage generateKeyMarker (QSize size=QSize(16, 16))
 returns an image with a key marker inside

 
virtual void getOutsideSize (JKQTPEnhancedPainter &painter, int &leftSpace, int &rightSpace, int &topSpace, int &bottomSpace)
 if the graph plots outside the actual plot field of view (e.g. color bars, scale bars, ...)
 
JKQTBasePlottergetParent ()
 returns the parent painter class
 
const JKQTBasePlottergetParent () const
 returns the parent painter class
 
QString getTitle () const
 returns the the title of the plot

 
const JKQTPCoordinateAxisgetXAxis () 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 JKQTPCoordinateAxisgetYAxis () 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 createImageActions ()
 create QActions that are shown in the context menu of the JKQTPlotter
 
- 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
 QActions that copies the image into the clipboard.
 
QAction * actSaveImage
 QActions that saves the image (asking the user for a filename)
 
QImage * image
 the image to be plotted. This is freed by the destructor, iff image_owned is set to true (.e.g by QImage-copy-constructors)
 
bool image_owned
 indicates that the image image is owned by this object (i.e. freed, when the object is destroyed)
 
- 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< HitTestLocationm_hitTestData
 dataset with graph-points and associated data from the function hitTest()
 
JKQTBasePlotterparent
 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 a QImage object

See also
Example (JKQTPlotter): QImage as a Graph

Constructor & Destructor Documentation

◆ JKQTPImage() [1/6]

JKQTPImage::JKQTPImage ( JKQTBasePlotter parent = nullptr)

class constructor

Parameters
parentparent plotter object

◆ JKQTPImage() [2/6]

JKQTPImage::JKQTPImage ( JKQTPlotter parent)

class constructor

Parameters
parentparent plotter object

◆ JKQTPImage() [3/6]

JKQTPImage::JKQTPImage ( double  x,
double  y,
double  width,
double  height,
QImage *  image,
JKQTBasePlotter parent = nullptr 
)

class constructor

Parameters
xorigin of the image (x-direction) in system coordinates
yorigin of the image (y-direction) in system coordinates
widthwidth of the image in system coordinates
heightheight of the image in system coordinates
imagepoints to a QImage that shall be plotted (the constructed object does not take ownership!)
parentparent plotter object

◆ JKQTPImage() [4/6]

JKQTPImage::JKQTPImage ( double  x,
double  y,
double  width,
double  height,
QImage *  image,
JKQTPlotter parent 
)

class constructor

Parameters
xorigin of the image (x-direction) in system coordinates
yorigin of the image (y-direction) in system coordinates
widthwidth of the image in system coordinates
heightheight of the image in system coordinates
imagepoints to a QImage that shall be plotted (the constructed object does not take ownership!)
parentparent plotter object

◆ JKQTPImage() [5/6]

JKQTPImage::JKQTPImage ( double  x,
double  y,
double  width,
double  height,
const QImage &  image,
JKQTBasePlotter parent = nullptr 
)

class constructor

Parameters
xorigin of the image (x-direction) in system coordinates
yorigin of the image (y-direction) in system coordinates
widthwidth of the image in system coordinates
heightheight of the image in system coordinates
imagea QImage that shall be plotted (the constructed object copies the contents into an internally owned variable)
parentparent plotter object

◆ JKQTPImage() [6/6]

JKQTPImage::JKQTPImage ( double  x,
double  y,
double  width,
double  height,
const QImage &  image,
JKQTPlotter parent 
)

class constructor

Parameters
xorigin of the image (x-direction) in system coordinates
yorigin of the image (y-direction) in system coordinates
widthwidth of the image in system coordinates
heightheight of the image in system coordinates
imagea QImage that shall be plotted (the constructed object copies the contents into an internally owned variable)
parentparent plotter object

◆ ~JKQTPImage()

virtual JKQTPImage::~JKQTPImage ( )
overridevirtual

Member Function Documentation

◆ clear_image()

void JKQTPImage::clear_image ( )

deletes the internal image

◆ copyImagePlotAsImage

void JKQTPImage::copyImagePlotAsImage ( )
slot

copies the image into the clipboard

See also
actCopyImage, copyImagePlotAsImage()

◆ createImageActions()

void JKQTPImage::createImageActions ( )
protected

create QActions that are shown in the context menu of the JKQTPlotter

See also
actSaveImage, actCopyImage, saveImagePlotAsImage(), copyImagePlotAsImage()

◆ draw()

virtual void JKQTPImage::draw ( JKQTPEnhancedPainter painter)
overridevirtual

plots the graph to the plotter object specified as parent

Implements JKQTPPlotElement.

◆ drawKeyMarker()

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

plots a key marker inside the specified rectangle rect

Reimplemented from JKQTPImageBase.

◆ getImage() [1/2]

QImage * JKQTPImage::getImage ( )
inline

the image to be plotted. This is freed by the destructor, iff image_owned is set to true (.e.g by QImage-copy-constructors)

◆ getImage() [2/2]

const QImage * JKQTPImage::getImage ( ) const
inline

the image to be plotted. This is freed by the destructor, iff image_owned is set to true (.e.g by QImage-copy-constructors)

◆ saveImagePlotAsImage

void JKQTPImage::saveImagePlotAsImage ( const QString &  filename = QString(""),
const QByteArray &  outputFormat = QByteArray() 
)
slot

saves the image (asking the user for a filename, if filename is empty)

Parameters
filenamename of the file that should be create (if empty, a file save dialog is shown)
outputFormatformat of the output file, see QImage::save()
See also
actSaveImage, saveImagePlotAsImage(), QImage::save()

◆ setImage() [1/2]

virtual void JKQTPImage::setImage ( const QImage &  image)
virtual

copy an external image into an internally owned copy

◆ setImage() [2/2]

virtual void JKQTPImage::setImage ( QImage *  image)
virtual

set an external image to be plotted, the image will NOT BE OWNED by the graph-object

◆ setParent()

virtual void JKQTPImage::setParent ( JKQTBasePlotter parent)
overridevirtual

sets the parent painter class

Reimplemented from JKQTPPlotElement.

◆ setTitle()

virtual void JKQTPImage::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* JKQTPImage::actCopyImage
protected

QActions that copies the image into the clipboard.

See also
actCopyImage, copyImagePlotAsImage()

◆ actSaveImage

QAction* JKQTPImage::actSaveImage
protected

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

See also
actSaveImage, saveImagePlotAsImage()

◆ image

QImage* JKQTPImage::image
protected

the image to be plotted. This is freed by the destructor, iff image_owned is set to true (.e.g by QImage-copy-constructors)

◆ image_owned

bool JKQTPImage::image_owned
protected

indicates that the image image is owned by this object (i.e. freed, when the object is destroyed)


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