QCPStatisticalBoxData
Public Member Functions | |
QCPStatisticalBoxData () | |
QCPStatisticalBoxData (double key, double minimum, double lowerQuartile, double median, double upperQuartile, double maximum, const QVector< double > &outliers=QVector< double >()) | |
double | mainKey () const |
double | mainValue () const |
double | sortKey () const |
QCPRange | valueRange () const |
Static Public Member Functions | |
static QCPStatisticalBoxData | fromSortKey (double sortKey) |
static bool | sortKeyIsMainKey () |
Public Attributes | |
double | key |
double | lowerQuartile |
double | maximum |
double | median |
double | minimum |
QVector< double > | outliers |
double | upperQuartile |
Detailed Description
Holds the data of one single data point for QCPStatisticalBox.
The stored data is:
- key: coordinate on the key axis of this data point (this is the mainKey and the sortKey)
- minimum: the position of the lower whisker, typically the minimum measurement of the sample that's not considered an outlier.
- lowerQuartile: the lower end of the box. The lower and the upper quartiles are the two statistical quartiles around the median of the sample, they should contain 50% of the sample data.
- median: 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). (This is the mainValue)
- upperQuartile: the upper end of the box. The lower and the upper quartiles are the two statistical quartiles around the median of the sample, they should contain 50% of the sample data.
- maximum: the position of the upper whisker, typically the maximum measurement of the sample that's not considered an outlier.
- outliers: a QVector of outlier values that will be drawn as scatter points at the key coordinate of this data point (see QCPStatisticalBox::setOutlierStyle)
The container for storing multiple data points is QCPStatisticalBoxDataContainer. It is a typedef for QCPDataContainer with QCPStatisticalBoxData as the DataType template parameter. See the documentation there for an explanation regarding the data type's generic methods.
- See also
- QCPStatisticalBoxDataContainer
Definition at line 5905 of file qcustomplot.h.
Constructor & Destructor Documentation
◆ QCPStatisticalBoxData() [1/2]
QCPStatisticalBoxData::QCPStatisticalBoxData | ( | ) |
Constructs a data point with key and all values set to zero.
Definition at line 25230 of file qcustomplot.cpp.
◆ QCPStatisticalBoxData() [2/2]
QCPStatisticalBoxData::QCPStatisticalBoxData | ( | double | key, |
double | minimum, | ||
double | lowerQuartile, | ||
double | median, | ||
double | upperQuartile, | ||
double | maximum, | ||
const QVector< double > & | outliers = QVector<double>() ) |
Constructs a data point with the specified key, minimum, lowerQuartile, median, upperQuartile, maximum and optionally a number of outliers.
Definition at line 25244 of file qcustomplot.cpp.
Member Function Documentation
◆ fromSortKey()
|
inlinestatic |
Returns a data point with the specified sortKey. All other members are set to zero.
For a general explanation of what this method is good for in the context of the data container, see the documentation of QCPDataContainer.
Definition at line 5912 of file qcustomplot.h.
◆ mainKey()
|
inline |
Returns the key member of this data point.
For a general explanation of what this method is good for in the context of the data container, see the documentation of QCPDataContainer.
Definition at line 5915 of file qcustomplot.h.
◆ mainValue()
|
inline |
Returns the median member of this data point.
For a general explanation of what this method is good for in the context of the data container, see the documentation of QCPDataContainer.
Definition at line 5916 of file qcustomplot.h.
◆ sortKey()
|
inline |
Returns the key member of this data point.
For a general explanation of what this method is good for in the context of the data container, see the documentation of QCPDataContainer.
Definition at line 5911 of file qcustomplot.h.
◆ sortKeyIsMainKey()
|
inlinestatic |
Since the member key is both the data point key coordinate and the data ordering parameter, this method returns true.
For a general explanation of what this method is good for in the context of the data container, see the documentation of QCPDataContainer.
Definition at line 5913 of file qcustomplot.h.
◆ valueRange()
|
inline |
Returns a QCPRange spanning from the minimum to the maximum member of this statistical box data point, possibly further expanded by outliers.
For a general explanation of what this method is good for in the context of the data container, see the documentation of QCPDataContainer.
Definition at line 5918 of file qcustomplot.h.
Member Data Documentation
◆ key
double QCPStatisticalBoxData::key |
Definition at line 5926 of file qcustomplot.h.
◆ lowerQuartile
double QCPStatisticalBoxData::lowerQuartile |
Definition at line 5926 of file qcustomplot.h.
◆ maximum
double QCPStatisticalBoxData::maximum |
Definition at line 5926 of file qcustomplot.h.
◆ median
double QCPStatisticalBoxData::median |
Definition at line 5926 of file qcustomplot.h.
◆ minimum
double QCPStatisticalBoxData::minimum |
Definition at line 5926 of file qcustomplot.h.
◆ outliers
QVector<double> QCPStatisticalBoxData::outliers |
Definition at line 5927 of file qcustomplot.h.
◆ upperQuartile
double QCPStatisticalBoxData::upperQuartile |
Definition at line 5926 of file qcustomplot.h.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:04:48 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.