gaussian distribution class More...

#include <GaussianDistribution.h>

Inheritance diagram for Isis::GaussianDistribution:

Collaboration diagram for Isis::GaussianDistribution:

Public Member Functions
	GaussianDistribution (const double mean=0.0, const double standardDeviation=1.0)
	Constructs a gaussian distribution object.

double	Probability (const double value)
	Computes and returns the probability of the specified value on the gaussian distribution.

double	CumulativeDistribution (const double value)
	Computes and returns the cumulative distribution up to the specified value on the gaussian distribution.

double	InverseCumulativeDistribution (const double percent)
	Computes and returns the inverse cumulative distribution evaluated at the specified percentage value on the gaussian distribution.

double	Mean () const
	Returns the mean.

double	StandardDeviation () const
	Returns the standard deviation.

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	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
double	A (const double x)

double	B (const double x)

double	C (const double x)

double	D (const double x)

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

Private Attributes
double	p_mean
	Value of the mean.

double	p_stdev
	Value of the standard deviation.

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

gaussian distribution class

This class is used to calculate the probability distribution function, the cumulative distribution function, and the inverse cumulative distribution function of a gaussian (or normal) distribution.

Author: 2006-05-25 Jacob Danton

History

2006-05-25 Jacob Danton Original Version

2007-07-09 Janet Barrett - Removed invalid declaration of "static const double" variables p_lowCutoff and p_highCutoff from this file and moved them to the GaussianDistribution.cpp file. The variables were also renamed to lowCutoff and highCutoff.

Definition at line 37 of file GaussianDistribution.h.

Constructor & Destructor Documentation

◆ GaussianDistribution()

Isis::GaussianDistribution::GaussianDistribution	(	const double	mean = 0.0,
		const double	standardDeviation = 1.0 )

Constructs a gaussian distribution object.

Parameters

mean	The Distribution's mean
standardDeviation	The Distribution's standard deviation

Definition at line 20 of file GaussianDistribution.cpp.

References p_mean, and p_stdev.

◆ ~GaussianDistribution()

Isis::GaussianDistribution::~GaussianDistribution ( )

inline

Definition at line 40 of file GaussianDistribution.h.

Member Function Documentation

◆ A()

double Isis::GaussianDistribution::A ( const double x )

private

Definition at line 140 of file GaussianDistribution.cpp.

◆ AboveRange()

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

inherited

Definition at line 284 of file Statistics.cpp.

◆ AddData() [1/2]

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

inherited

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 Isis::Statistics::AddData().

Referenced by Isis::Histogram::AddData(), Isis::ImageHistogram::AddData(), Isis::Statistics::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 )

inherited

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.

◆ Average()

double Isis::Statistics::Average ( ) const

inherited

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 Isis::Statistics::m_sum, and Isis::Statistics::m_validPixels.

Referenced by Isis::OverlapNormalization::AddOverlap(), Isis::ControlNet::AverageResidual(), Isis::Statistics::ChebyshevMaximum(), Isis::Statistics::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(), Isis::Statistics::toPvl(), and Isis::Statistics::ZScore().

◆ B()

double Isis::GaussianDistribution::B ( const double x )

private

Definition at line 152 of file GaussianDistribution.cpp.

◆ BelowRange()

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

inherited

Definition at line 289 of file Statistics.cpp.

◆ BestMaximum()

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

inherited

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 Isis::Statistics::ChebyshevMaximum(), Isis::Statistics::m_validPixels, Isis::Statistics::Maximum(), and Isis::Statistics::Minimum().

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

◆ BestMinimum()

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

inherited

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 Isis::Statistics::ChebyshevMinimum(), Isis::Statistics::m_validPixels, Isis::Statistics::Maximum(), and Isis::Statistics::Minimum().

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

◆ C()

double Isis::GaussianDistribution::C ( const double x )

private

Definition at line 164 of file GaussianDistribution.cpp.

◆ ChebyshevMaximum()

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

inherited

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 Isis::Statistics::Average(), Isis::Statistics::m_validPixels, Isis::IException::Programmer, and Isis::Statistics::StandardDeviation().

Referenced by Isis::Statistics::BestMaximum().

◆ ChebyshevMinimum()

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

inherited

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 Isis::Statistics::Average(), Isis::Statistics::m_validPixels, Isis::IException::Programmer, and Isis::Statistics::StandardDeviation().

Referenced by Isis::Statistics::BestMinimum().

◆ CumulativeDistribution()

double Isis::GaussianDistribution::CumulativeDistribution ( const double value )

Computes and returns the cumulative distribution up to the specified value on the gaussian distribution.

Parameters

value the input value

Returns: The CDF evaluated at the specified value

Definition at line 48 of file GaussianDistribution.cpp.

References p_mean, p_stdev, and Isis::PI.

Referenced by InverseCumulativeDistribution().

◆ D()

double Isis::GaussianDistribution::D ( const double x )

private

Definition at line 176 of file GaussianDistribution.cpp.

◆ fromPvl()

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

privateinherited

Unserializes a Statistics object from a pvl group.

Parameters

const PvlGroup &inStats - The input statistics

Definition at line 667 of file Statistics.cpp.

Referenced by Isis::Statistics::Statistics().

◆ HisPixels()

BigInt Isis::Statistics::HisPixels ( ) const

inherited

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 Isis::Statistics::m_hisPixels.

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

◆ HrsPixels()

BigInt Isis::Statistics::HrsPixels ( ) const

inherited

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 Isis::Statistics::m_hrsPixels.

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

◆ InRange()

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

inherited

Definition at line 279 of file Statistics.cpp.

◆ InverseCumulativeDistribution()

double Isis::GaussianDistribution::InverseCumulativeDistribution ( const double percent )

Computes and returns the inverse cumulative distribution evaluated at the specified percentage value on the gaussian distribution.

See also

"Rational Chebyshev Approximations for the Error Function

W. J. Cody

http://home.online.no/~pjacklam/notes/invnorm/#The_distribution_function

Parameters

percent The input percentage value

Returns: The ICDF evaluated at the specified percentage value

Definition at line 90 of file GaussianDistribution.cpp.

References CumulativeDistribution(), p_mean, p_stdev, Isis::PI, and Isis::IException::Programmer.

◆ LisPixels()

BigInt Isis::Statistics::LisPixels ( ) const

inherited

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 Isis::Statistics::m_lisPixels.

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

◆ LrsPixels()

BigInt Isis::Statistics::LrsPixels ( ) const

inherited

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 Isis::Statistics::m_lrsPixels.

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

◆ Maximum()

double Isis::Statistics::Maximum ( ) const

inherited

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 Isis::Statistics::m_maximum, Isis::Statistics::m_removedData, Isis::Statistics::m_validPixels, and Isis::IException::Programmer.

Referenced by Isis::Statistics::BestMaximum(), Isis::Statistics::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(), Isis::Statistics::toPvl(), Isis::SawtoothStretchType::widthEditChanged(), Isis::SawtoothStretchType::widthSliderMoved(), and Isis::Statistics::ZScore().

◆ Mean()

double Isis::GaussianDistribution::Mean ( ) const

inline

Returns the mean.

Returns: The mean

Definition at line 51 of file GaussianDistribution.h.

References p_mean.

◆ Minimum()

double Isis::Statistics::Minimum ( ) const

inherited

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 Isis::Statistics::m_minimum, Isis::Statistics::m_removedData, Isis::Statistics::m_validPixels, and Isis::IException::Programmer.

Referenced by Isis::Statistics::BestMaximum(), Isis::Statistics::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(), Isis::Statistics::toPvl(), Isis::SawtoothStretchType::widthEditChanged(), and Isis::SawtoothStretchType::widthSliderMoved().

◆ NullPixels()

BigInt Isis::Statistics::NullPixels ( ) const

inherited

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 Isis::Statistics::m_nullPixels.

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

◆ OutOfRangePixels()

BigInt Isis::Statistics::OutOfRangePixels ( ) const

inherited

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 Isis::Statistics::m_overRangePixels, and Isis::Statistics::m_underRangePixels.

◆ OverRangePixels()

BigInt Isis::Statistics::OverRangePixels ( ) const

inherited

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 Isis::Statistics::m_overRangePixels.

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

◆ Probability()

double Isis::GaussianDistribution::Probability ( const double value )

Computes and returns the probability of the specified value on the gaussian distribution.

Parameters

value The input value

Returns: The PDF evaluated at the specified value

Definition at line 34 of file GaussianDistribution.cpp.

References p_mean, p_stdev, and Isis::PI.

◆ read()

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

inherited

Definition at line 879 of file Statistics.cpp.

◆ RemoveData() [1/2]

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

inherited

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 Isis::Statistics::RemoveData().

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

◆ RemoveData() [2/2]

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

inherited

Definition at line 216 of file Statistics.cpp.

◆ RemovedData()

bool Isis::Statistics::RemovedData ( ) const

inherited

Definition at line 525 of file Statistics.cpp.

◆ Reset()

void Isis::Statistics::Reset ( )

inherited

Reset all accumulators and counters to zero.

Definition at line 113 of file Statistics.cpp.

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

Referenced by Isis::Statistics::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(), Isis::Statistics::Statistics(), and Isis::Statistics::Statistics().

◆ Rms()

double Isis::Statistics::Rms ( ) const

inherited

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 Isis::Statistics::m_sumsum, and Isis::Statistics::m_validPixels.

◆ save()

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

inherited

Definition at line 726 of file Statistics.cpp.

◆ SetValidRange()

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

inherited

Definition at line 255 of file Statistics.cpp.

◆ StandardDeviation()

double Isis::GaussianDistribution::StandardDeviation ( ) const

inline

Returns the standard deviation.

Returns: The standard deviation

Definition at line 60 of file GaussianDistribution.h.

References p_stdev.

◆ Sum()

double Isis::Statistics::Sum ( ) const

inherited

Returns the sum of all the data.

Returns: The sum of the data

Definition at line 341 of file Statistics.cpp.

References Isis::Statistics::m_sum.

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

◆ SumSquare()

double Isis::Statistics::SumSquare ( ) const

inherited

Returns the sum of all the squared data.

Returns: The sum of the squared data

Definition at line 351 of file Statistics.cpp.

References Isis::Statistics::m_sumsum.

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

◆ toPvl()

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

inherited

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.

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

◆ TotalPixels()

BigInt Isis::Statistics::TotalPixels ( ) const

inherited

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 Isis::Statistics::m_totalPixels.

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

◆ UnderRangePixels()

BigInt Isis::Statistics::UnderRangePixels ( ) const

inherited

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 Isis::Statistics::m_underRangePixels.

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

◆ ValidMaximum()

double Isis::Statistics::ValidMaximum ( ) const

inherited

Definition at line 274 of file Statistics.cpp.

◆ ValidMinimum()

double Isis::Statistics::ValidMinimum ( ) const

inherited

Definition at line 269 of file Statistics.cpp.

◆ ValidPixels()

BigInt Isis::Statistics::ValidPixels ( ) const

inherited

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 Isis::Statistics::m_validPixels.

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

◆ Variance()

double Isis::Statistics::Variance ( ) const

inherited

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 Isis::Statistics::m_sum, Isis::Statistics::m_sumsum, and Isis::Statistics::m_validPixels.

Referenced by Isis::Statistics::StandardDeviation(), and Isis::Statistics::toPvl().

◆ write()

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

inherited

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

Definition at line 856 of file Statistics.cpp.

◆ ZScore()

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

inherited

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 Isis::Statistics::Average(), Isis::Statistics::Maximum(), Isis::IException::Programmer, Isis::Statistics::StandardDeviation(), and Isis::toString().

Member Data Documentation

◆ m_hisPixels

BigInt Isis::Statistics::m_hisPixels

privateinherited

Count of high instrument representation pixels processed.

Definition at line 203 of file Statistics.h.

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

◆ m_hrsPixels

BigInt Isis::Statistics::m_hrsPixels

privateinherited

Count of high instrument saturation pixels processed.

Definition at line 202 of file Statistics.h.

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

◆ m_lisPixels

BigInt Isis::Statistics::m_lisPixels

privateinherited

Count of low representation saturation pixels processed.

Definition at line 201 of file Statistics.h.

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

◆ m_lrsPixels

BigInt Isis::Statistics::m_lrsPixels

privateinherited

Count of low instrument saturation pixels processed.

Definition at line 200 of file Statistics.h.

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

◆ m_maximum

double Isis::Statistics::m_maximum

privateinherited

Maximum double value encountered.

Definition at line 194 of file Statistics.h.

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

◆ m_minimum

double Isis::Statistics::m_minimum

privateinherited

Minimum double value encountered.

Definition at line 193 of file Statistics.h.

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

◆ m_nullPixels

BigInt Isis::Statistics::m_nullPixels

privateinherited

Count of null pixels processed.

Definition at line 199 of file Statistics.h.

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

◆ m_overRangePixels

BigInt Isis::Statistics::m_overRangePixels

privateinherited

Count of pixels greater than the valid range.

Definition at line 205 of file Statistics.h.

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

◆ m_removedData

bool Isis::Statistics::m_removedData

privateinherited

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 Isis::Statistics::fromPvl(), Isis::Statistics::Maximum(), Isis::Statistics::Minimum(), Isis::Statistics::Reset(), and Isis::Statistics::write().

◆ m_sum

double Isis::Statistics::m_sum

privateinherited

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

Definition at line 190 of file Statistics.h.

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

◆ m_sumsum

double Isis::Statistics::m_sumsum

privateinherited

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 Isis::Statistics::AddData(), Isis::Statistics::fromPvl(), Isis::Statistics::Reset(), Isis::Statistics::Rms(), Isis::Statistics::SumSquare(), Isis::Statistics::Variance(), and Isis::Statistics::write().

◆ m_totalPixels

BigInt Isis::Statistics::m_totalPixels

privateinherited

Count of total pixels processed.

Definition at line 197 of file Statistics.h.

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

◆ m_underRangePixels

BigInt Isis::Statistics::m_underRangePixels

privateinherited

Count of pixels less than the valid range.

Definition at line 204 of file Statistics.h.

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

◆ m_validMaximum

double Isis::Statistics::m_validMaximum

privateinherited

Maximum valid pixel value.

Definition at line 196 of file Statistics.h.

Referenced by Isis::Statistics::fromPvl(), and Isis::Statistics::write().

◆ m_validMinimum

double Isis::Statistics::m_validMinimum

privateinherited

Minimum valid pixel value.

Definition at line 195 of file Statistics.h.

Referenced by Isis::Statistics::fromPvl(), and Isis::Statistics::write().

◆ m_validPixels

BigInt Isis::Statistics::m_validPixels

privateinherited

Count of valid pixels (non-special) processed.

Definition at line 198 of file Statistics.h.

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

◆ p_mean

double Isis::GaussianDistribution::p_mean

private

Value of the mean.

Definition at line 66 of file GaussianDistribution.h.

Referenced by CumulativeDistribution(), GaussianDistribution(), InverseCumulativeDistribution(), Mean(), and Probability().

◆ p_stdev

double Isis::GaussianDistribution::p_stdev

private

Value of the standard deviation.

Definition at line 68 of file GaussianDistribution.h.

Referenced by CumulativeDistribution(), GaussianDistribution(), InverseCumulativeDistribution(), Probability(), and StandardDeviation().

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

src/base/objs/GaussianDistribution/GaussianDistribution.h
src/base/objs/GaussianDistribution/GaussianDistribution.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GaussianDistribution()

◆ ~GaussianDistribution()

Member Function Documentation

◆ A()

◆ AboveRange()

◆ AddData() [1/2]

◆ AddData() [2/2]

◆ Average()

◆ B()

◆ BelowRange()

◆ BestMaximum()

◆ BestMinimum()

◆ C()

◆ ChebyshevMaximum()

◆ ChebyshevMinimum()

◆ CumulativeDistribution()

◆ D()

◆ fromPvl()

◆ HisPixels()

◆ HrsPixels()

◆ InRange()

◆ InverseCumulativeDistribution()

◆ LisPixels()

◆ LrsPixels()

◆ Maximum()

◆ Mean()

◆ Minimum()

◆ NullPixels()

◆ OutOfRangePixels()

◆ OverRangePixels()

◆ Probability()

◆ 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

◆ p_mean

◆ p_stdev