This class is used to accumulate statistics on double arrays. More...

#include <Statistics.h>

Inheritance diagram for Isis::Statistics:

Collaboration diagram for Isis::Statistics:

Classes
class	XmlHandler

Public Member Functions
	Statistics (QObject *parent=0)
	Constructs an IsisStats object with accumulators and counters set to zero.

	Statistics (Project project, XmlStackedHandlerReader xmlReader, QObject *parent=0)

	Statistics (const PvlGroup &inStats, QObject *parent=0)
	Constructs a Statistics object from an input Pvl.

	Statistics (const Statistics &other)

virtual	~Statistics ()
	Destroys the IsisStats object.

Statistics &	operator= (const Statistics &other)

void	Reset ()
	Reset all accumulators and counters to zero.

void	AddData (const double *data, const unsigned int count)
	Add an array of doubles to the accumulators and counters.

void	AddData (const double data)
	Add a double to the accumulators and counters.

void	RemoveData (const double *data, const unsigned int count)
	Remove an array of doubles from the accumulators and counters.

void	RemoveData (const double data)

void	SetValidRange (const double minimum=Isis::ValidMinimum, const double maximum=Isis::ValidMaximum)

double	ValidMinimum () const

double	ValidMaximum () const

bool	InRange (const double value)

bool	AboveRange (const double value)

bool	BelowRange (const double value)

double	Average () const
	Computes and returns the average.

double	StandardDeviation () const
	Computes and returns the standard deviation.

double	Variance () const
	Computes and returns the variance.

double	Sum () const
	Returns the sum of all the data.

double	SumSquare () const
	Returns the sum of all the squared data.

double	Rms () const
	Computes and returns the rms.

double	Minimum () const
	Returns the absolute minimum double found in all data passed through the AddData method.

double	Maximum () const
	Returns the absolute maximum double found in all data passed through the AddData method.

double	ChebyshevMinimum (const double percent=99.5) const
	This method returns a minimum such that X percent of the data will fall with K standard deviations of the average (Chebyshev's Theorem).

double	ChebyshevMaximum (const double percent=99.5) const
	This method returns a maximum such that X percent of the data will fall with K standard deviations of the average (Chebyshev's Theorem).

double	BestMinimum (const double percent=99.5) const
	This method returns the better of the absolute minimum or the Chebyshev minimum.

double	BestMaximum (const double percent=99.5) const
	This method returns the better of the absolute maximum or the Chebyshev maximum.

double	ZScore (const double value) const
	This method returns the better of the z-score of the given value.

BigInt	TotalPixels () const
	Returns the total number of pixels processed (valid and invalid).

BigInt	ValidPixels () const
	Returns the total number of valid pixels processed.

BigInt	OverRangePixels () const
	Returns the total number of pixels over the valid range encountered.

BigInt	UnderRangePixels () const
	Returns the total number of pixels under the valid range encountered.

BigInt	NullPixels () const
	Returns the total number of NULL pixels encountered.

BigInt	LisPixels () const
	Returns the total number of low instrument saturation (LIS) pixels encountered.

BigInt	LrsPixels () const
	Returns the total number of low representation saturation (LRS) pixels encountered.

BigInt	HisPixels () const
	Returns the total number of high instrument saturation (HIS) pixels encountered.

BigInt	HrsPixels () const
	Returns the total number of high representation saturation (HRS) pixels encountered.

BigInt	OutOfRangePixels () const
	Returns the total number of pixels outside of the valid range encountered.

bool	RemovedData () const

PvlGroup	toPvl (QString name="Statistics") const
	Serialize statistics as a pvl group.

void	save (QXmlStreamWriter &stream, const Project *project) const

QDataStream &	write (QDataStream &stream) const
	Order saved must match the offsets in the static compoundH5DataType() method.

QDataStream &	read (QDataStream &stream)

Private Member Functions
void	fromPvl (const PvlGroup &inStats)
	Unserializes a Statistics object from a pvl group.

Private Attributes
double	m_sum
	The sum accumulator, i.e. the sum of added data values.

double	m_sumsum
	The sum-squared accumulator, i.e.

double	m_minimum
	Minimum double value encountered.

double	m_maximum
	Maximum double value encountered.

double	m_validMinimum
	Minimum valid pixel value.

double	m_validMaximum
	Maximum valid pixel value.

BigInt	m_totalPixels
	Count of total pixels processed.

BigInt	m_validPixels
	Count of valid pixels (non-special) processed.

BigInt	m_nullPixels
	Count of null pixels processed.

BigInt	m_lrsPixels
	Count of low instrument saturation pixels processed.

BigInt	m_lisPixels
	Count of low representation saturation pixels processed.

BigInt	m_hrsPixels
	Count of high instrument saturation pixels processed.

BigInt	m_hisPixels
	Count of high instrument representation pixels processed.

BigInt	m_underRangePixels
	Count of pixels less than the valid range.

BigInt	m_overRangePixels
	Count of pixels greater than the valid range.

bool	m_removedData
	Indicates the RemoveData method was called which implies m_minimum and m_maximum are invalid.

Detailed Description

This class is used to accumulate statistics on double arrays.

This class is used to accumulate statistics on double arrays. In particular, it is highly useful for obtaining statistics on cube data. Parameters which can be computed are 1) average, 2) standard deviation, 3) variance, 4) minimum, 5) maximum and 6) various counts of valid and/or special pixels.

The following example shows a simple set up and usage of the Statistics class to calculate the average of a set of values:

Statistics myStats ;
double myData [] = { 1.0, 3.0, 2.4, 7.5 } ;
 
myStats.AddData (myData, 4) ;
double myAverage = myStats.Average () ;
cout << "The average of the data is " << myAverage << endl ;

For an example of how the Statistics object is used in Isis, see the Histogram object (inherits from Statistics) and the stats application, stats.cpp (uses the Statistics child class Histogram).

Author: 2002-05-06 Jeff Anderson

History

2002-05-08 Jeff Anderson - Added Chebyshev and Best minimum/maximum methods.

2004-05-11 Jeff Anderson - Moved Reset, AddData and RemoveData methods into public space.

2004-06-28 Jeff Anderson - Added Sum and SumSquare methods.

2005-02-17 Deborah Lee Soltesz - Modified file to support Doxygen documentation.

2005-05-23 Jeff Anderson - Changed to support 2GB+ files

2006-02-15 Jacob Danton - Added Valid Range options/methods

2006-03-10 Jacob Danton - Added Z-score method

2007-01-18 Robert Sucharski - Added AddData method for a single double value

2008-05-06 Steven Lambright - Added AboveRange, BelowRange methods

2010-03-18 Sharmila Prasad - Error message more meaningful for SetValidRange function

2011-06-13 Ken Edmundson - Added Rms method.

2015-09-01 Tyler Wilson - Made SetValidRange and the destructor virtual. Ref #2188.

2011-06-23 Jeannie Backer - Added QDataStream read(), write() methods and added QDataStream >> and << operators. Replaced std strings with QStrings.

2014-09-05 Jeannie Backer - Added xml read/write capabilities. Moved method implementation to cpp file. Improved coverage of unitTest. Brought code closer to standards.

2015-09-03 Jeannie Backer - Added hdf5 read/write capabilities by adding compoundH5DataType() static method.

2015-12-21 Jeannie Backer - Changed compoundH5DataType() method to update offset by using member variabl datatypes directly. This was done so that MAC OSX will compile.

2015-12-21 Jeannie Backer - Changed H5::PredType::NATIVE_HBOOL to H5::PredType::NATIVE_INT64 in compoundH5DataType() method. This was done so that MAC OSX will compile.

2016-07-15 Ian Humphrey - Added constructor that initializes a Statistics object from a PvlGroup. Added toPvl() and fromPvl() methods to allow Statistics serialization/unserialization. References #2282.

2017-04-20 Makayla Shepherd - Removed the hdf5 code because we are using XML for serialization. Fixes #4795.

Todo

2005-02-07 Deborah Lee Soltesz - add example using cube data to the class documentation

2015-08-13 Jeannie Backer - Clean up header and implementation files once serialization is implemented. (Remove xml, data stream, hdf, etc)

Definition at line 94 of file Statistics.h.

Constructor & Destructor Documentation

◆ Statistics() [1/4]

Isis::Statistics::Statistics ( QObject * parent = 0 )

Constructs an IsisStats object with accumulators and counters set to zero.

Definition at line 28 of file Statistics.cpp.

References Reset().

◆ Statistics() [2/4]

Isis::Statistics::Statistics	(	Project *	project,
		XmlStackedHandlerReader *	xmlReader,
		QObject *	parent = 0 )

Definition at line 36 of file Statistics.cpp.

◆ Statistics() [3/4]

Isis::Statistics::Statistics	(	const PvlGroup &	inStats,
		QObject *	parent = 0 )

Constructs a Statistics object from an input Pvl.

Parameters

const PvlGroup & - The input statistics

Definition at line 48 of file Statistics.cpp.

References fromPvl(), and Reset().

◆ Statistics() [4/4]

Isis::Statistics::Statistics ( const Statistics & other )

Definition at line 55 of file Statistics.cpp.

◆ ~Statistics()

Isis::Statistics::~Statistics ( )

virtual

Destroys the IsisStats object.

Definition at line 77 of file Statistics.cpp.

Member Function Documentation

◆ AboveRange()

bool Isis::Statistics::AboveRange ( const double value )

Definition at line 284 of file Statistics.cpp.

◆ AddData() [1/2]

void Isis::Statistics::AddData	(	const double *	data,
		const unsigned int	count )

Add an array of doubles to the accumulators and counters.

This method can be invoked multiple times (for example: once for each line in a cube) before obtaining statistics.

Parameters

data	The data to be added to the data set used for statistical calculations.
count	The number of elements in the incoming data to be added.

Definition at line 141 of file Statistics.cpp.

References AddData().

Referenced by Isis::Histogram::AddData(), Isis::ImageHistogram::AddData(), AddData(), Isis::MultivariateStatistics::AddData(), Isis::Histogram::AddData(), Isis::ImageHistogram::AddData(), Isis::MultivariateStatistics::AddData(), Isis::CameraStatistics::addStats(), Isis::averageLines(), Isis::averageSamples(), Isis::Gruen::CheckConstraints(), Isis::GainLineStat(), Isis::ControlNetStatistics::GenerateImageStats(), Isis::ControlPoint::GetStatistic(), Isis::ZeroBufferSmooth::init(), Isis::ZeroReverse::init(), Isis::ControlPointGraphicsItem::paint(), and Isis::VisualDisplay::setPixelData().

◆ AddData() [2/2]

void Isis::Statistics::AddData ( const double data )

Add a double to the accumulators and counters.

This method can be invoked multiple times (for example: once for each pixel in a cube) before obtaining statistics.

Parameters

data	The data to be added to the data set used for statistical calculations.

Definition at line 158 of file Statistics.cpp.

References Isis::IsHisPixel(), Isis::IsHrsPixel(), Isis::IsLisPixel(), Isis::IsLrsPixel(), Isis::IsNullPixel(), m_hisPixels, m_hrsPixels, m_lisPixels, m_lrsPixels, m_maximum, m_minimum, m_nullPixels, m_overRangePixels, m_sum, m_sumsum, m_totalPixels, m_underRangePixels, and m_validPixels.

◆ Average()

double Isis::Statistics::Average ( ) const

Computes and returns the average.

If there are no valid pixels, then NULL8 is returned.

Returns: The Average

Definition at line 300 of file Statistics.cpp.

References m_sum, and m_validPixels.

Referenced by Isis::OverlapNormalization::AddOverlap(), Isis::ControlNet::AverageResidual(), ChebyshevMaximum(), ChebyshevMinimum(), Isis::MultivariateStatistics::Covariance(), Isis::ControlNetStatistics::GenerateControlNetStats(), Isis::ZeroBufferSmooth::init(), Isis::ZeroReverse::init(), Isis::VisualDisplay::paintPixmap(), Isis::Histogram::Skew(), Isis::Gruen::StatsLog(), Isis::CameraStatistics::toPvl(), toPvl(), and ZScore().

◆ BelowRange()

bool Isis::Statistics::BelowRange ( const double value )

Definition at line 289 of file Statistics.cpp.

◆ BestMaximum()

double Isis::Statistics::BestMaximum ( const double percent = 99.5 ) const

This method returns the better of the absolute maximum or the Chebyshev maximum.

The better value is considered the value closest to the mean.

Parameters

percent The probability that the maximum is within K standard deviations of the mean (Used to compute the Chebyshev maximum). Default value = 99.5.

Returns: Best of absolute and Chebyshev maximums

See also: Statistics::Maximum Statistics::ChebyshevMaximum

Definition at line 625 of file Statistics.cpp.

References ChebyshevMaximum(), m_validPixels, Maximum(), and Minimum().

Referenced by Isis::VisualDisplay::setPixelData(), and Isis::LinearStretchType::setStretch().

◆ BestMinimum()

double Isis::Statistics::BestMinimum ( const double percent = 99.5 ) const

This method returns the better of the absolute minimum or the Chebyshev minimum.

The better value is considered the value closest to the mean.

Parameters

percent The probability that the minimum is within K standard deviations of the mean (Used to compute the Chebyshev minimum). Default value = 99.5.

Returns: Best of absolute and Chebyshev minimums

See also: Statistics::Minimum Statistics::ChebyshevMinimum

Definition at line 598 of file Statistics.cpp.

References ChebyshevMinimum(), m_validPixels, Maximum(), and Minimum().

Referenced by Isis::VisualDisplay::setPixelData(), and Isis::LinearStretchType::setStretch().

◆ ChebyshevMaximum()

double Isis::Statistics::ChebyshevMaximum ( const double percent = 99.5 ) const

This method returns a maximum such that X percent of the data will fall with K standard deviations of the average (Chebyshev's Theorem).

It can be used to obtain a minimum that does not include statistical outliers.

Parameters

percent The probability that the maximum is within K standard deviations of the mean. Default value = 99.5.

Returns: maximum value excluding statistical outliers

Exceptions

Isis::IException::Message

Definition at line 572 of file Statistics.cpp.

References Average(), m_validPixels, Isis::IException::Programmer, and StandardDeviation().

Referenced by BestMaximum().

◆ ChebyshevMinimum()

double Isis::Statistics::ChebyshevMinimum ( const double percent = 99.5 ) const

This method returns a minimum such that X percent of the data will fall with K standard deviations of the average (Chebyshev's Theorem).

It can be used to obtain a minimum that does not include statistical outliers.

Parameters

percent The probability that the minimum is within K standard deviations of the mean. Default value = 99.5.

Returns: Minimum value (excluding statistical outliers)

Exceptions

Isis::IException::Message

Definition at line 545 of file Statistics.cpp.

References Average(), m_validPixels, Isis::IException::Programmer, and StandardDeviation().

Referenced by BestMinimum().

◆ fromPvl()

void Isis::Statistics::fromPvl ( const PvlGroup & inStats )

private

Unserializes a Statistics object from a pvl group.

Parameters

const PvlGroup &inStats - The input statistics

Definition at line 667 of file Statistics.cpp.

References m_hisPixels, m_hrsPixels, m_lisPixels, m_lrsPixels, m_maximum, m_minimum, m_nullPixels, m_overRangePixels, m_removedData, m_sum, m_sumsum, m_totalPixels, m_underRangePixels, m_validMaximum, m_validMinimum, m_validPixels, and Reset().

Referenced by Statistics().

◆ HisPixels()

BigInt Isis::Statistics::HisPixels ( ) const

Returns the total number of high instrument saturation (HIS) pixels encountered.

Returns: The number of HIS pixels (data) processed

Definition at line 498 of file Statistics.cpp.

References m_hisPixels.

Referenced by Isis::ZeroReverse::init(), and toPvl().

◆ HrsPixels()

BigInt Isis::Statistics::HrsPixels ( ) const

Returns the total number of high representation saturation (HRS) pixels encountered.

Returns: The number of HRS pixels (data) processed

Definition at line 509 of file Statistics.cpp.

References m_hrsPixels.

Referenced by toPvl().

◆ InRange()

bool Isis::Statistics::InRange ( const double value )

Definition at line 279 of file Statistics.cpp.

◆ LisPixels()

BigInt Isis::Statistics::LisPixels ( ) const

Returns the total number of low instrument saturation (LIS) pixels encountered.

Returns: The number of LIS pixels (data) processed

Definition at line 476 of file Statistics.cpp.

References m_lisPixels.

Referenced by Isis::ZeroReverse::init(), and toPvl().

◆ LrsPixels()

BigInt Isis::Statistics::LrsPixels ( ) const

Returns the total number of low representation saturation (LRS) pixels encountered.

Returns: The number of LRS pixels (data) processed

Definition at line 487 of file Statistics.cpp.

References m_lrsPixels.

Referenced by toPvl().

◆ Maximum()

double Isis::Statistics::Maximum ( ) const

Returns the absolute maximum double found in all data passed through the AddData method.

If there are no valid pixels, then NULL8 is returned.

Returns: Current maximum value in data set

Exceptions

Isis::IException::Message The data set is blank, so the maximum is invalid.

Definition at line 403 of file Statistics.cpp.

References m_maximum, m_removedData, m_validPixels, and Isis::IException::Programmer.

Referenced by BestMaximum(), BestMinimum(), Isis::BinaryStretchType::calculateNewStretch(), Isis::SawtoothStretchType::calculateNewStretch(), Isis::BinaryStretchType::endEditChanged(), Isis::LinearStretchType::endEditChanged(), Isis::BinaryStretchType::endSliderMoved(), Isis::LinearStretchType::endSliderMoved(), Isis::QnetPointJigsawErrorFilter::filter(), Isis::QnetPointRegistrationErrorFilter::filter(), Isis::GaussianStretch::GaussianStretch(), Isis::ControlNetStatistics::GenerateControlNetStats(), Isis::SawtoothStretchType::offsetEditChanged(), Isis::SawtoothStretchType::offsetSliderMoved(), Isis::VisualDisplay::paintPixmap(), Isis::SawtoothStretchType::SawtoothStretchType(), Isis::BinaryStretchType::setStretch(), Isis::BinaryStretchType::startEditChanged(), Isis::LinearStretchType::startEditChanged(), Isis::BinaryStretchType::startSliderMoved(), Isis::LinearStretchType::startSliderMoved(), Isis::Gruen::StatsLog(), Isis::CameraStatistics::toPvl(), toPvl(), Isis::SawtoothStretchType::widthEditChanged(), Isis::SawtoothStretchType::widthSliderMoved(), and ZScore().

◆ Minimum()

double Isis::Statistics::Minimum ( ) const

Returns the absolute minimum double found in all data passed through the AddData method.

If there are no valid pixels, then NULL8 is returned.

Returns: Current minimum value in data set.

Exceptions

Isis::IException::Message The data set is blank, so the minimum is invalid.

Definition at line 382 of file Statistics.cpp.

References m_minimum, m_removedData, m_validPixels, and Isis::IException::Programmer.

Referenced by BestMaximum(), BestMinimum(), Isis::BinaryStretchType::calculateNewStretch(), Isis::SawtoothStretchType::calculateNewStretch(), Isis::BinaryStretchType::endEditChanged(), Isis::LinearStretchType::endEditChanged(), Isis::BinaryStretchType::endSliderMoved(), Isis::LinearStretchType::endSliderMoved(), Isis::GaussianStretch::GaussianStretch(), Isis::ControlNetStatistics::GenerateControlNetStats(), Isis::SawtoothStretchType::offsetEditChanged(), Isis::SawtoothStretchType::offsetSliderMoved(), Isis::VisualDisplay::paintPixmap(), Isis::SawtoothStretchType::SawtoothStretchType(), Isis::BinaryStretchType::setStretch(), Isis::BinaryStretchType::startEditChanged(), Isis::LinearStretchType::startEditChanged(), Isis::BinaryStretchType::startSliderMoved(), Isis::LinearStretchType::startSliderMoved(), Isis::Gruen::StatsLog(), Isis::CameraStatistics::toPvl(), toPvl(), Isis::SawtoothStretchType::widthEditChanged(), and Isis::SawtoothStretchType::widthSliderMoved().

◆ NullPixels()

BigInt Isis::Statistics::NullPixels ( ) const

Returns the total number of NULL pixels encountered.

Returns: The number of NULL pixels (data) processed

Definition at line 465 of file Statistics.cpp.

References m_nullPixels.

Referenced by Isis::ZeroReverse::init(), and toPvl().

◆ operator=()

Statistics & Isis::Statistics::operator= ( const Statistics & other )

Definition at line 83 of file Statistics.cpp.

◆ OutOfRangePixels()

BigInt Isis::Statistics::OutOfRangePixels ( ) const

Returns the total number of pixels outside of the valid range encountered.

Returns: The number of Out of Range pixels (data) processed

Definition at line 520 of file Statistics.cpp.

References m_overRangePixels, and m_underRangePixels.

◆ OverRangePixels()

BigInt Isis::Statistics::OverRangePixels ( ) const

Returns the total number of pixels over the valid range encountered.

Returns: The number of pixels less than the ValidMaximum() processed

Definition at line 444 of file Statistics.cpp.

References m_overRangePixels.

Referenced by toPvl().

◆ read()

QDataStream & Isis::Statistics::read ( QDataStream & stream )

Definition at line 879 of file Statistics.cpp.

◆ RemoveData() [1/2]

void Isis::Statistics::RemoveData	(	const double *	data,
		const unsigned int	count )

Remove an array of doubles from the accumulators and counters.

Note that is invalidates the absolute minimum and maximum. They will no longer be usable.

Parameters

data	The data to be removed from data set used for statistical calculations.
count	The number of elements in the data to be removed.

Exceptions

IException::Message RemoveData is trying to remove data that doesn't exist.

Definition at line 206 of file Statistics.cpp.

References RemoveData().

Referenced by Isis::Histogram::RemoveData(), Isis::ImageHistogram::RemoveData(), RemoveData(), and Isis::MultivariateStatistics::RemoveData().

◆ RemoveData() [2/2]

void Isis::Statistics::RemoveData ( const double data )

Definition at line 216 of file Statistics.cpp.

◆ RemovedData()

bool Isis::Statistics::RemovedData ( ) const

Definition at line 525 of file Statistics.cpp.

◆ Reset()

void Isis::Statistics::Reset ( )

Reset all accumulators and counters to zero.

Definition at line 113 of file Statistics.cpp.

References m_hisPixels, m_hrsPixels, m_lisPixels, m_lrsPixels, m_maximum, m_minimum, m_nullPixels, m_overRangePixels, m_removedData, m_sum, m_sumsum, m_totalPixels, m_underRangePixels, and m_validPixels.

Referenced by fromPvl(), Isis::ZeroBufferSmooth::init(), Isis::ZeroReverse::init(), Isis::AutoReg::Reduce(), Isis::Histogram::Reset(), Isis::MultivariateStatistics::Reset(), Isis::Gruen::resetStats(), Isis::VisualDisplay::setLines(), Isis::VisualDisplay::setPixelData(), Isis::VisualDisplay::setSamples(), Statistics(), and Statistics().

◆ Rms()

double Isis::Statistics::Rms ( ) const

Computes and returns the rms.

If there are no valid pixels, then NULL8 is returned.

Returns: The rms (root mean square)

History: 2011-06-13 Ken Edmundson.

Definition at line 365 of file Statistics.cpp.

References m_sumsum, and m_validPixels.

◆ save()

void Isis::Statistics::save	(	QXmlStreamWriter &	stream,
		const Project *	project ) const

Definition at line 726 of file Statistics.cpp.

◆ SetValidRange()

void Isis::Statistics::SetValidRange	(	const double	minimum = Isis::ValidMinimum,
		const double	maximum = Isis::ValidMaximum )

Definition at line 255 of file Statistics.cpp.

◆ StandardDeviation()

double Isis::Statistics::StandardDeviation ( ) const

Computes and returns the standard deviation.

If there are no valid pixels, then NULL8 is returned.

Returns: The standard deviation

Definition at line 312 of file Statistics.cpp.

References m_validPixels, and Variance().

Referenced by ChebyshevMaximum(), ChebyshevMinimum(), Isis::MultivariateStatistics::Correlation(), Isis::ZeroBufferSmooth::init(), Isis::ZeroReverse::init(), Isis::VisualDisplay::paintPixmap(), Isis::Histogram::Skew(), Isis::Gruen::StatsLog(), Isis::CameraStatistics::toPvl(), toPvl(), and ZScore().

◆ Sum()

double Isis::Statistics::Sum ( ) const

Returns the sum of all the data.

Returns: The sum of the data

Definition at line 341 of file Statistics.cpp.

References m_sum.

Referenced by Isis::MultivariateStatistics::Covariance(), Isis::MultivariateStatistics::LinearRegression(), and toPvl().

◆ SumSquare()

double Isis::Statistics::SumSquare ( ) const

Returns the sum of all the squared data.

Returns: The sum of the squared data

Definition at line 351 of file Statistics.cpp.

References m_sumsum.

Referenced by Isis::MultivariateStatistics::LinearRegression(), and toPvl().

◆ toPvl()

PvlGroup Isis::Statistics::toPvl ( QString name = "Statistics" ) const

Serialize statistics as a pvl group.

Parameters

QString name (Default value is "Statistics") - Name of the statistics group

Returns: PvlGroup Statistics information as a pvl group

Definition at line 695 of file Statistics.cpp.

References Average(), HisPixels(), HrsPixels(), LisPixels(), LrsPixels(), Maximum(), Minimum(), NullPixels(), OverRangePixels(), StandardDeviation(), Sum(), SumSquare(), Isis::toString(), TotalPixels(), UnderRangePixels(), ValidPixels(), and Variance().

Referenced by Isis::MultivariateStatistics::toPvl().

◆ TotalPixels()

BigInt Isis::Statistics::TotalPixels ( ) const

Returns the total number of pixels processed (valid and invalid).

Returns: The number of pixels (data) processed

Definition at line 420 of file Statistics.cpp.

References m_totalPixels.

Referenced by Isis::VisualDisplay::paintPixmap(), and toPvl().

◆ UnderRangePixels()

BigInt Isis::Statistics::UnderRangePixels ( ) const

Returns the total number of pixels under the valid range encountered.

Returns: The number of pixels less than the ValidMinimum() processed

Definition at line 455 of file Statistics.cpp.

References m_underRangePixels.

Referenced by toPvl().

◆ ValidMaximum()

double Isis::Statistics::ValidMaximum ( ) const

Definition at line 274 of file Statistics.cpp.

◆ ValidMinimum()

double Isis::Statistics::ValidMinimum ( ) const

Definition at line 269 of file Statistics.cpp.

◆ ValidPixels()

BigInt Isis::Statistics::ValidPixels ( ) const

Returns the total number of valid pixels processed.

Only valid pixels are utilized when computing the average, standard deviation, variance, minimum and maximum.

Returns: The number of valid pixels (data) processed

Definition at line 433 of file Statistics.cpp.

References m_validPixels.

Referenced by Isis::OverlapNormalization::AddOverlap(), Isis::Histogram::Percent(), Isis::Histogram::Skew(), and toPvl().

◆ Variance()

double Isis::Statistics::Variance ( ) const

Computes and returns the variance.

If there are no valid pixels, then NULL8 is returned.

Returns: The variance

History: 2003-08-27 Jeff Anderson - Modified Variance method to compute using n*(n-1) instead of n*n.

Definition at line 328 of file Statistics.cpp.

References m_sum, m_sumsum, and m_validPixels.

Referenced by StandardDeviation(), and toPvl().

◆ write()

QDataStream & Isis::Statistics::write ( QDataStream & stream ) const

Order saved must match the offsets in the static compoundH5DataType() method.

Definition at line 856 of file Statistics.cpp.

References m_hisPixels, m_hrsPixels, m_lisPixels, m_lrsPixels, m_maximum, m_minimum, m_nullPixels, m_overRangePixels, m_removedData, m_sum, m_sumsum, m_totalPixels, m_underRangePixels, m_validMaximum, m_validMinimum, and m_validPixels.

◆ ZScore()

double Isis::Statistics::ZScore ( const double value ) const

This method returns the better of the z-score of the given value.

The z-score is the number of standard deviations the value lies above or below the average.

Parameters

value The value to calculate the z-score of.

Returns: z-score

Definition at line 649 of file Statistics.cpp.

References Average(), Maximum(), Isis::IException::Programmer, StandardDeviation(), and Isis::toString().

Member Data Documentation

◆ m_hisPixels

BigInt Isis::Statistics::m_hisPixels

private

Count of high instrument representation pixels processed.

Definition at line 203 of file Statistics.h.

Referenced by AddData(), fromPvl(), HisPixels(), Reset(), and write().

◆ m_hrsPixels

BigInt Isis::Statistics::m_hrsPixels

private

Count of high instrument saturation pixels processed.

Definition at line 202 of file Statistics.h.

Referenced by AddData(), fromPvl(), HrsPixels(), Reset(), and write().

◆ m_lisPixels

BigInt Isis::Statistics::m_lisPixels

private

Count of low representation saturation pixels processed.

Definition at line 201 of file Statistics.h.

Referenced by AddData(), fromPvl(), LisPixels(), Reset(), and write().

◆ m_lrsPixels

BigInt Isis::Statistics::m_lrsPixels

private

Count of low instrument saturation pixels processed.

Definition at line 200 of file Statistics.h.

Referenced by AddData(), fromPvl(), LrsPixels(), Reset(), and write().

◆ m_maximum

double Isis::Statistics::m_maximum

private

Maximum double value encountered.

Definition at line 194 of file Statistics.h.

Referenced by AddData(), fromPvl(), Maximum(), Reset(), and write().

◆ m_minimum

double Isis::Statistics::m_minimum

private

Minimum double value encountered.

Definition at line 193 of file Statistics.h.

Referenced by AddData(), fromPvl(), Minimum(), Reset(), and write().

◆ m_nullPixels

BigInt Isis::Statistics::m_nullPixels

private

Count of null pixels processed.

Definition at line 199 of file Statistics.h.

Referenced by AddData(), fromPvl(), NullPixels(), Reset(), and write().

◆ m_overRangePixels

BigInt Isis::Statistics::m_overRangePixels

private

Count of pixels greater than the valid range.

Definition at line 205 of file Statistics.h.

Referenced by AddData(), fromPvl(), OutOfRangePixels(), OverRangePixels(), Reset(), and write().

◆ m_removedData

bool Isis::Statistics::m_removedData

private

Indicates the RemoveData method was called which implies m_minimum and m_maximum are invalid.

Definition at line 206 of file Statistics.h.

Referenced by fromPvl(), Maximum(), Minimum(), Reset(), and write().

◆ m_sum

double Isis::Statistics::m_sum

private

The sum accumulator, i.e. the sum of added data values.

Definition at line 190 of file Statistics.h.

Referenced by AddData(), Average(), fromPvl(), Reset(), Sum(), Variance(), and write().

◆ m_sumsum

double Isis::Statistics::m_sumsum

private

The sum-squared accumulator, i.e.

the sum of the squares of the data values.

Definition at line 191 of file Statistics.h.

Referenced by AddData(), fromPvl(), Reset(), Rms(), SumSquare(), Variance(), and write().

◆ m_totalPixels

BigInt Isis::Statistics::m_totalPixels

private

Count of total pixels processed.

Definition at line 197 of file Statistics.h.

Referenced by AddData(), fromPvl(), Reset(), TotalPixels(), and write().

◆ m_underRangePixels

BigInt Isis::Statistics::m_underRangePixels

private

Count of pixels less than the valid range.

Definition at line 204 of file Statistics.h.

Referenced by AddData(), fromPvl(), OutOfRangePixels(), Reset(), UnderRangePixels(), and write().

◆ m_validMaximum

double Isis::Statistics::m_validMaximum

private

Maximum valid pixel value.

Definition at line 196 of file Statistics.h.

Referenced by fromPvl(), and write().

◆ m_validMinimum

double Isis::Statistics::m_validMinimum

private

Minimum valid pixel value.

Definition at line 195 of file Statistics.h.

Referenced by fromPvl(), and write().

◆ m_validPixels

BigInt Isis::Statistics::m_validPixels

private

Count of valid pixels (non-special) processed.

Definition at line 198 of file Statistics.h.

Referenced by AddData(), Average(), BestMaximum(), BestMinimum(), ChebyshevMaximum(), ChebyshevMinimum(), fromPvl(), Maximum(), Minimum(), Reset(), Rms(), StandardDeviation(), ValidPixels(), Variance(), and write().

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

src/base/objs/Statistics/Statistics.h
src/base/objs/Statistics/Statistics.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Statistics() [1/4]

◆ Statistics() [2/4]

◆ Statistics() [3/4]

◆ Statistics() [4/4]

◆ ~Statistics()

Member Function Documentation

◆ AboveRange()

◆ AddData() [1/2]

◆ AddData() [2/2]

◆ Average()

◆ BelowRange()

◆ BestMaximum()

◆ BestMinimum()

◆ ChebyshevMaximum()

◆ ChebyshevMinimum()

◆ fromPvl()

◆ HisPixels()

◆ HrsPixels()

◆ InRange()

◆ LisPixels()

◆ LrsPixels()

◆ Maximum()

◆ Minimum()

◆ NullPixels()

◆ operator=()

◆ OutOfRangePixels()

◆ OverRangePixels()

◆ read()

◆ RemoveData() [1/2]

◆ RemoveData() [2/2]

◆ RemovedData()

◆ Reset()

◆ Rms()

◆ save()

◆ SetValidRange()

◆ StandardDeviation()

◆ Sum()

◆ SumSquare()

◆ toPvl()

◆ TotalPixels()

◆ UnderRangePixels()

◆ ValidMaximum()

◆ ValidMinimum()

◆ ValidPixels()

◆ Variance()

◆ write()

◆ ZScore()

Member Data Documentation

◆ m_hisPixels

◆ m_hrsPixels

◆ m_lisPixels

◆ m_lrsPixels

◆ m_maximum

◆ m_minimum

◆ m_nullPixels

◆ m_overRangePixels

◆ m_removedData

◆ m_sum

◆ m_sumsum

◆ m_totalPixels

◆ m_underRangePixels

◆ m_validMaximum

◆ m_validMinimum

◆ m_validPixels