Container of a cube histogram. More...

#include <Histogram.h>

Inheritance diagram for Isis::Histogram:

Collaboration diagram for Isis::Histogram:

Public Member Functions
	Histogram (double minimum, double maximum, int bins=1024)
	Constructs a histogram object.

	Histogram (Cube &cube, int statsBand, Progress *progress=NULL, double startSample=1.0, double startLine=1.0, double endSample=Null, double endLine=Null, int bins=0, bool addCubeData=false)

	Histogram (ControlNet &net, double(ControlMeasure::*statFunc)() const, int bins)
	Constructs a histogram from a control netowrk.

	Histogram (ControlNet &net, double(ControlMeasure::*statFunc)() const, double binWidth)
	Constructs a histogram from a control netowrk.

	~Histogram ()
	Destructs a histogram object.

void	SetBins (const int bins)
	Change the number of bins in the histogram and reset counters.

void	Reset ()
	Resets histogram counters to zero.

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

virtual void	AddData (const double data)
	Add a single double data to the histogram.

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

double	Median () const
	Returns the median.

double	Mode () const
	Returns the mode.

double	Percent (const double percent) const
	Computes and returns the value at X percent of the histogram.

double	Skew () const
	Computes and returns the skew.

BigInt	BinCount (const int index) const
	Returns the count at a bin position in the histogram.

virtual void	BinRange (const int index, double &low, double &high) const
	Returns the left edge and right edge values of a bin.

double	BinMiddle (const int index) const
	Returns the value represented by a bin.

double	BinSize () const
	Returns the size of an individual bin.

int	Bins () const
	Returns the number of bins in the histogram.

BigInt	MaxBinCount () const
	Returns the highest bin count.

double	BinRangeStart () const

double	BinRangeEnd () const

void	SetValidRange (const double minimum=Isis::ValidMinimum, const double maximum=Isis::ValidMaximum)
	Changes the range of the bins.

void	RemoveData (const double data)

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)

Protected Attributes
std::vector< BigInt >	p_bins
	The array of counts.

Private Member Functions
void	addMeasureDataFromNet (ControlNet &net, double(ControlMeasure::*statFunc)() const)
	Iterates through all the measures in a network adding them to the histogram.

void	rangesFromNet (ControlNet &net, double(ControlMeasure::*statFunc)() const)
	Iterates through all the measures in a network in order to find the domain of the data.

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

Private Attributes
double	p_binRangeStart

double	p_binRangeEnd

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

Container of a cube histogram.

This class is used to accumulate a histogram on double arrays. In particular, it is highly useful for obtaining a histogram on cube data. Parameters which can be computed are the 1) median, 2) mode, and 3) skew. The histogram consists of a fixed set of distinct bins. When an object is created the programmer must provide a minimum and maximum which defines how data is further placed in the bins. The minimum is mapped to the left edge of the first bin [0] and the maximum is mapped to the right edge of the last bin [Bins()-1]. There are a set of methods which return bin information such as 1) count, 2) size, 3) middle value, 4) range, and 5) maximum bin count.

Author: 2002-05-13 Jeff Anderson

Todo: This class needs an example.

History

2002-05-22 Jeff Anderson moved Reset, AddData, and RemoveData methods into public space.

2002-10-05 Tracie Sucharski added MaxBinCount, a method to return the maximum bin count.

2005-06-21 Modified index computations in AddData and RemoveData to round

2008-08-15 Added BinRange methods and functionality. Now, you can collect statistics over all of the data and also set where the binning will start and end. Increased the default number of bins for floating point cubes.

2012-01-19 Steven Lambright and Jai Rideout - Added constructor parameters to read from the Cube automatically.

2012-04-10 Orrin Thomas - Added constructor parameters to read from ControlNets automatically (For control measure data.)

2015-09-03 Tyler Wilson - Overrode Statistics::SetValidRange to set the bin range as well as the statistical range for the data. The function Histogram::SetBinRange has been removed from this class.

2016-04-20 Makayla Shepherd - Added UnsignedWord pixel type handling.

2017-05-19 Christopher Combs - Modified unitTest.cpp: Removed path of output file name in output PVL to allow the test to pass when not using the standard data areas. Fixes #4738.

2017-09-08 Summer Stapleton - Included test for Isis::Null being returned from accessor method call in Histogram::rangesFromNet(). Fixes #5123, #1673.

2018-07-27 Jesse Mapel - Added support for initializing a histogram from signed and unsigned word cubes. References #971.

2020-06-11 Kaitlyn Lee - Changed how to detemine which bin a pixel/measure falls into in AddData(). Changed how the bin range is calculated in BinRange(). The math for these functions were incorrect and not intuitive. These changes were made alongside changes made to cnethist and hist.

Definition at line 74 of file Histogram.h.

Constructor & Destructor Documentation

◆ Histogram() [1/3]

Isis::Histogram::Histogram	(	double	minimum,
		double	maximum,
		int	nbins = 1024 )

Constructs a histogram object.

Only data between the minimum and maximum will be binned, and the bin range will be from the minimum to the maximum.

Parameters

minimum	Minimum value for binning the data into the histogram.
maximum	Maximum value for binning the data into the histogram.
nbins	The number of bins to use

Definition at line 33 of file Histogram.cpp.

References SetBins(), and SetValidRange().

◆ Histogram() [2/3]

Isis::Histogram::Histogram	(	ControlNet &	net,
		double(ControlMeasure::*)() const	statFunc,
		int	bins )

Constructs a histogram from a control netowrk.

Parameters

net	Reference to a ControlNetwork used to access all the measures.
statFunc	Pointer to a ControlMeasure acessor, the returns of this function call will be used to build up the network.
bins	The number of bins to divide the histogram into.

Exceptions

The	number of Histogram Bins must be greater than 0.

Definition at line 49 of file Histogram.cpp.

References addMeasureDataFromNet(), Isis::IException::Programmer, rangesFromNet(), and SetBins().

◆ Histogram() [3/3]

Isis::Histogram::Histogram	(	ControlNet &	net,
		double(ControlMeasure::*)() const	statFunc,
		double	binWidth )

Constructs a histogram from a control netowrk.

Parameters

Net	Reference to a ControlNetwork used to access all the measures.
statFunc	Pointer to a ControlMeasure acessor, the returns of this. function call will be used to build up the network.
binWidth	The width of histogram bins.

Exceptions

The	width of Histogram Bins must be greater than 0.

Definition at line 74 of file Histogram.cpp.

References addMeasureDataFromNet(), Isis::IException::Programmer, rangesFromNet(), and SetBins().

◆ ~Histogram()

Isis::Histogram::~Histogram ( )

Destructs a histogram object.

Definition at line 175 of file Histogram.cpp.

Member Function Documentation

◆ AboveRange()

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

inherited

Definition at line 284 of file Statistics.cpp.

◆ AddData() [1/2]

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

virtual

Add an array of doubles to the histogram counters.

This method can be invoked multiple times. For example, once for each line in a cube, before obtaining statistics and histogram information.

Parameters

data	Pointer to array of double to add.
count	Number of doubles to process.

Reimplemented in Isis::ImageHistogram.

Definition at line 232 of file Histogram.cpp.

References Isis::Statistics::AddData(), Isis::IsValidPixel(), and p_bins.

Referenced by addMeasureDataFromNet().

◆ AddData() [2/2]

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

virtual

Add a single double data to the histogram.

Of course this can be invoke multiple times. e.g. once for each residual in a network for instance.

Parameters

data	a single observation to be added to the histogram

Reimplemented in Isis::ImageHistogram.

Definition at line 262 of file Histogram.cpp.

References Isis::Statistics::AddData(), Isis::IsValidPixel(), and p_bins.

◆ addMeasureDataFromNet()

void Isis::Histogram::addMeasureDataFromNet	(	ControlNet &	net,
		double(ControlMeasure::*)() const	statFunc )

private

Iterates through all the measures in a network adding them to the histogram.

Parameters

net	reference to a ControlNetwork used to access all the measures
statFunc	pointer to a ControlMeasure acessor, the returns of this function call will be used to build up the network

Definition at line 105 of file Histogram.cpp.

References AddData(), and Isis::ControlPoint::GetMeasure().

Referenced by Histogram(), and Histogram().

◆ 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(), Skew(), Isis::Gruen::StatsLog(), Isis::CameraStatistics::toPvl(), Isis::Statistics::toPvl(), and Isis::Statistics::ZScore().

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

◆ BinCount()

BigInt Isis::Histogram::BinCount ( const int index ) const

Returns the count at a bin position in the histogram.

Parameters

index Index of the desired bin 0 to Bins()-1.

Returns: The count at a bin position in the histogram.

Definition at line 403 of file Histogram.cpp.

References Isis::Message::ArraySubscriptNotInRange(), p_bins, and Isis::IException::Programmer.

◆ BinMiddle()

double Isis::Histogram::BinMiddle ( const int index ) const

Returns the value represented by a bin.

This is not the count, but the actual data value at the middle of the bin.

Parameters

index Index of the desired bin 0 to Bins()-1.

Returns: The middle value of the bin.

Definition at line 449 of file Histogram.cpp.

References Isis::Message::ArraySubscriptNotInRange(), BinRange(), p_bins, and Isis::IException::Programmer.

Referenced by Mode(), and Percent().

◆ BinRange()

void Isis::Histogram::BinRange	(	const int	index,
		double &	low,
		double &	high ) const

virtual

Returns the left edge and right edge values of a bin.

That is the range of data the bin covers.

Exceptions

iException The programmer has passed in an index outside of 0 to Bins()-1.

Parameters

index	Index of the desired bin 0 to Bins()-1.
low	The value at the left edge of the requested bin.
high	The value at the right edge of the requested bin.

Reimplemented in Isis::ImageHistogram.

Definition at line 427 of file Histogram.cpp.

References Isis::Message::ArraySubscriptNotInRange(), p_bins, and Isis::IException::Programmer.

Referenced by BinMiddle(), and BinSize().

◆ BinRangeEnd()

double Isis::Histogram::BinRangeEnd ( ) const

inline

Definition at line 112 of file Histogram.h.

◆ BinRangeStart()

double Isis::Histogram::BinRangeStart ( ) const

inline

Definition at line 109 of file Histogram.h.

◆ Bins()

int Isis::Histogram::Bins ( ) const

Returns the number of bins in the histogram.

Returns: The number of bins in the histogram.

Definition at line 483 of file Histogram.cpp.

References p_bins.

Referenced by Isis::GaussianStretch::GaussianStretch().

◆ BinSize()

double Isis::Histogram::BinSize ( ) const

Returns the size of an individual bin.

Essentially, the difference of the high and low edge values (BinRange) of a bin. This value is constant for all bins.

Returns: The size of the individual bin.

Definition at line 470 of file Histogram.cpp.

References BinRange().

Referenced by Isis::BinaryStretchType::calculateNewStretch(), Isis::SawtoothStretchType::calculateNewStretch(), Isis::BinaryStretchType::setStretch(), Isis::LinearStretchType::setStretch(), Isis::SawtoothStretchType::setStretch(), Isis::SawtoothStretchType::widthEditChanged(), and Isis::SawtoothStretchType::widthSliderMoved().

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

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

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

◆ MaxBinCount()

BigInt Isis::Histogram::MaxBinCount ( ) const

Returns the highest bin count.

Returns: The highest bin count.

Definition at line 493 of file Histogram.cpp.

References p_bins.

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

◆ Median()

double Isis::Histogram::Median ( ) const

Returns the median.

Returns: The median

Definition at line 319 of file Histogram.cpp.

References Percent().

Referenced by Isis::SawtoothStretchType::SawtoothStretchType(), and Skew().

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

◆ Mode()

double Isis::Histogram::Mode ( ) const

Returns the mode.

Returns: The mode

Definition at line 328 of file Histogram.cpp.

References BinMiddle(), and p_bins.

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

◆ Percent()

double Isis::Histogram::Percent ( const double percent ) const

Computes and returns the value at X percent of the histogram.

For example, Percent(50.0) is equivalent to the computing the median. While Percent(0.5) and Percent(99.5) would obtain a minimum and maximum for the data that could be used for a good contrast stretch.

Parameters

percent X percent of the histogram to compute.

Returns: The value at X percent of the histogram.

Definition at line 351 of file Histogram.cpp.

References BinMiddle(), p_bins, Isis::IException::Programmer, and Isis::Statistics::ValidPixels().

Referenced by Isis::BinaryStretchType::BinaryStretchType(), Isis::GaussianStretch::GaussianStretch(), and Median().

◆ rangesFromNet()

void Isis::Histogram::rangesFromNet	(	ControlNet &	net,
		double(ControlMeasure::*)() const	statFunc )

private

Iterates through all the measures in a network in order to find the domain of the data.

Parameters

net	reference to a ControlNetwork used to access all the measures
statFunc	pointer to a ControlMeasure acessor, the returns of this function call will be used to build up the network

Exceptions

The	net file appears to have 1 or fewer measures, thus no histogram can be formed

Definition at line 135 of file Histogram.cpp.

References Isis::ControlPoint::GetMeasure(), Isis::IsSpecial(), SetValidRange(), and Isis::IException::User.

Referenced by Histogram(), and Histogram().

◆ read()

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

inherited

Definition at line 879 of file Statistics.cpp.

◆ RemoveData() [1/2]

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

virtual

Remove an array of doubles from the histogram counters.

Note that this invalidates the absolute minimum and maximum. They will no longer be useable.

See also: Stats

Parameters

data	Pointer to array of doubles to remove.
count	number of doubles to process.

Reimplemented in Isis::ImageHistogram.

Definition at line 291 of file Histogram.cpp.

References Isis::IsValidPixel(), p_bins, and Isis::Statistics::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::Histogram::Reset ( )

Resets histogram counters to zero.

Definition at line 210 of file Histogram.cpp.

References p_bins, and Isis::Statistics::Reset().

Referenced by SetBins(), and SetValidRange().

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

◆ SetBins()

void Isis::Histogram::SetBins ( const int bins )

Change the number of bins in the histogram and reset counters.

Definition at line 219 of file Histogram.cpp.

References p_bins, and Reset().

Referenced by Histogram(), Histogram(), and Histogram().

◆ SetValidRange()

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

Changes the range of the bins.

This function also sets the range of the parent statistics class and resets the stats/histogram counters. So binRange = setValidRange. Should only be called once, prior to Adding data to the histogram.

Parameters

binStart	The start of the bin range
binEnd	The end of the bin range

Definition at line 192 of file Histogram.cpp.

References Isis::IException::Programmer, and Reset().

Referenced by Histogram(), and rangesFromNet().

◆ Skew()

double Isis::Histogram::Skew ( ) const

Computes and returns the skew.

If there are no valid pixels then NULL8 is returned. Recognize that because of the binning which occurs, in order to generate the histogram, the skew may not be precise but will be very close.

Returns: The skew.

Definition at line 384 of file Histogram.cpp.

References Isis::Statistics::Average(), Median(), Isis::Statistics::StandardDeviation(), and Isis::Statistics::ValidPixels().

◆ 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

Definition at line 312 of file Statistics.cpp.

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

Referenced by Isis::Statistics::ChebyshevMaximum(), Isis::Statistics::ChebyshevMinimum(), Isis::MultivariateStatistics::Correlation(), Isis::ZeroBufferSmooth::init(), Isis::ZeroReverse::init(), Isis::VisualDisplay::paintPixmap(), Skew(), Isis::Gruen::StatsLog(), 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

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(), Percent(), 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_binRangeEnd

double Isis::Histogram::p_binRangeEnd

private

Definition at line 124 of file Histogram.h.

◆ p_binRangeStart

double Isis::Histogram::p_binRangeStart

private

Definition at line 124 of file Histogram.h.

◆ p_bins

std::vector<BigInt> Isis::Histogram::p_bins

protected

The array of counts.

Definition at line 121 of file Histogram.h.

Referenced by AddData(), Isis::ImageHistogram::AddData(), AddData(), Isis::ImageHistogram::AddData(), BinCount(), BinMiddle(), BinRange(), Isis::ImageHistogram::BinRange(), Bins(), MaxBinCount(), Mode(), Percent(), RemoveData(), Isis::ImageHistogram::RemoveData(), Reset(), and SetBins().

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

src/base/objs/Histogram/Histogram.h
src/base/objs/Histogram/Histogram.cpp

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Histogram() [1/3]

◆ Histogram() [2/3]

◆ Histogram() [3/3]

◆ ~Histogram()

Member Function Documentation

◆ AboveRange()

◆ AddData() [1/2]

◆ AddData() [2/2]

◆ addMeasureDataFromNet()

◆ Average()

◆ BelowRange()

◆ BestMaximum()

◆ BestMinimum()

◆ BinCount()

◆ BinMiddle()

◆ BinRange()

◆ BinRangeEnd()

◆ BinRangeStart()

◆ Bins()

◆ BinSize()

◆ ChebyshevMaximum()

◆ ChebyshevMinimum()

◆ fromPvl()

◆ HisPixels()

◆ HrsPixels()

◆ InRange()

◆ LisPixels()

◆ LrsPixels()

◆ MaxBinCount()

◆ Maximum()

◆ Median()

◆ Minimum()

◆ Mode()

◆ NullPixels()

◆ OutOfRangePixels()

◆ OverRangePixels()

◆ Percent()

◆ rangesFromNet()

◆ read()

◆ RemoveData() [1/2]

◆ RemoveData() [2/2]

◆ RemovedData()

◆ Reset()

◆ Rms()

◆ save()

◆ SetBins()

◆ SetValidRange()

◆ Skew()

◆ 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