A plottable representing a single statistical box in a plot. More...
#include <qcustomplot.h>
Public Member Functions | |
void | addData (const QVector< double > &keys, const QVector< double > &minimum, const QVector< double > &lowerQuartile, const QVector< double > &median, const QVector< double > &upperQuartile, const QVector< double > &maximum, bool alreadySorted=false) |
void | addData (double key, double minimum, double lowerQuartile, double median, double upperQuartile, double maximum, const QVector< double > &outliers=QVector< double >()) |
QSharedPointer< QCPStatisticalBoxDataContainer > | data () const |
virtual QCPRange | getKeyRange (bool &foundRange, QCP::SignDomain inSignDomain=QCP::sdBoth) const Q_DECL_OVERRIDE |
virtual QCPRange | getValueRange (bool &foundRange, QCP::SignDomain inSignDomain=QCP::sdBoth, const QCPRange &inKeyRange=QCPRange()) const Q_DECL_OVERRIDE |
QPen | medianPen () const |
QCPScatterStyle | outlierStyle () const |
QCPStatisticalBox (QCPAxis *keyAxis, QCPAxis *valueAxis) | |
virtual double | selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const Q_DECL_OVERRIDE |
virtual QCPDataSelection | selectTestRect (const QRectF &rect, bool onlySelectable) const Q_DECL_OVERRIDE |
void | setData (QSharedPointer< QCPStatisticalBoxDataContainer > data) |
void | setData (const QVector< double > &keys, const QVector< double > &minimum, const QVector< double > &lowerQuartile, const QVector< double > &median, const QVector< double > &upperQuartile, const QVector< double > &maximum, bool alreadySorted=false) |
void | setMedianPen (const QPen &pen) |
void | setOutlierStyle (const QCPScatterStyle &style) |
void | setWhiskerAntialiased (bool enabled) |
void | setWhiskerBarPen (const QPen &pen) |
void | setWhiskerPen (const QPen &pen) |
void | setWhiskerWidth (double width) |
void | setWidth (double width) |
bool | whiskerAntialiased () const |
QPen | whiskerBarPen () const |
QPen | whiskerPen () const |
double | whiskerWidth () const |
double | width () const |
![]() | |
virtual int | dataCount () const Q_DECL_OVERRIDE |
virtual double | dataMainKey (int index) const Q_DECL_OVERRIDE |
virtual double | dataMainValue (int index) const Q_DECL_OVERRIDE |
virtual QPointF | dataPixelPosition (int index) const Q_DECL_OVERRIDE |
virtual double | dataSortKey (int index) const Q_DECL_OVERRIDE |
virtual QCPRange | dataValueRange (int index) const Q_DECL_OVERRIDE |
virtual int | findBegin (double sortKey, bool expandedRange=true) const Q_DECL_OVERRIDE |
virtual int | findEnd (double sortKey, bool expandedRange=true) const Q_DECL_OVERRIDE |
virtual QCPPlottableInterface1D * | interface1D () Q_DECL_OVERRIDE |
QCPAbstractPlottable1D (QCPAxis *keyAxis, QCPAxis *valueAxis) | |
virtual bool | sortKeyIsMainKey () const Q_DECL_OVERRIDE |
virtual | ~QCPAbstractPlottable1D () |
![]() | |
bool | addToLegend (QCPLegend *legend) |
bool | addToLegend () |
bool | antialiasedFill () const |
bool | antialiasedScatters () const |
QBrush | brush () const |
void | coordsToPixels (double key, double value, double &x, double &y) const |
const QPointF | coordsToPixels (double key, double value) const |
QCPAxis * | keyAxis () const |
QString | name () const |
QPen | pen () const |
void | pixelsToCoords (double x, double y, double &key, double &value) const |
void | pixelsToCoords (const QPointF &pixelPos, double &key, double &value) const |
QCPAbstractPlottable (QCPAxis *keyAxis, QCPAxis *valueAxis) | |
bool | removeFromLegend (QCPLegend *legend) const |
bool | removeFromLegend () const |
void | rescaleAxes (bool onlyEnlarge=false) const |
void | rescaleKeyAxis (bool onlyEnlarge=false) const |
void | rescaleValueAxis (bool onlyEnlarge=false, bool inKeyRange=false) const |
QCP::SelectionType | selectable () const |
bool | selected () const |
QCPDataSelection | selection () const |
QCPSelectionDecorator * | selectionDecorator () const |
void | setAntialiasedFill (bool enabled) |
void | setAntialiasedScatters (bool enabled) |
void | setBrush (const QBrush &brush) |
void | setKeyAxis (QCPAxis *axis) |
void | setName (const QString &name) |
void | setPen (const QPen &pen) |
Q_SLOT void | setSelectable (QCP::SelectionType selectable) |
Q_SLOT void | setSelection (QCPDataSelection selection) |
void | setSelectionDecorator (QCPSelectionDecorator *decorator) |
void | setValueAxis (QCPAxis *axis) |
QCPAxis * | valueAxis () const |
virtual | ~QCPAbstractPlottable () |
![]() | |
bool | antialiased () const |
QCPLayer * | layer () const |
QCPLayerable * | parentLayerable () const |
QCustomPlot * | parentPlot () const |
QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=0) | |
bool | realVisibility () const |
void | setAntialiased (bool enabled) |
Q_SLOT bool | setLayer (QCPLayer *layer) |
bool | setLayer (const QString &layerName) |
void | setVisible (bool on) |
bool | visible () const |
virtual | ~QCPLayerable () |
![]() | |
virtual | ~QCPPlottableInterface1D () |
Protected Member Functions | |
virtual void | draw (QCPPainter *painter) Q_DECL_OVERRIDE |
virtual void | drawLegendIcon (QCPPainter *painter, const QRectF &rect) const Q_DECL_OVERRIDE |
virtual void | drawStatisticalBox (QCPPainter *painter, QCPStatisticalBoxDataContainer::const_iterator it, const QCPScatterStyle &outlierStyle) const |
QRectF | getQuartileBox (QCPStatisticalBoxDataContainer::const_iterator it) const |
void | getVisibleDataBounds (QCPStatisticalBoxDataContainer::const_iterator &begin, QCPStatisticalBoxDataContainer::const_iterator &end) const |
QVector< QLineF > | getWhiskerBackboneLines (QCPStatisticalBoxDataContainer::const_iterator it) const |
QVector< QLineF > | getWhiskerBarLines (QCPStatisticalBoxDataContainer::const_iterator it) const |
![]() | |
void | drawPolyline (QCPPainter *painter, const QVector< QPointF > &lineData) const |
void | getDataSegments (QList< QCPDataRange > &selectedSegments, QList< QCPDataRange > &unselectedSegments) const |
![]() | |
void | applyDefaultAntialiasingHint (QCPPainter *painter) const Q_DECL_OVERRIDE |
void | applyFillAntialiasingHint (QCPPainter *painter) const |
void | applyScattersAntialiasingHint (QCPPainter *painter) const |
virtual QRect | clipRect () const Q_DECL_OVERRIDE |
virtual void | deselectEvent (bool *selectionStateChanged) Q_DECL_OVERRIDE |
virtual void | selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged) Q_DECL_OVERRIDE |
virtual QCP::Interaction | selectionCategory () const Q_DECL_OVERRIDE |
![]() | |
void | applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const |
void | initializeParentPlot (QCustomPlot *parentPlot) |
virtual void | mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details) |
virtual void | mouseMoveEvent (QMouseEvent *event, const QPointF &startPos) |
virtual void | mousePressEvent (QMouseEvent *event, const QVariant &details) |
virtual void | mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos) |
bool | moveToLayer (QCPLayer *layer, bool prepend) |
virtual void | parentPlotInitialized (QCustomPlot *parentPlot) |
void | setParentLayerable (QCPLayerable *parentLayerable) |
virtual void | wheelEvent (QWheelEvent *event) |
Protected Attributes | |
QPen | mMedianPen |
QCPScatterStyle | mOutlierStyle |
bool | mWhiskerAntialiased |
QPen | mWhiskerBarPen |
QPen | mWhiskerPen |
double | mWhiskerWidth |
double | mWidth |
![]() | |
QSharedPointer< QCPDataContainer< QCPStatisticalBoxData > > | mDataContainer |
![]() | |
bool | mAntialiasedFill |
bool | mAntialiasedScatters |
QBrush | mBrush |
QPointer< QCPAxis > | mKeyAxis |
QString | mName |
QPen | mPen |
QCP::SelectionType | mSelectable |
QCPDataSelection | mSelection |
QCPSelectionDecorator * | mSelectionDecorator |
QPointer< QCPAxis > | mValueAxis |
![]() | |
bool | mAntialiased |
QCPLayer * | mLayer |
QPointer< QCPLayerable > | mParentLayerable |
QCustomPlot * | mParentPlot |
bool | mVisible |
Friends | |
class | QCPLegend |
class | QCustomPlot |
Additional Inherited Members | |
![]() | |
void | selectableChanged (QCP::SelectionType selectable) |
void | selectionChanged (bool selected) |
void | selectionChanged (const QCPDataSelection &selection) |
![]() | |
void | layerChanged (QCPLayer *newLayer) |
A plottable representing a single statistical box in a plot.
To plot data, assign it with the setData or addData functions. Alternatively, you can also access and modify the data via the data method, which returns a pointer to the internal QCPStatisticalBoxDataContainer.
Additionally each data point can itself have a list of outliers, drawn as scatter points at the key coordinate of the respective statistical box data point. They can either be set by using the respective addData method or accessing the individual data points through data, and setting the QVector<double> outliers
of the data points directly.
The appearance of each data point box, ranging from the lower to the upper quartile, is controlled via setPen and setBrush. You may change the width of the boxes with setWidth in plot coordinates.
Each data point's visual representation also consists of two whiskers. Whiskers are the lines which reach from the upper quartile to the maximum, and from the lower quartile to the minimum. The appearance of the whiskers can be modified with: setWhiskerPen, setWhiskerBarPen, setWhiskerWidth. The whisker width is the width of the bar perpendicular to the whisker at the top (for maximum) and bottom (for minimum). If the whisker pen is changed, make sure to set the capStyle
to Qt::FlatCap
. Otherwise the backbone line might exceed the whisker bars by a few pixels due to the pen cap being not perfectly flat.
The median indicator line inside the box has its own pen, setMedianPen.
The outlier data points are drawn as normal scatter points. Their look can be controlled with setOutlierStyle
Like all data representing objects in QCustomPlot, the QCPStatisticalBox is a plottable (QCPAbstractPlottable). So the plottable-interface of QCustomPlot applies (QCustomPlot::plottable, QCustomPlot::removePlottable, etc.)
Usually, you first create an instance:
which registers it with the QCustomPlot instance of the passed axes. Note that this QCustomPlot instance takes ownership of the plottable, so do not delete it manually but use QCustomPlot::removePlottable() instead. The newly created plottable can be modified, e.g.:
Definition at line 5613 of file qcustomplot.h.
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 created QCPStatisticalBox is automatically registered with the QCustomPlot instance inferred from keyAxis. This QCustomPlot instance takes ownership of the QCPStatisticalBox, so do not delete it manually but use QCustomPlot::removePlottable() instead.
Definition at line 24534 of file qcustomplot.cpp.
void QCPStatisticalBox::addData | ( | const QVector< double > & | keys, |
const QVector< double > & | minimum, | ||
const QVector< double > & | lowerQuartile, | ||
const QVector< double > & | median, | ||
const QVector< double > & | upperQuartile, | ||
const QVector< double > & | maximum, | ||
bool | alreadySorted = false |
||
) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Adds the provided points in keys, minimum, lowerQuartile, median, upperQuartile and maximum to the current data. The provided vectors should have equal length. Else, the number of added points will be the size of the smallest vector.
If you can guarantee that the passed data points are sorted by keys in ascending order, you can set alreadySorted to true, to improve performance by saving a sorting run.
Alternatively, you can also access and modify the data directly via the data method, which returns a pointer to the internal data container.
Definition at line 24680 of file qcustomplot.cpp.
void QCPStatisticalBox::addData | ( | double | key, |
double | minimum, | ||
double | lowerQuartile, | ||
double | median, | ||
double | upperQuartile, | ||
double | maximum, | ||
const QVector< double > & | outliers = QVector<double>() |
||
) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Adds the provided data point as key, minimum, lowerQuartile, median, upperQuartile and maximum to the current data.
Alternatively, you can also access and modify the data directly via the data method, which returns a pointer to the internal data container.
Definition at line 24713 of file qcustomplot.cpp.
|
inline |
Returns a shared pointer to the internal data storage of type QCPStatisticalBoxDataContainer. You may use it to directly manipulate the data, which may be more convenient and faster than using the regular setData or addData methods.
Definition at line 5629 of file qcustomplot.h.
|
protectedvirtual |
Implements QCPAbstractPlottable.
Definition at line 24820 of file qcustomplot.cpp.
|
protectedvirtual |
Implements QCPAbstractPlottable.
Definition at line 24878 of file qcustomplot.cpp.
|
protectedvirtual |
Draws the graphical representation of a single statistical box with the data given by the iterator it with the provided painter.
If the statistical box has a set of outlier data points, they are drawn with outlierStyle.
Definition at line 24897 of file qcustomplot.cpp.
|
virtual |
Returns the coordinate range that all data in this plottable span in the key axis dimension. For logarithmic plots, one can set inSignDomain to either QCP::sdNegative or QCP::sdPositive in order to restrict the returned range to that sign domain. E.g. when only negative range is wanted, set inSignDomain to QCP::sdNegative and all positive points will be ignored for range calculation. For no restriction, just set inSignDomain to QCP::sdBoth (default). foundRange is an output parameter that indicates whether a range could be found or not. If this is false, you shouldn't use the returned range (e.g. no points in data).
Note that foundRange is not the same as QCPRange::validRange, since the range returned by this function may have size zero (e.g. when there is only one data point). In this case foundRange would return true, but the returned range is not a valid range in terms of QCPRange::validRange.
Implements QCPAbstractPlottable.
Definition at line 24799 of file qcustomplot.cpp.
|
protected |
Definition at line 24956 of file qcustomplot.cpp.
|
virtual |
Returns the coordinate range that the data points in the specified key range (inKeyRange) span in the value axis dimension. For logarithmic plots, one can set inSignDomain to either QCP::sdNegative or QCP::sdPositive in order to restrict the returned range to that sign domain. E.g. when only negative range is wanted, set inSignDomain to QCP::sdNegative and all positive points will be ignored for range calculation. For no restriction, just set inSignDomain to QCP::sdBoth (default). foundRange is an output parameter that indicates whether a range could be found or not. If this is false, you shouldn't use the returned range (e.g. no points in data).
If inKeyRange has both lower and upper bound set to zero (is equal to QCPRange()
), all data points are considered, without any restriction on the keys.
Note that foundRange is not the same as QCPRange::validRange, since the range returned by this function may have size zero (e.g. when there is only one data point). In this case foundRange would return true, but the returned range is not a valid range in terms of QCPRange::validRange.
Implements QCPAbstractPlottable.
Definition at line 24814 of file qcustomplot.cpp.
|
protected |
Definition at line 24936 of file qcustomplot.cpp.
|
protected |
Definition at line 24972 of file qcustomplot.cpp.
|
protected |
Definition at line 24987 of file qcustomplot.cpp.
|
inline |
Definition at line 5635 of file qcustomplot.h.
|
inline |
Definition at line 5636 of file qcustomplot.h.
|
virtual |
Implements a selectTest specific to this plottable's point geometry.
If details is not 0, it will be set to a QCPDataSelection, describing the closest data point to pos.
QCPAbstractPlottable::selectTest
Reimplemented from QCPAbstractPlottable1D< QCPStatisticalBoxData >.
Definition at line 24749 of file qcustomplot.cpp.
|
virtual |
Returns a data selection containing all the data points of this plottable which are contained (or hit by) rect. This is used mainly in the selection rect interaction for data selection (data selection mechanism).
If onlySelectable is true, an empty QCPDataSelection is returned if this plottable is not selectable (i.e. if QCPAbstractPlottable::setSelectable is QCP::stNone).
QRect::normalized()
when passing a rect which might not be normalized. Reimplemented from QCPAbstractPlottable1D< QCPStatisticalBoxData >.
Definition at line 24721 of file qcustomplot.cpp.
void QCPStatisticalBox::setData | ( | QSharedPointer< QCPStatisticalBoxDataContainer > | data | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Replaces the current data container with the provided data container.
Since a QSharedPointer is used, multiple QCPStatisticalBoxes may share the same data container safely. Modifying the data in the container will then affect all statistical boxes that share the container. Sharing can be achieved by simply exchanging the data containers wrapped in shared pointers:
If you do not wish to share containers, but create a copy from an existing container, rather use the QCPDataContainer<DataType>::set method on the statistical box data container directly:
Definition at line 24564 of file qcustomplot.cpp.
void QCPStatisticalBox::setData | ( | const QVector< double > & | keys, |
const QVector< double > & | minimum, | ||
const QVector< double > & | lowerQuartile, | ||
const QVector< double > & | median, | ||
const QVector< double > & | upperQuartile, | ||
const QVector< double > & | maximum, | ||
bool | alreadySorted = false |
||
) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Replaces the current data with the provided points in keys, minimum, lowerQuartile, median, upperQuartile and maximum. The provided vectors should have equal length. Else, the number of added points will be the size of the smallest vector.
If you can guarantee that the passed data points are sorted by keys in ascending order, you can set alreadySorted to true, to improve performance by saving a sorting run.
Definition at line 24579 of file qcustomplot.cpp.
void QCPStatisticalBox::setMedianPen | ( | const QPen & | pen | ) |
Sets the pen used for drawing the median indicator line inside the statistical boxes.
Definition at line 24652 of file qcustomplot.cpp.
void QCPStatisticalBox::setOutlierStyle | ( | const QCPScatterStyle & | style | ) |
Sets the appearance of the outlier data points.
Outliers can be specified with the method addData(double key, double minimum, double lowerQuartile, double median, double upperQuartile, double maximum, const QVector<double> &outliers)
Definition at line 24663 of file qcustomplot.cpp.
void QCPStatisticalBox::setWhiskerAntialiased | ( | bool | enabled | ) |
Sets whether the statistical boxes whiskers are drawn with antialiasing or not.
Note that antialiasing settings may be overridden by QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.
Definition at line 24644 of file qcustomplot.cpp.
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 whisker backbone.
Whiskers are the lines which reach from the upper quartile to the maximum, and from the lower quartile to the minimum.
Definition at line 24633 of file qcustomplot.cpp.
void QCPStatisticalBox::setWhiskerPen | ( | const QPen & | pen | ) |
Sets the pen used for drawing the whisker backbone.
Whiskers are the lines which reach from the upper quartile to the maximum, and from the lower quartile to the minimum.
Make sure to set the capStyle
of the passed pen to Qt::FlatCap
. Otherwise the backbone line might exceed the whisker bars by a few pixels due to the pen cap being not perfectly flat.
Definition at line 24619 of file qcustomplot.cpp.
void QCPStatisticalBox::setWhiskerWidth | ( | double | width | ) |
Sets the width of the whiskers in key coordinates.
Whiskers are the lines which reach from the upper quartile to the maximum, and from the lower quartile to the minimum.
Definition at line 24603 of file qcustomplot.cpp.
void QCPStatisticalBox::setWidth | ( | double | width | ) |
Sets the width of the boxes in key coordinates.
Definition at line 24590 of file qcustomplot.cpp.
|
inline |
Definition at line 5634 of file qcustomplot.h.
|
inline |
Definition at line 5633 of file qcustomplot.h.
|
inline |
Definition at line 5632 of file qcustomplot.h.
|
inline |
Definition at line 5631 of file qcustomplot.h.
|
inline |
Definition at line 5630 of file qcustomplot.h.
|
friend |
Definition at line 5682 of file qcustomplot.h.
|
friend |
Definition at line 5681 of file qcustomplot.h.
|
protected |
Definition at line 5665 of file qcustomplot.h.
|
protected |
Definition at line 5666 of file qcustomplot.h.
|
protected |
Definition at line 5664 of file qcustomplot.h.
|
protected |
Definition at line 5663 of file qcustomplot.h.
|
protected |
Definition at line 5663 of file qcustomplot.h.
|
protected |
Definition at line 5662 of file qcustomplot.h.
|
protected |
Definition at line 5661 of file qcustomplot.h.