A plottable representing a single statistical box in a plot. More...

#include <plot2d.h>

Inheritance diagram for QCPStatisticalBox:

Public Member Functions
	QCPStatisticalBox (QCPAxis keyAxis, QCPAxis valueAxis)

virtual	~QCPStatisticalBox ()

double	key () const

double	minimum () const

double	lowerQuartile () const

double	median () const

double	upperQuartile () const

double	maximum () const

QVector< double >	outliers () const

double	width () const

double	whiskerWidth () const

QPen	whiskerPen () const

QPen	whiskerBarPen () const

QPen	medianPen () const

double	outlierSize () const

QPen	outlierPen () const

QCP::ScatterStyle	outlierStyle () const

void	setKey (double key)

void	setMinimum (double value)

void	setLowerQuartile (double value)

void	setMedian (double value)

void	setUpperQuartile (double value)

void	setMaximum (double value)

void	setOutliers (const QVector< double > &values)

void	setData (double key, double minimum, double lowerQuartile, double median, double upperQuartile, double maximum)

void	setWidth (double width)

void	setWhiskerWidth (double width)

void	setWhiskerPen (const QPen &pen)

void	setWhiskerBarPen (const QPen &pen)

void	setMedianPen (const QPen &pen)

void	setOutlierSize (double pixels)

void	setOutlierPen (const QPen &pen)

void	setOutlierStyle (QCP::ScatterStyle style)

virtual void	clearData ()

virtual double	selectTest (const QPointF &pos) const

Public Member Functions inherited from QCPAbstractPlottable
	QCPAbstractPlottable (QCPAxis keyAxis, QCPAxis valueAxis)

virtual	~QCPAbstractPlottable ()

QString	name () const

bool	antialiasedFill () const

bool	antialiasedScatters () const

bool	antialiasedErrorBars () const

QPen	pen () const

QPen	selectedPen () const

QBrush	brush () const

QBrush	selectedBrush () const

QCPAxis *	keyAxis () const

QCPAxis *	valueAxis () const

bool	selectable () const

bool	selected () const

void	setName (const QString &name)

void	setAntialiasedFill (bool enabled)

void	setAntialiasedScatters (bool enabled)

void	setAntialiasedErrorBars (bool enabled)

void	setPen (const QPen &pen)

void	setSelectedPen (const QPen &pen)

void	setBrush (const QBrush &brush)

void	setSelectedBrush (const QBrush &brush)

void	setKeyAxis (QCPAxis *axis)

void	setValueAxis (QCPAxis *axis)

void	setSelectable (bool selectable)

void	setSelected (bool selected)

void	rescaleAxes (bool onlyEnlarge=false) const

void	rescaleKeyAxis (bool onlyEnlarge=false) const

void	rescaleValueAxis (bool onlyEnlarge=false) const

virtual bool	addToLegend ()

virtual bool	removeFromLegend () const

Public Member Functions inherited from QCPLayerable
	QCPLayerable (QCustomPlot *parentPlot)

	~QCPLayerable ()

bool	visible () const

QCustomPlot *	parentPlot () const

QCPLayer *	layer () const

bool	antialiased () const

void	setVisible (bool on)

bool	setLayer (QCPLayer *layer)

bool	setLayer (const QString &layerName)

void	setAntialiased (bool enabled)

Protected Member Functions
virtual void	draw (QCPPainter *painter)

virtual void	drawLegendIcon (QCPPainter *painter, const QRect &rect) const

virtual void	drawQuartileBox (QCPPainter painter, QRectF quartileBox=0) const

virtual void	drawMedian (QCPPainter *painter) const

virtual void	drawWhiskers (QCPPainter *painter) const

virtual void	drawOutliers (QCPPainter *painter) const

virtual QCPRange	getKeyRange (bool &validRange, SignDomain inSignDomain=sdBoth) const

virtual QCPRange	getValueRange (bool &validRange, SignDomain inSignDomain=sdBoth) const

Protected Member Functions inherited from QCPAbstractPlottable
virtual QRect	clipRect () const

void	coordsToPixels (double key, double value, double &x, double &y) const

const QPointF	coordsToPixels (double key, double value) const

void	pixelsToCoords (double x, double y, double &key, double &value) const

void	pixelsToCoords (const QPointF &pixelPos, double &key, double &value) const

QPen	mainPen () const

QBrush	mainBrush () const

void	applyDefaultAntialiasingHint (QCPPainter *painter) const

void	applyFillAntialiasingHint (QCPPainter *painter) const

void	applyScattersAntialiasingHint (QCPPainter *painter) const

void	applyErrorBarsAntialiasingHint (QCPPainter *painter) const

double	distSqrToLine (const QPointF &start, const QPointF &end, const QPointF &point) const

Protected Member Functions inherited from QCPLayerable
bool	moveToLayer (QCPLayer *layer, bool prepend)

void	applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const

Protected Attributes
QVector< double >	mOutliers

double	mKey

double	mMinimum

double	mLowerQuartile

double	mMedian

double	mUpperQuartile

double	mMaximum

double	mWidth

double	mWhiskerWidth

double	mOutlierSize

QPen	mWhiskerPen

QPen	mWhiskerBarPen

QPen	mOutlierPen

QPen	mMedianPen

QCP::ScatterStyle	mOutlierStyle

Protected Attributes inherited from QCPAbstractPlottable
QString	mName

bool	mAntialiasedFill

bool	mAntialiasedScatters

bool	mAntialiasedErrorBars

QPen	mPen

QPen	mSelectedPen

QBrush	mBrush

QBrush	mSelectedBrush

QCPAxis *	mKeyAxis

QCPAxis *	mValueAxis

bool	mSelected

bool	mSelectable

Protected Attributes inherited from QCPLayerable
bool	mVisible

QCustomPlot *	mParentPlot

QCPLayer *	mLayer

bool	mAntialiased

Friends
class	QCustomPlot

class	QCPLegend

Additional Inherited Members
Signals inherited from QCPAbstractPlottable
void	selectionChanged (bool selected)

Protected Types inherited from QCPAbstractPlottable
enum	SignDomain { sdNegative, sdBoth, sdPositive }

Detailed Description

A plottable representing a single statistical box in a plot.

To plot data, assign it with the individual parameter functions or use setData to set all parameters at once. The individual funcions are:

Additionally you can define a list of outliers, drawn as circle datapoints:

setOutliers

Changing the appearance

The appearance of the box itself is controlled via setPen and setBrush. You may change the width of the box with setWidth in plot coordinates (not pixels).

Analog functions exist for the minimum/maximum-whiskers: setWhiskerPen, setWhiskerBarPen, setWhiskerWidth. The whisker width is the width of the bar at the top (maximum) or bottom (minimum).

The median indicator line has its own pen, setMedianPen.

If the pens are changed, especially the whisker pen, make sure to set the capStyle to Qt::FlatCap. Else, e.g. the whisker line might exceed the bar line by a few pixels due to the pen cap being not perfectly flat.

The Outlier data points are drawn normal scatter points. Their look can be controlled with setOutlierStyle and setOutlierPen. The size (diameter) can be set with setOutlierSize in pixels.

Usage

Like all data representing objects in QCustomPlot, the QCPStatisticalBox is a plottable (QCPAbstractPlottable). So the plottable-interface of QCustomPlot applies (QCustomPlot::plottable, QCustomPlot::addPlottable, QCustomPlot::removePlottable, etc.)

Usually, you first create an instance:

QCPStatisticalBox *newBox = new QCPStatisticalBox(customPlot->xAxis, customPlot->yAxis);

add it to the customPlot with QCustomPlot::addPlottable:

customPlot->addPlottable(newBox);

and then modify the properties of the newly created plottable, e.g.:

newBox->setName("Measurement Series 1");
newBox->setData(1, 3, 4, 5, 7);
newBox->setOutliers(QVector<double>() << 0.5 << 0.64 << 7.2 << 7.42);

Constructor & Destructor Documentation

QCPStatisticalBox::QCPStatisticalBox	(	QCPAxis *	keyAxis,
		QCPAxis *	valueAxis
	)

explicit

Constructs a statistical box which uses keyAxis as its key axis ("x") and valueAxis as its value axis ("y"). keyAxis and valueAxis must reside in the same QCustomPlot instance and not have the same orientation. If either of these restrictions is violated, a corresponding message is printed to the debug output (qDebug), the construction is not aborted, though.

The constructed statistical box can be added to the plot with QCustomPlot::addPlottable, QCustomPlot then takes ownership of the statistical box.

QCPStatisticalBox::~QCPStatisticalBox ( )

virtual

Member Function Documentation

void QCPStatisticalBox::clearData ( )

virtual

Clears all data in the plottable.

Implements QCPAbstractPlottable.

void QCPStatisticalBox::draw ( QCPPainter * painter )

protectedvirtual

Implements QCPAbstractPlottable.

void QCPStatisticalBox::drawLegendIcon	(	QCPPainter *	painter,
		const QRect &	rect
	)		const

protectedvirtual

Implements QCPAbstractPlottable.

void QCPStatisticalBox::drawMedian ( QCPPainter * painter ) const

protectedvirtual

void QCPStatisticalBox::drawOutliers ( QCPPainter * painter ) const

protectedvirtual

void QCPStatisticalBox::drawQuartileBox	(	QCPPainter *	painter,
		QRectF *	quartileBox = `0`
	)		const

protectedvirtual

void QCPStatisticalBox::drawWhiskers ( QCPPainter * painter ) const

protectedvirtual

QCPRange QCPStatisticalBox::getKeyRange	(	bool &	validRange,
		SignDomain	inSignDomain = `sdBoth`
	)		const

protectedvirtual

Implements QCPAbstractPlottable.

QCPRange QCPStatisticalBox::getValueRange	(	bool &	validRange,
		SignDomain	inSignDomain = `sdBoth`
	)		const

protectedvirtual

Implements QCPAbstractPlottable.

double QCPStatisticalBox::key ( ) const

inline

double QCPStatisticalBox::lowerQuartile ( ) const

inline

double QCPStatisticalBox::maximum ( ) const

inline

double QCPStatisticalBox::median ( ) const

inline

QPen QCPStatisticalBox::medianPen ( ) const

inline

double QCPStatisticalBox::minimum ( ) const

inline

QPen QCPStatisticalBox::outlierPen ( ) const

inline

QVector<double> QCPStatisticalBox::outliers ( ) const

inline

double QCPStatisticalBox::outlierSize ( ) const

inline

QCP::ScatterStyle QCPStatisticalBox::outlierStyle ( ) const

inline

double QCPStatisticalBox::selectTest ( const QPointF & pos ) const

virtual

This function is used to decide whether a click hits a plottable or not.

pos is a point in pixel coordinates on the QCustomPlot surface. This function returns the shortest pixel distance of this point to the plottable (e.g. to the scatters/lines of a graph). If the plottable is either invisible, contains no data or the distance couldn't be determined, -1.0 is returned. setSelectable has no influence on the return value of this function.

If the plottable is represented not by single lines but by an area like QCPBars or QCPStatisticalBox, a click inside the area returns a constant value greater zero (typically 99% of the selectionTolerance of the parent QCustomPlot). If the click lies outside the area, this function returns -1.0.

Providing a constant value for area objects allows selecting line objects even when they are obscured by such area objects, by clicking close to the lines (i.e. closer than 0.99*selectionTolerance).

The actual setting of the selection state is not done by this function. This is handled by the parent QCustomPlot when the mouseReleaseEvent occurs.

See Also: setSelected, QCustomPlot::setInteractions

Implements QCPAbstractPlottable.

void QCPStatisticalBox::setData	(	double	key,
		double	minimum,
		double	lowerQuartile,
		double	median,
		double	upperQuartile,
		double	maximum
	)

Sets all parameters of the statistical box plot at once.

See Also: setKey, setMinimum, setLowerQuartile, setMedian, setUpperQuartile, setMaximum

void QCPStatisticalBox::setKey ( double key )

Sets the key coordinate of the statistical box.

void QCPStatisticalBox::setLowerQuartile ( double value )

Sets the parameter "lower Quartile" of the statistical box plot. This is the lower end of the box. The lower and the upper quartiles are the two statistical quartiles around the median of the sample, they contain 50% of the sample data.

See Also: setUpperQuartile, setPen, setBrush, setWidth

void QCPStatisticalBox::setMaximum ( double value )

Sets the parameter "maximum" of the statistical box plot. This is the position of the upper whisker, typically the maximum measurement of the sample that's not considered an outlier.

See Also: setMinimum, setWhiskerPen, setWhiskerBarPen, setWhiskerWidth

void QCPStatisticalBox::setMedian ( double value )

Sets the parameter "median" of the statistical box plot. This is the value of the median mark inside the quartile box. The median separates the sample data in half (50% of the sample data is below/above the median).

See Also: setMedianPen

void QCPStatisticalBox::setMedianPen ( const QPen & pen )

Sets the pen used for drawing the median indicator line inside the statistical box.

Make sure to set the pen capStyle to Qt::FlatCap to prevent the median line from reaching a few pixels outside the box, when using a non-zero pen width.

void QCPStatisticalBox::setMinimum ( double value )

Sets the parameter "minimum" of the statistical box plot. This is the position of the lower whisker, typically the minimum measurement of the sample that's not considered an outlier.

See Also: setMaximum, setWhiskerPen, setWhiskerBarPen, setWhiskerWidth

void QCPStatisticalBox::setOutlierPen ( const QPen & pen )

Sets the pen used to draw the outlier data points.

See Also: setOutlierSize, setOutliers

void QCPStatisticalBox::setOutliers ( const QVector< double > & values )

Sets a vector of outlier values that will be drawn as circles. Any data points in the sample that are not within the whiskers (setMinimum, setMaximum) should be considered outliers and displayed as such.

See Also: setOutlierPen, setOutlierBrush, setOutlierSize

void QCPStatisticalBox::setOutlierSize ( double pixels )

Sets the pixel size of the scatter symbols that represent the outlier data points.

See Also: setOutlierPen, setOutliers

void QCPStatisticalBox::setOutlierStyle ( QCP::ScatterStyle style )

Sets the scatter style of the outlier data points.

See Also: setOutlierSize, setOutlierPen, setOutliers

void QCPStatisticalBox::setUpperQuartile ( double value )

Sets the parameter "upper Quartile" of the statistical box plot. This is the upper end of the box. The lower and the upper quartiles are the two statistical quartiles around the median of the sample, they contain 50% of the sample data.

See Also: setLowerQuartile, setPen, setBrush, setWidth

void QCPStatisticalBox::setWhiskerBarPen ( const QPen & pen )

Sets the pen used for drawing the whisker bars (Those are the lines parallel to the key axis at each end of the backbone).

See Also: setWhiskerPen

void QCPStatisticalBox::setWhiskerPen ( const QPen & pen )

Sets the pen used for drawing the whisker backbone (That's the line parallel to the value axis).

Make sure to set the pen capStyle to Qt::FlatCap to prevent the backbone from reaching a few pixels past the bars, when using a non-zero pen width.

See Also: setWhiskerBarPen

void QCPStatisticalBox::setWhiskerWidth ( double width )

Sets the width of the whiskers (setMinimum, setMaximum) in key coordinates.

See Also: setWidth

void QCPStatisticalBox::setWidth ( double width )

Sets the width of the box in key coordinates.

See Also: setWhiskerWidth

double QCPStatisticalBox::upperQuartile ( ) const

inline

QPen QCPStatisticalBox::whiskerBarPen ( ) const

inline

QPen QCPStatisticalBox::whiskerPen ( ) const

inline

double QCPStatisticalBox::whiskerWidth ( ) const

inline

double QCPStatisticalBox::width ( ) const

inline

Friends And Related Function Documentation

friend class QCPLegend

friend

friend class QCustomPlot

friend

Member Data Documentation

double QCPStatisticalBox::mKey

protected

double QCPStatisticalBox::mLowerQuartile

protected

double QCPStatisticalBox::mMaximum

protected

double QCPStatisticalBox::mMedian

protected

QPen QCPStatisticalBox::mMedianPen

protected

double QCPStatisticalBox::mMinimum

protected

QPen QCPStatisticalBox::mOutlierPen

protected

QVector<double> QCPStatisticalBox::mOutliers

protected

double QCPStatisticalBox::mOutlierSize

protected

QCP::ScatterStyle QCPStatisticalBox::mOutlierStyle

protected

double QCPStatisticalBox::mUpperQuartile

protected

QPen QCPStatisticalBox::mWhiskerBarPen

protected

QPen QCPStatisticalBox::mWhiskerPen

protected

double QCPStatisticalBox::mWhiskerWidth

protected

double QCPStatisticalBox::mWidth

protected

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

C:/Users/mpeniak/Dropbox/Aquila/trunk/aquila/include/plot2d.h
C:/Users/mpeniak/Dropbox/Aquila/trunk/aquila/src/plot2d.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Changing the appearance

Usage

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation