iCub-main
|
A plottable representing a single statistical box in a plot. More...
#include <qcustomplot.h>
Public Member Functions | |
QCPStatisticalBox (QCPAxis *keyAxis, QCPAxis *valueAxis) | |
Constructs a statistical box which uses keyAxis as its key axis ("x") and valueAxis as its value axis ("y"). | |
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 |
QCPScatterStyle | outlierStyle () const |
void | setKey (double key) |
Sets the key coordinate of the statistical box. | |
void | setMinimum (double value) |
Sets the parameter "minimum" of the statistical box plot. | |
void | setLowerQuartile (double value) |
Sets the parameter "lower Quartile" of the statistical box plot. | |
void | setMedian (double value) |
Sets the parameter "median" of the statistical box plot. | |
void | setUpperQuartile (double value) |
Sets the parameter "upper Quartile" of the statistical box plot. | |
void | setMaximum (double value) |
Sets the parameter "maximum" of the statistical box plot. | |
void | setOutliers (const QVector< double > &values) |
Sets a vector of outlier values that will be drawn as scatters. | |
void | setData (double key, double minimum, double lowerQuartile, double median, double upperQuartile, double maximum) |
Sets all parameters of the statistical box plot at once. | |
void | setWidth (double width) |
Sets the width of the box in key coordinates. | |
void | setWhiskerWidth (double width) |
Sets the width of the whiskers (setMinimum, setMaximum) in key coordinates. | |
void | setWhiskerPen (const QPen &pen) |
Sets the pen used for drawing the whisker backbone (That's the line parallel to the value axis). | |
void | 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). | |
void | setMedianPen (const QPen &pen) |
Sets the pen used for drawing the median indicator line inside the statistical box. | |
void | setOutlierStyle (const QCPScatterStyle &style) |
Sets the appearance of the outlier data points. | |
virtual void | clearData () |
Clears all data in the plottable. | |
virtual double | selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const |
This function is used to decide whether a click hits a layerable object or not. | |
Public Member Functions inherited from QCPAbstractPlottable | |
QCPAbstractPlottable (QCPAxis *keyAxis, QCPAxis *valueAxis) | |
Constructs an abstract plottable which uses keyAxis as its key axis ("x") and valueAxis as its value axis ("y"). | |
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) |
The name is the textual representation of this plottable as it is displayed in the legend (QCPLegend). | |
void | setAntialiasedFill (bool enabled) |
Sets whether fills of this plottable is drawn antialiased or not. | |
void | setAntialiasedScatters (bool enabled) |
Sets whether the scatter symbols of this plottable are drawn antialiased or not. | |
void | setAntialiasedErrorBars (bool enabled) |
Sets whether the error bars of this plottable are drawn antialiased or not. | |
void | setPen (const QPen &pen) |
The pen is used to draw basic lines that make up the plottable representation in the plot. | |
void | setSelectedPen (const QPen &pen) |
When the plottable is selected, this pen is used to draw basic lines instead of the normal pen set via setPen. | |
void | setBrush (const QBrush &brush) |
The brush is used to draw basic fills of the plottable representation in the plot. | |
void | setSelectedBrush (const QBrush &brush) |
When the plottable is selected, this brush is used to draw fills instead of the normal brush set via setBrush. | |
void | setKeyAxis (QCPAxis *axis) |
The key axis of a plottable can be set to any axis of a QCustomPlot, as long as it is orthogonal to the plottable's value axis. | |
void | setValueAxis (QCPAxis *axis) |
The value axis of a plottable can be set to any axis of a QCustomPlot, as long as it is orthogonal to the plottable's key axis. | |
Q_SLOT void | setSelectable (bool selectable) |
Sets whether the user can (de-)select this plottable by clicking on the QCustomPlot surface. | |
Q_SLOT void | setSelected (bool selected) |
Sets whether this plottable is selected or not. | |
virtual bool | addToLegend () |
Adds this plottable to the legend of the parent QCustomPlot (QCustomPlot::legend). | |
virtual bool | removeFromLegend () const |
Removes the plottable from the legend of the parent QCustomPlot. | |
void | rescaleAxes (bool onlyEnlarge=false) const |
Rescales the key and value axes associated with this plottable to contain all displayed data, so the whole plottable is visible. | |
void | rescaleKeyAxis (bool onlyEnlarge=false) const |
Rescales the key axis of the plottable so the whole plottable is visible. | |
void | rescaleValueAxis (bool onlyEnlarge=false) const |
Rescales the value axis of the plottable so the whole plottable is visible. | |
Public Member Functions inherited from QCPLayerable | |
QCPLayerable (QCustomPlot *plot, QString targetLayer="", QCPLayerable *parentLayerable=0) | |
Creates a new QCPLayerable instance. | |
~QCPLayerable () | |
bool | visible () const |
QCustomPlot * | parentPlot () const |
QCPLayerable * | parentLayerable () const |
Returns the parent layerable of this layerable. | |
QCPLayer * | layer () const |
bool | antialiased () const |
void | setVisible (bool on) |
Sets the visibility of this layerable object. | |
Q_SLOT bool | setLayer (QCPLayer *layer) |
Sets the layer of this layerable object. | |
bool | setLayer (const QString &layerName) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets the layer of this layerable object by name. | |
void | setAntialiased (bool enabled) |
Sets whether this object will be drawn antialiased or not. | |
bool | realVisibility () const |
Returns whether this layerable is visible, taking the visibility of the layerable parent and the visibility of the layer this layerable is on into account. | |
Protected Member Functions | |
virtual void | draw (QCPPainter *painter) |
virtual void | drawLegendIcon (QCPPainter *painter, const QRectF &rect) const |
virtual QCPRange | getKeyRange (bool &foundRange, SignDomain inSignDomain=sdBoth) const |
virtual QCPRange | getValueRange (bool &foundRange, SignDomain inSignDomain=sdBoth) 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 |
Protected Member Functions inherited from QCPAbstractPlottable | |
virtual QRect | clipRect () const |
virtual QCP::Interaction | selectionCategory () const |
void | applyDefaultAntialiasingHint (QCPPainter *painter) const |
virtual void | selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged) |
virtual void | deselectEvent (bool *selectionStateChanged) |
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 | 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 | |
virtual void | parentPlotInitialized (QCustomPlot *parentPlot) |
void | initializeParentPlot (QCustomPlot *parentPlot) |
void | setParentLayerable (QCPLayerable *parentLayerable) |
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 |
QPen | mWhiskerPen |
QPen | mWhiskerBarPen |
QPen | mMedianPen |
QCPScatterStyle | mOutlierStyle |
Protected Attributes inherited from QCPAbstractPlottable | |
QString | mName |
bool | mAntialiasedFill |
bool | mAntialiasedScatters |
bool | mAntialiasedErrorBars |
QPen | mPen |
QPen | mSelectedPen |
QBrush | mBrush |
QBrush | mSelectedBrush |
QPointer< QCPAxis > | mKeyAxis |
QPointer< QCPAxis > | mValueAxis |
bool | mSelectable |
bool | mSelected |
Protected Attributes inherited from QCPLayerable | |
bool | mVisible |
QCustomPlot * | mParentPlot |
QPointer< QCPLayerable > | mParentLayerable |
QCPLayer * | mLayer |
bool | mAntialiased |
Friends | |
class | QCustomPlot |
class | QCPLegend |
Additional Inherited Members | |
Signals inherited from QCPAbstractPlottable | |
void | selectionChanged (bool selected) |
This signal is emitted when the selection state of this plottable has changed, either by user interaction or by a direct call to setSelected. | |
void | selectableChanged (bool selectable) |
This signal is emitted when the selectability of this plottable has changed. | |
Signals inherited from QCPLayerable | |
void | layerChanged (QCPLayer *newLayer) |
This signal is emitted when the layer of this layerable changes, i.e. | |
Protected Types inherited from QCPAbstractPlottable | |
enum | SignDomain { sdNegative , sdBoth , sdPositive } |
Represents negative and positive sign domain for passing to getKeyRange and getValueRange. More... | |
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 functions are:
Additionally you can define a list of outliers, drawn as scatter datapoints:
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) and bottom (minimum).
The median indicator line has its own pen, setMedianPen.
If the whisker backbone pen is changed, make sure to set the capStyle to Qt::FlatCap. Else, the backbone line might exceed the whisker bars by a few pixels due to the pen cap being not perfectly flat.
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::addPlottable, QCustomPlot::removePlottable, etc.)
Usually, you first create an instance:
add it to the customPlot with QCustomPlot::addPlottable:
and then modify the properties of the newly created plottable, e.g.:
Definition at line 2797 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 constructed statistical box can be added to the plot with QCustomPlot::addPlottable, QCustomPlot then takes ownership of the statistical box.
Definition at line 18017 of file qcustomplot.cpp.
|
virtual |
Clears all data in the plottable.
Implements QCPAbstractPlottable.
Definition at line 18195 of file qcustomplot.cpp.
|
protectedvirtual |
Implements QCPAbstractPlottable.
Definition at line 18232 of file qcustomplot.cpp.
|
protectedvirtual |
Implements QCPAbstractPlottable.
Definition at line 18260 of file qcustomplot.cpp.
|
protectedvirtual |
Definition at line 18294 of file qcustomplot.cpp.
|
protectedvirtual |
Definition at line 18328 of file qcustomplot.cpp.
|
protectedvirtual |
Definition at line 18277 of file qcustomplot.cpp.
|
protectedvirtual |
Definition at line 18308 of file qcustomplot.cpp.
|
protectedvirtual |
Implements QCPAbstractPlottable.
Definition at line 18337 of file qcustomplot.cpp.
|
protectedvirtual |
Implements QCPAbstractPlottable.
Definition at line 18371 of file qcustomplot.cpp.
|
inline |
Definition at line 2819 of file qcustomplot.h.
|
inline |
Definition at line 2821 of file qcustomplot.h.
|
inline |
Definition at line 2824 of file qcustomplot.h.
|
inline |
Definition at line 2822 of file qcustomplot.h.
|
inline |
Definition at line 2830 of file qcustomplot.h.
|
inline |
Definition at line 2820 of file qcustomplot.h.
|
inline |
Definition at line 2825 of file qcustomplot.h.
|
inline |
Definition at line 2831 of file qcustomplot.h.
|
virtual |
This function is used to decide whether a click hits a layerable object 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 object. If the object is either invisible or the distance couldn't be determined, -1.0 is returned. Further, if onlySelectable is true and the object is not selectable, -1.0 is returned, too.
If the item is represented not by single lines but by an area like QCPItemRect or QCPItemText, a click inside the area returns a constant value greater zero (typically the selectionTolerance of the parent QCustomPlot multiplied by 0.99). 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, and the finally selected object is notified via the selectEvent/deselectEvent methods.
details is an optional output parameter. Every layerable subclass may place any information in details. This information will be passed to selectEvent when the parent QCustomPlot decides on the basis of this selectTest call, that the object was successfully selected. The subsequent call to selectEvent will carry the details. This is useful for multi-part objects (like QCPAxis). This way, a possibly complex calculation to decide which part was clicked is only done once in selectTest. The result (i.e. the actually clicked part) can then be placed in details. So in the subsequent selectEvent, the decision which part was selected doesn't have to be done a second time for a single selection operation.
You may pass 0 as details to indicate that you are not interested in those selection details.
Implements QCPAbstractPlottable.
Definition at line 18207 of file qcustomplot.cpp.
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.
Definition at line 18122 of file qcustomplot.cpp.
void QCPStatisticalBox::setKey | ( | double | key | ) |
Sets the key coordinate of the statistical box.
Definition at line 18042 of file qcustomplot.cpp.
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.
Definition at line 18065 of file qcustomplot.cpp.
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.
Definition at line 18100 of file qcustomplot.cpp.
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).
Definition at line 18077 of file qcustomplot.cpp.
void QCPStatisticalBox::setMedianPen | ( | const QPen & | pen | ) |
Sets the pen used for drawing the median indicator line inside the statistical box.
Definition at line 18179 of file qcustomplot.cpp.
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.
Definition at line 18053 of file qcustomplot.cpp.
void QCPStatisticalBox::setOutliers | ( | const QVector< double > & | values | ) |
Sets a vector of outlier values that will be drawn as scatters.
Any data points in the sample that are not within the whiskers (setMinimum, setMaximum) should be considered outliers and displayed as such.
Definition at line 18112 of file qcustomplot.cpp.
void QCPStatisticalBox::setOutlierStyle | ( | const QCPScatterStyle & | style | ) |
Sets the appearance of the outlier data points.
Definition at line 18189 of file qcustomplot.cpp.
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.
Definition at line 18089 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).
Definition at line 18171 of file qcustomplot.cpp.
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 whisker backbone from reaching a few pixels past the whisker bars, when using a non-zero pen width.
Definition at line 18160 of file qcustomplot.cpp.
void QCPStatisticalBox::setWhiskerWidth | ( | double | width | ) |
Sets the width of the whiskers (setMinimum, setMaximum) in key coordinates.
Definition at line 18147 of file qcustomplot.cpp.
void QCPStatisticalBox::setWidth | ( | double | width | ) |
Sets the width of the box in key coordinates.
Definition at line 18137 of file qcustomplot.cpp.
|
inline |
Definition at line 2823 of file qcustomplot.h.
|
inline |
Definition at line 2829 of file qcustomplot.h.
|
inline |
Definition at line 2828 of file qcustomplot.h.
|
inline |
Definition at line 2827 of file qcustomplot.h.
|
inline |
Definition at line 2826 of file qcustomplot.h.
|
friend |
Definition at line 2875 of file qcustomplot.h.
|
friend |
Definition at line 2874 of file qcustomplot.h.
|
protected |
Definition at line 2856 of file qcustomplot.h.
|
protected |
Definition at line 2856 of file qcustomplot.h.
|
protected |
Definition at line 2856 of file qcustomplot.h.
|
protected |
Definition at line 2856 of file qcustomplot.h.
|
protected |
Definition at line 2859 of file qcustomplot.h.
|
protected |
Definition at line 2856 of file qcustomplot.h.
|
protected |
Definition at line 2855 of file qcustomplot.h.
|
protected |
Definition at line 2860 of file qcustomplot.h.
|
protected |
Definition at line 2856 of file qcustomplot.h.
|
protected |
Definition at line 2859 of file qcustomplot.h.
|
protected |
Definition at line 2859 of file qcustomplot.h.
|
protected |
Definition at line 2858 of file qcustomplot.h.
|
protected |
Definition at line 2857 of file qcustomplot.h.