Gaussian stretch class. More...

#include <GaussianStretch.h>

Inheritance diagram for Isis::GaussianStretch:

Collaboration diagram for Isis::GaussianStretch:

Public Member Functions
	GaussianStretch (Histogram &histogram, const double mean=0.0, const double standardDeviation=1.0)
	Constructs a gaussian stretch object.

	~GaussianStretch ()

double	Map (const double value) const
	Maps an input value to an output value based on the gaussian distribution.

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)

Detailed Description

Gaussian stretch class.

This class is used to stretch the input histogram to a gaussian distribution with the specified mean and standard deviation.

Author: 2006-05-25 Jacob Danton

Constructor & Destructor Documentation

◆ GaussianStretch()

Isis::GaussianStretch::GaussianStretch	(	Histogram &	histogram,
		const double	mean = 0.0,
		const double	standardDeviation = 1.0 )

Constructs a gaussian stretch object.

Parameters

histogram	The input histogram
mean	The mean of the output distribution
standardDeviation	The standard deviation of the output distribution

References Isis::Stretch::AddPair(), Isis::Histogram::Bins(), Isis::Stretch::ClearPairs(), Isis::Statistics::Maximum(), Isis::Statistics::Minimum(), and Isis::Histogram::Percent().

◆ ~GaussianStretch()

Isis::GaussianStretch::~GaussianStretch ( )

inline

Member Function Documentation

◆ AboveRange()

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

inherited

Referenced by Isis::Statistics::AddData(), Isis::Statistics::InRange(), and Isis::Statistics::RemoveData().

◆ 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.

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::HiEqualization::HiCalculateFunctor::addStats(), Isis::CameraStatistics::addStats(), Isis::averageLines(), Isis::averageSamples(), Isis::IndependentCubeViewport::cubeDataChanged(), Isis::GainLineStat(), Isis::ControlNetStatistics::GenerateImageStats(), Isis::ControlPoint::GetStatistic(), Isis::ControlPoint::GetStatistic(), 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.

References Isis::Statistics::AboveRange(), Isis::Statistics::BelowRange(), Isis::IsHisPixel(), Isis::IsHrsPixel(), Isis::IsLisPixel(), Isis::IsLrsPixel(), and Isis::IsNullPixel().

◆ 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

References Isis::NULL8.

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

◆ BelowRange()

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

inherited

Referenced by Isis::Statistics::AddData(), Isis::Statistics::InRange(), and Isis::Statistics::RemoveData().

◆ 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

References Isis::Statistics::ChebyshevMaximum(), Isis::Statistics::Maximum(), Isis::Statistics::Minimum(), and Isis::NULL8.

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

References Isis::Statistics::ChebyshevMinimum(), Isis::Statistics::Maximum(), Isis::Statistics::Minimum(), and Isis::NULL8.

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

◆ 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

References _FILEINFO_, Isis::Statistics::Average(), Isis::NULL8, 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

References _FILEINFO_, Isis::Statistics::Average(), Isis::NULL8, Isis::IException::Programmer, and Isis::Statistics::StandardDeviation().

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

◆ 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

Referenced by 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

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

◆ InRange()

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

inherited

References Isis::Statistics::AboveRange(), and Isis::Statistics::BelowRange().

Referenced by Isis::Histogram::AddData(), Isis::ImageHistogram::AddData(), Isis::Histogram::AddData(), and Isis::ImageHistogram::AddData().

◆ 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

Referenced by 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

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

◆ Map()

double Isis::GaussianStretch::Map ( const double value ) const

Maps an input value to an output value based on the gaussian distribution.

Parameters

value Value to map

Returns: double The mapped output value is returned by this method

References Isis::Stretch::Map().

◆ 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.

References _FILEINFO_, Isis::NULL8, and Isis::IException::Programmer.

Referenced by Isis::Statistics::BestMaximum(), Isis::Statistics::BestMinimum(), Isis::QnetPointJigsawErrorFilter::filter(), Isis::QnetPointRegistrationErrorFilter::filter(), GaussianStretch(), Isis::ControlNetStatistics::GenerateControlNetStats(), Isis::VisualDisplay::paintPixmap(), Isis::SawtoothStretchType::SawtoothStretchType(), Isis::BinaryStretchType::setStretch(), Isis::CameraStatistics::toPvl(), Isis::Statistics::toPvl(), and Isis::Statistics::ZScore().

◆ 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.

References _FILEINFO_, Isis::NULL8, and Isis::IException::Programmer.

Referenced by Isis::Statistics::BestMaximum(), Isis::Statistics::BestMinimum(), GaussianStretch(), Isis::ControlNetStatistics::GenerateControlNetStats(), Isis::VisualDisplay::paintPixmap(), Isis::SawtoothStretchType::SawtoothStretchType(), Isis::BinaryStretchType::setStretch(), Isis::CameraStatistics::toPvl(), and Isis::Statistics::toPvl().

◆ NullPixels()

BigInt Isis::Statistics::NullPixels ( ) const

inherited

Returns the total number of NULL pixels encountered.

Returns: The number of NULL pixels (data) processed

Referenced by 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

◆ 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

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

◆ read()

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

inherited

Referenced by Isis::operator>>().

◆ 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.

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

References _FILEINFO_, Isis::Statistics::AboveRange(), Isis::Statistics::BelowRange(), Isis::IsHisPixel(), Isis::IsHrsPixel(), Isis::IsLisPixel(), Isis::IsLrsPixel(), Isis::IsNullPixel(), and Isis::IException::Programmer.

◆ RemovedData()

bool Isis::Statistics::RemovedData ( ) const

inherited

◆ Reset()

void Isis::Statistics::Reset ( )

inherited

Reset all accumulators and counters to zero.

Referenced by Isis::AutoReg::Reduce(), Isis::Histogram::Reset(), Isis::MultivariateStatistics::Reset(), Isis::VisualDisplay::setLines(), Isis::VisualDisplay::setPixelData(), Isis::VisualDisplay::setSamples(), Isis::Statistics::Statistics(), 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)

References Isis::NULL8.

◆ save()

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

inherited

References Isis::toString().

◆ SetValidRange()

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

inherited

References _FILEINFO_, Isis::IException::Programmer, and Isis::toString().

Referenced by Isis::StandardDeviationOperator::Interest(), Isis::Histogram::SetValidRange(), Isis::Statistics::Statistics(), Isis::Statistics::Statistics(), and Isis::Statistics::Statistics().

◆ StandardDeviation()

double Isis::Statistics::StandardDeviation ( ) const

inherited

Computes and returns the standard deviation.

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

Returns: The standard deviation

References Isis::NULL8, and Isis::Statistics::Variance().

Referenced by Isis::Statistics::ChebyshevMaximum(), Isis::Statistics::ChebyshevMinimum(), Isis::MultivariateStatistics::Correlation(), Isis::VisualDisplay::paintPixmap(), Isis::Histogram::Skew(), Isis::CameraStatistics::toPvl(), Isis::Statistics::toPvl(), and Isis::Statistics::ZScore().

◆ Sum()

double Isis::Statistics::Sum ( ) const

inherited

Returns the sum of all the data.

Returns: The sum of the data

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

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

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

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

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

◆ ValidMaximum()

double Isis::Statistics::ValidMaximum ( ) const

inherited

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

◆ ValidMinimum()

double Isis::Statistics::ValidMinimum ( ) const

inherited

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

◆ 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

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

References Isis::NULL8.

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.

Referenced by Isis::operator<<().

◆ 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

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

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

/Users/astamile/ISIS3/isis/src/base/objs/GaussianStretch/GaussianStretch.h
/Users/astamile/ISIS3/isis/src/base/objs/GaussianStretch/GaussianStretch.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ GaussianStretch()

◆ ~GaussianStretch()

Member Function Documentation

◆ AboveRange()

◆ AddData() [1/2]

◆ AddData() [2/2]

◆ Average()

◆ BelowRange()

◆ BestMaximum()

◆ BestMinimum()

◆ ChebyshevMaximum()

◆ ChebyshevMinimum()

◆ HisPixels()

◆ HrsPixels()

◆ InRange()

◆ LisPixels()

◆ LrsPixels()

◆ Map()

◆ Maximum()

◆ Minimum()

◆ NullPixels()

◆ 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()