QwtBoxSample Class Reference

Sample for box-and-whisker plot (boxplot) visualization. More...

#include <qwt_samples.h>

Inheritance diagram for QwtBoxSample:

Public Member Functions
	QwtBoxSample (double position=0.0)
	Default constructor.
	QwtBoxSample (double position, double whiskerLower, double q1, double median, double q3, double whiskerUpper)
	Full constructor with all statistical values.
bool	isValid () const
	Check if sample has valid ordering.
bool	hasMean () const
	Check if the sample carries a mean value.
QwtInterval	boundingInterval () const
	Get bounding interval including whiskers.
QwtInterval	boxInterval () const
	Get box body interval (Q1 to Q3)
Public Member Functions inherited from QwtStatisticalSample
	QwtStatisticalSample (double position=0.0)
	Default constructor.

Public Attributes
double	whiskerLower
	Lower whisker endpoint.
double	q1
	First quartile (25th percentile)
double	median
	Median (50th percentile) - also stored in inherited 'center' field.
double	q3
	Third quartile (75th percentile)
double	whiskerUpper
	Upper whisker endpoint.
double	mean
	Arithmetic mean - NaN, when unknown (the default and full constructor)
int	outlierCount
	Number of outliers (stored separately, this is count only)
Public Attributes inherited from QwtStatisticalSample
double	position
	Position on the "time" axis (x for vertical, y for horizontal orientation)
double	lower
	Lower bound of the statistical range.
double	upper
	Upper bound of the statistical range.
double	center
	Central reference value.

Detailed Description

Sample for box-and-whisker plot (boxplot) visualization.

Contains all statistical values needed to render a boxplot: whisker endpoints, quartiles, median, mean and outlier count. Actual outlier values are stored separately in QwtBoxOutlierSample.

Constructor & Destructor Documentation

QwtBoxSample() [1/2]

QwtBoxSample::QwtBoxSample ( double  position = 0.0 )

inline

Default constructor.

All values set to 0.0, the mean to NaN (unknown)

QwtBoxSample() [2/2]

QwtBoxSample::QwtBoxSample ( double  position, double  whiskerLower, double  q1, double  median, double  q3, double  whiskerUpper  )

inline

Full constructor with all statistical values.

Parameters

position	Position on the axis
whiskerLower	Lower whisker endpoint
q1	First quartile (25th percentile)
median	Median value (50th percentile)
q3	Third quartile (75th percentile)
whiskerUpper	Upper whisker endpoint

The mean is not part of the statistics of this constructor; it stays set to NaN, so hasMean() returns false until a value is assigned to the mean member.

Member Function Documentation

boundingInterval()

QwtInterval QwtBoxSample::boundingInterval ( ) const

inline

Get bounding interval including whiskers.

Returns

Interval from whiskerLower to whiskerUpper

boxInterval()

QwtInterval QwtBoxSample::boxInterval ( ) const

inline

Get box body interval (Q1 to Q3)

Returns

Interval from q1 to q3

hasMean()

bool QwtBoxSample::hasMean ( ) const

inline

Check if the sample carries a mean value.

QwtBoxStatisticsCalculator always fills the mean; samples that were assembled manually (or the default constructed ones) have no mean until it is assigned.

Returns

true, when mean has been set to a finite value

isValid()

bool QwtBoxSample::isValid ( ) const

inline

Check if sample has valid ordering.

Returns true if whiskerLower <= q1 <= median <= q3 <= whiskerUpper

---

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

• /home/runner/work/QWT/QWT/src/core/qwt_samples.h