QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
QgsRenderChecker Class Reference

This is a helper class for unit tests that need to write an image and compare it to an expected result or render time. More...

#include <qgsrenderchecker.h>

Public Member Functions

 QgsRenderChecker ()
 
 ~QgsRenderChecker ()
 Destructor. More...
 
bool compareImages (QString theTestName, unsigned int theMismatchCount=0, QString theRenderedImageFile="")
 Test using two arbitary images (map renderer will not be used) More...
 
QString controlImagePath () const
 
const QVector
< QgsDartMeasurement > & 
dartMeasurements () const
 Get access to buffered dash messages. More...
 
int elapsedTime ()
 
void enableDashBuffering (bool enable)
 Call this to enable internal buffering of dash messages. More...
 
const QString & expectedImageFile () const
 Returns the path to the expected image file. More...
 
QString imageToHash (QString theImageFile)
 Get an md5 hash that uniquely identifies an image. More...
 
bool isKnownAnomaly (QString theDiffImageFile)
 Get a list of all the anomalies. More...
 
float matchPercent ()
 
unsigned int matchTarget ()
 
unsigned int mismatchCount ()
 
const QString & renderedImage ()
 The path of the rendered image can be retrieved through that method. More...
 
QString report ()
 
bool runTest (QString theTestName, unsigned int theMismatchCount=0)
 Test using renderer to generate the image to be compared. More...
 
void setColorTolerance (unsigned int theColorTolerance)
 Set tolerance for color components used by runTest() and compareImages(). More...
 
void setControlName (const QString &theName)
 Base directory name for the control image (with control image path suffixed) the path to the image will be constructed like this: controlImagePath + '/' + mControlName + '/' + mControlName + '.png'. More...
 
void setControlPathPrefix (const QString &theName)
 Prefix where the control images are kept. More...
 
void setControlPathSuffix (const QString &theName)
 
void setElapsedTimeTarget (int theTarget)
 
Q_DECL_DEPRECATED void setMapRenderer (QgsMapRenderer *thepMapRenderer)
 
void setMapSettings (const QgsMapSettings &mapSettings)
 
void setRenderedImage (QString theImageFileName)
 

Static Public Member Functions

static void drawBackground (QImage *image)
 Draws a checkboard pattern for image backgrounds, so that transparency is visible without requiring a transparent background for the image. More...
 

Protected Attributes

int mElapsedTime
 
QString mExpectedImageFile
 
unsigned int mMatchTarget
 
QString mRenderedImageFile
 
QString mReport
 

Detailed Description

This is a helper class for unit tests that need to write an image and compare it to an expected result or render time.

Definition at line 37 of file qgsrenderchecker.h.

Constructor & Destructor Documentation

QgsRenderChecker::QgsRenderChecker ( )

Definition at line 30 of file qgsrenderchecker.cpp.

QgsRenderChecker::~QgsRenderChecker ( )
inline

Destructor.

Definition at line 44 of file qgsrenderchecker.h.

Member Function Documentation

bool QgsRenderChecker::compareImages ( QString  theTestName,
unsigned int  theMismatchCount = 0,
QString  theRenderedImageFile = "" 
)

Test using two arbitary images (map renderer will not be used)

Parameters
theTestName- to be used as the basis for writing a file to e.g. /tmp/theTestName.png
theMismatchCount- defaults to 0 - the number of pixels that are allowed to be different from the control image. In some cases rendering may be non-deterministic. This parameter allows you to account for that by providing a tolerance.
theRenderedImageFileto optionally override the output filename
Note
: make sure to call setExpectedImage and setRenderedImage first.

Definition at line 229 of file qgsrenderchecker.cpp.

QString QgsRenderChecker::controlImagePath ( ) const

Definition at line 43 of file qgsrenderchecker.cpp.

const QVector<QgsDartMeasurement>& QgsRenderChecker::dartMeasurements ( ) const
inline

Get access to buffered dash messages.

Only will return something if you call enableDashBuffering( true ); before.

Returns
buffered dash messages
Note
not available in python bindings

Definition at line 160 of file qgsrenderchecker.h.

void QgsRenderChecker::drawBackground ( QImage *  image)
static

Draws a checkboard pattern for image backgrounds, so that transparency is visible without requiring a transparent background for the image.

Definition at line 81 of file qgsrenderchecker.cpp.

int QgsRenderChecker::elapsedTime ( )
inline

Definition at line 57 of file qgsrenderchecker.h.

void QgsRenderChecker::enableDashBuffering ( bool  enable)
inline

Call this to enable internal buffering of dash messages.

You may later call dashMessages() to get access to the buffered messages. If disabled (default) dash messages will be sent immediately.

Parameters
enableEnable or disable buffering

Definition at line 151 of file qgsrenderchecker.h.

const QString& QgsRenderChecker::expectedImageFile ( ) const
inline

Returns the path to the expected image file.

Returns
Path to the expected image file

Definition at line 142 of file qgsrenderchecker.h.

QString QgsRenderChecker::imageToHash ( QString  theImageFile)

Get an md5 hash that uniquely identifies an image.

Definition at line 58 of file qgsrenderchecker.cpp.

bool QgsRenderChecker::isKnownAnomaly ( QString  theDiffImageFile)

Get a list of all the anomalies.

An anomaly is a rendered difference file where there is some red pixel content (indicating a render check mismatch), but where the output was still acceptible. If the render diff matches one of these anomalies we will still consider it to be acceptible.

Returns
a bool indicating if the diff matched one of the anomaly files

Definition at line 102 of file qgsrenderchecker.cpp.

float QgsRenderChecker::matchPercent ( )
inline

Definition at line 49 of file qgsrenderchecker.h.

unsigned int QgsRenderChecker::matchTarget ( )
inline

Definition at line 55 of file qgsrenderchecker.h.

unsigned int QgsRenderChecker::mismatchCount ( )
inline

Definition at line 54 of file qgsrenderchecker.h.

const QString& QgsRenderChecker::renderedImage ( )
inline

The path of the rendered image can be retrieved through that method.

Will return the path set with setRenderedImage() or generated in runTest()

Returns
The path to the rendered image

Definition at line 84 of file qgsrenderchecker.h.

QString QgsRenderChecker::report ( )
inline

Definition at line 48 of file qgsrenderchecker.h.

bool QgsRenderChecker::runTest ( QString  theTestName,
unsigned int  theMismatchCount = 0 
)

Test using renderer to generate the image to be compared.

Parameters
theTestName- to be used as the basis for writing a file to e.g. /tmp/theTestName.png
theMismatchCount- defaults to 0 - the number of pixels that are allowed to be different from the control image. In some cases rendering may be non-deterministic. This parameter allows you to account for that by providing a tolerance.
Note
make sure to call setExpectedImage and setMapRenderer first

Definition at line 164 of file qgsrenderchecker.cpp.

void QgsRenderChecker::setColorTolerance ( unsigned int  theColorTolerance)
inline

Set tolerance for color components used by runTest() and compareImages().

Default value is 0.

Parameters
theColorToleranceis maximum difference for each color component including alpha to be considered correct.
Note
added in 2.1

Definition at line 98 of file qgsrenderchecker.h.

void QgsRenderChecker::setControlName ( const QString &  theName)

Base directory name for the control image (with control image path suffixed) the path to the image will be constructed like this: controlImagePath + '/' + mControlName + '/' + mControlName + '.png'.

Definition at line 51 of file qgsrenderchecker.cpp.

void QgsRenderChecker::setControlPathPrefix ( const QString &  theName)
inline

Prefix where the control images are kept.

This will be appended to controlImagePath

Definition at line 69 of file qgsrenderchecker.h.

void QgsRenderChecker::setControlPathSuffix ( const QString &  theName)
inline

Definition at line 71 of file qgsrenderchecker.h.

void QgsRenderChecker::setElapsedTimeTarget ( int  theTarget)
inline

Definition at line 58 of file qgsrenderchecker.h.

void QgsRenderChecker::setMapRenderer ( QgsMapRenderer thepMapRenderer)
Deprecated:
since 2.4 - use setMapSettings()

Definition at line 71 of file qgsrenderchecker.cpp.

void QgsRenderChecker::setMapSettings ( const QgsMapSettings mapSettings)
Note
added in 2.4

Definition at line 76 of file qgsrenderchecker.cpp.

void QgsRenderChecker::setRenderedImage ( QString  theImageFileName)
inline

Definition at line 76 of file qgsrenderchecker.h.

Member Data Documentation

int QgsRenderChecker::mElapsedTime
protected

Definition at line 165 of file qgsrenderchecker.h.

QString QgsRenderChecker::mExpectedImageFile
protected

Definition at line 167 of file qgsrenderchecker.h.

unsigned int QgsRenderChecker::mMatchTarget
protected

Definition at line 164 of file qgsrenderchecker.h.

QString QgsRenderChecker::mRenderedImageFile
protected

Definition at line 166 of file qgsrenderchecker.h.

QString QgsRenderChecker::mReport
protected

Definition at line 163 of file qgsrenderchecker.h.


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