Isis 3 Developer Reference
Isis::GaussianStretch Class Reference

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

~GaussianStretch ()

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

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

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

Add a double to the accumulators and counters. More...

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

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

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

double Variance () const
Computes and returns the variance. More...

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

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

double Rms () const
Computes and returns the rms. More...

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

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

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). More...

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). More...

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

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

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

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

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

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

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

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

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

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

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

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

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

bool RemovedData () const

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

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

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

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.

Constructor & Destructor Documentation

 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
 Isis::GaussianStretch::~GaussianStretch ( )
inline

Member Function Documentation

 bool Isis::Statistics::AboveRange ( const double value )
inherited
 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.
 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.
 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.

 bool Isis::Statistics::BelowRange ( const double value )
inherited
 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
Statistics::Maximum Statistics::ChebyshevMaximum
 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
Statistics::Minimum Statistics::ChebyshevMinimum
 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

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

 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

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

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

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

 bool Isis::Statistics::InRange ( const double value )
inherited
 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().

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

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

 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.

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

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

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

Referenced by Isis::operator>>().

 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.

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

 void Isis::Statistics::RemoveData ( const double data )
inherited
 bool Isis::Statistics::RemovedData ( ) const
inherited
 void Isis::Statistics::Reset ( )
inherited

Reset all accumulators and counters to zero.

 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.

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

References Isis::toString().

 void Isis::Statistics::SetValidRange ( const double minimum = Isis::ValidMinimum, const double maximum = Isis::ValidMaximum )
inherited
 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().

 double Isis::Statistics::Sum ( ) const
inherited

Returns the sum of all the data.

Returns
The sum of the data
 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().

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

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

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

 double Isis::Statistics::ValidMaximum ( ) const
inherited

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

 double Isis::Statistics::ValidMinimum ( ) const
inherited

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

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

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

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

Referenced by Isis::operator<<().

 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

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