Isis Developer Reference
|
Container of a cube histogram. More...
#include <ImageHistogram.h>
Public Member Functions | |
ImageHistogram (double minimum, double maximum, int bins=1024) | |
Constructs a histogram object. | |
ImageHistogram (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) | |
Constructs a histogram object using a cube. | |
~ImageHistogram () | |
Destructs a histogram object. | |
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. | |
virtual void | BinRange (const int index, double &low, double &high) const |
Returns the left edge and right edge values of a bin. | |
void | SetBins (const int bins) |
Change the number of bins in the histogram and reset counters. | |
void | Reset () |
Resets histogram counters to zero. | |
void | RemoveData (const double data) |
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. | |
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 | readStatistics (QXmlStreamReader *xmlReader) |
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. | |
Container of a cube histogram.
This class is used to accumulate an image 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 middle of the first bin [0] and the maximum is mapped to the middle 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.
Isis::ImageHistogram::ImageHistogram | ( | 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.
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 |
Isis::ImageHistogram::ImageHistogram | ( | 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 ) |
Constructs a histogram object using a cube.
This constructor computes the minimum, maximum for the binning range and number of bins automatically. All statistics will still be collected, though data at either end of the histogram will be put into one bin in order to attempt to achieve better histogram statistics.
TODO: progress needs to be a bool.
cube | The cube to used to determine min/max and bins |
statsBand | The band number the histogram will be collected from |
progress | The Progress object to be used to output the percent processed information |
startSample | The sample to start reading cube data from |
startLine | The line to start reading cube data from |
endSample | The sample to stop reading cube data at (Null for nsamps) |
endLine | The line to stop reading cube data at (Null for nlines) |
bins | The number of histogram bins to create (0 for automatic) |
addCubeData | True to fill the histogram with data in addition to initializing the binning ranges. |
References AddData(), Isis::Cube::bandCount(), Isis::Progress::CheckStatus(), Isis::Cube::pixelType(), Isis::Cube::read(), Isis::Progress::SetMaximumSteps(), and Isis::Progress::SetText().
Isis::ImageHistogram::~ImageHistogram | ( | ) |
Destructs a histogram object.
|
inherited |
Referenced by Isis::Statistics::AddData(), Isis::Statistics::InRange(), and Isis::Statistics::RemoveData().
|
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.
data | Pointer to array of double to add. |
count | Number of doubles to process. |
Reimplemented from Isis::Histogram.
References Isis::Statistics::AddData(), Isis::Histogram::BinRangeEnd(), Isis::Histogram::BinRangeStart(), Isis::Statistics::InRange(), Isis::IsValidPixel(), and Isis::Histogram::p_bins.
Referenced by ImageHistogram().
|
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.
data | a single observation to be added to the histogram |
Reimplemented from Isis::Histogram.
References Isis::Statistics::AddData(), Isis::Histogram::BinRangeEnd(), Isis::Histogram::BinRangeStart(), Isis::Statistics::InRange(), Isis::IsValidPixel(), and Isis::Histogram::p_bins.
|
inherited |
Computes and returns the average.
If there are no valid pixels, then NULL8 is returned.
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().
|
inherited |
Referenced by Isis::Statistics::AddData(), Isis::Statistics::InRange(), and Isis::Statistics::RemoveData().
|
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.
percent | The probability that the maximum is within K standard deviations of the mean (Used to compute the Chebyshev maximum). Default value = 99.5. |
References Isis::Statistics::ChebyshevMaximum(), Isis::Statistics::Maximum(), Isis::Statistics::Minimum(), and Isis::NULL8.
Referenced by Isis::VisualDisplay::setPixelData(), and Isis::LinearStretchType::setStretch().
|
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.
percent | The probability that the minimum is within K standard deviations of the mean (Used to compute the Chebyshev minimum). Default value = 99.5. |
References Isis::Statistics::ChebyshevMinimum(), Isis::Statistics::Maximum(), Isis::Statistics::Minimum(), and Isis::NULL8.
Referenced by Isis::VisualDisplay::setPixelData(), and Isis::LinearStretchType::setStretch().
|
inherited |
Returns the count at a bin position in the histogram.
index | Index of the desired bin 0 to Bins()-1. |
References _FILEINFO_, Isis::Message::ArraySubscriptNotInRange(), Isis::Histogram::p_bins, and Isis::IException::Programmer.
|
inherited |
Returns the value represented by a bin.
This is not the count, but the actual data value at the middle of the bin.
index | Index of the desired bin 0 to Bins()-1. |
References _FILEINFO_, Isis::Message::ArraySubscriptNotInRange(), Isis::Histogram::BinRange(), Isis::Histogram::p_bins, and Isis::IException::Programmer.
Referenced by Isis::Histogram::Mode(), and Isis::Histogram::Percent().
|
virtual |
Returns the left edge and right edge values of a bin.
That is the range of data the bin covers.
iException | The programmer has passed in an index outside of 0 to Bins()-1. |
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 from Isis::Histogram.
References _FILEINFO_, Isis::Message::ArraySubscriptNotInRange(), Isis::Histogram::BinRangeEnd(), Isis::Histogram::BinRangeStart(), Isis::Histogram::p_bins, and Isis::IException::Programmer.
|
inlineinherited |
|
inlineinherited |
|
inherited |
Returns the number of bins in the histogram.
References Isis::Histogram::p_bins.
Referenced by Isis::GaussianStretch::GaussianStretch().
|
inherited |
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.
References Isis::Histogram::BinRange().
Referenced by Isis::BinaryStretchType::setStretch(), Isis::LinearStretchType::setStretch(), and Isis::SawtoothStretchType::setStretch().
|
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.
percent | The probability that the maximum is within K standard deviations of the mean. Default value = 99.5. |
Isis::IException::Message |
References _FILEINFO_, Isis::Statistics::Average(), Isis::NULL8, Isis::IException::Programmer, and Isis::Statistics::StandardDeviation().
Referenced by Isis::Statistics::BestMaximum().
|
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.
percent | The probability that the minimum is within K standard deviations of the mean. Default value = 99.5. |
Isis::IException::Message |
References _FILEINFO_, Isis::Statistics::Average(), Isis::NULL8, Isis::IException::Programmer, and Isis::Statistics::StandardDeviation().
Referenced by Isis::Statistics::BestMinimum().
|
inherited |
Returns the total number of high instrument saturation (HIS) pixels encountered.
Referenced by Isis::Statistics::toPvl().
|
inherited |
Returns the total number of high representation saturation (HRS) pixels encountered.
Referenced by Isis::Statistics::toPvl().
|
inherited |
References Isis::Statistics::AboveRange(), and Isis::Statistics::BelowRange().
Referenced by Isis::Histogram::AddData(), AddData(), Isis::Histogram::AddData(), and AddData().
|
inherited |
Returns the total number of low instrument saturation (LIS) pixels encountered.
Referenced by Isis::Statistics::toPvl().
|
inherited |
Returns the total number of low representation saturation (LRS) pixels encountered.
Referenced by Isis::Statistics::toPvl().
|
inherited |
|
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.
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(), Isis::GaussianStretch::GaussianStretch(), Isis::ControlNetStatistics::GenerateControlNetStats(), Isis::VisualDisplay::paintPixmap(), Isis::SawtoothStretchType::SawtoothStretchType(), Isis::BinaryStretchType::setStretch(), Isis::CameraStatistics::toPvl(), Isis::Statistics::toPvl(), and Isis::Statistics::ZScore().
|
inherited |
Returns the median.
References Isis::Histogram::Percent().
Referenced by Isis::SawtoothStretchType::SawtoothStretchType(), Isis::ProcessExport::SetInputRange(), and Isis::Histogram::Skew().
|
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.
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(), Isis::GaussianStretch::GaussianStretch(), Isis::ControlNetStatistics::GenerateControlNetStats(), Isis::VisualDisplay::paintPixmap(), Isis::SawtoothStretchType::SawtoothStretchType(), Isis::BinaryStretchType::setStretch(), Isis::CameraStatistics::toPvl(), and Isis::Statistics::toPvl().
|
inherited |
Returns the mode.
References Isis::Histogram::BinMiddle(), Isis::NULL8, and Isis::Histogram::p_bins.
|
inherited |
Returns the total number of NULL pixels encountered.
Referenced by Isis::Statistics::toPvl().
|
inherited |
Returns the total number of pixels outside of the valid range encountered.
|
inherited |
Returns the total number of pixels over the valid range encountered.
Referenced by Isis::Statistics::toPvl().
|
inherited |
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.
percent | X percent of the histogram to compute. |
References _FILEINFO_, Isis::Histogram::BinMiddle(), Isis::NULL8, Isis::Histogram::p_bins, Isis::IException::Programmer, and Isis::Statistics::ValidPixels().
Referenced by Isis::BinaryStretchType::BinaryStretchType(), Isis::GaussianStretch::GaussianStretch(), and Isis::Histogram::Median().
|
inherited |
Referenced by Isis::operator>>().
|
inherited |
References Isis::toBigInt(), Isis::toBool(), Isis::toDouble(), Isis::ValidMaximum, and Isis::ValidMinimum.
Referenced by Isis::Statistics::Statistics().
|
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.
data | Pointer to array of doubles to remove. |
count | number of doubles to process. |
Reimplemented from Isis::Histogram.
References Isis::Histogram::BinRangeEnd(), Isis::Histogram::BinRangeStart(), Isis::IsValidPixel(), Isis::Histogram::p_bins, and Isis::Statistics::RemoveData().
|
inherited |
|
inherited |
|
inherited |
Resets histogram counters to zero.
References Isis::Histogram::p_bins, and Isis::Statistics::Reset().
Referenced by Isis::Histogram::SetBins(), and Isis::Histogram::SetValidRange().
|
inherited |
Computes and returns the rms.
If there are no valid pixels, then NULL8 is returned.
References Isis::NULL8.
|
inherited |
References Isis::toString().
|
inherited |
Change the number of bins in the histogram and reset counters.
References Isis::Histogram::p_bins, and Isis::Histogram::Reset().
Referenced by Isis::Histogram::Histogram(), Isis::Histogram::Histogram(), and Isis::Histogram::Histogram().
|
inherited |
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.
binStart | The start of the bin range |
binEnd | The end of the bin range |
References _FILEINFO_, Isis::IException::Programmer, Isis::Histogram::Reset(), and Isis::Statistics::SetValidRange().
Referenced by Isis::Histogram::Histogram().
|
inherited |
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.
References Isis::Statistics::Average(), Isis::Histogram::Median(), Isis::NULL8, Isis::Statistics::StandardDeviation(), and Isis::Statistics::ValidPixels().
|
inherited |
Computes and returns the standard deviation.
If there are no valid pixels, then NULL8 is returned.
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().
|
inherited |
Returns the sum of all the data.
Referenced by Isis::MultivariateStatistics::Covariance(), Isis::MultivariateStatistics::LinearRegression(), and Isis::Statistics::toPvl().
|
inherited |
Returns the sum of all the squared data.
Referenced by Isis::MultivariateStatistics::LinearRegression(), and Isis::Statistics::toPvl().
|
inherited |
Serialize statistics as a pvl group.
QString | name (Default value is "Statistics") - Name of the statistics group |
References Isis::Statistics::Average(), Isis::Statistics::HisPixels(), Isis::Statistics::HrsPixels(), Isis::Statistics::LisPixels(), Isis::Statistics::LrsPixels(), Isis::Statistics::Maximum(), Isis::Statistics::Minimum(), Isis::Statistics::NullPixels(), Isis::Statistics::OverRangePixels(), Isis::Statistics::StandardDeviation(), Isis::Statistics::Sum(), Isis::Statistics::SumSquare(), Isis::toString(), Isis::Statistics::TotalPixels(), Isis::Statistics::UnderRangePixels(), Isis::Statistics::ValidMaximum(), Isis::Statistics::ValidMinimum(), Isis::Statistics::ValidPixels(), and Isis::Statistics::Variance().
Referenced by Isis::MultivariateStatistics::toPvl().
|
inherited |
Returns the total number of pixels processed (valid and invalid).
Referenced by Isis::VisualDisplay::paintPixmap(), and Isis::Statistics::toPvl().
|
inherited |
Returns the total number of pixels under the valid range encountered.
Referenced by Isis::Statistics::toPvl().
|
inherited |
Referenced by Isis::Histogram::Histogram(), and Isis::Statistics::toPvl().
|
inherited |
Referenced by Isis::Histogram::Histogram(), and Isis::Statistics::toPvl().
|
inherited |
Returns the total number of valid pixels processed.
Only valid pixels are utilized when computing the average, standard deviation, variance, minimum and maximum.
Referenced by Isis::OverlapNormalization::AddOverlap(), Isis::Histogram::Percent(), Isis::Histogram::Skew(), and Isis::Statistics::toPvl().
|
inherited |
Computes and returns the variance.
If there are no valid pixels, then NULL8 is returned.
References Isis::NULL8.
Referenced by Isis::Statistics::StandardDeviation(), and Isis::Statistics::toPvl().
|
inherited |
Order saved must match the offsets in the static compoundH5DataType() method.
Referenced by Isis::operator<<().
|
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.
value | The value to calculate the z-score of. |
References _FILEINFO_, Isis::Statistics::Average(), Isis::Statistics::Maximum(), Isis::IException::Programmer, Isis::Statistics::StandardDeviation(), and Isis::toString().
|
protectedinherited |
The array of counts.
Referenced by Isis::Histogram::AddData(), AddData(), Isis::Histogram::AddData(), AddData(), Isis::Histogram::BinCount(), Isis::Histogram::BinMiddle(), Isis::Histogram::BinRange(), BinRange(), Isis::Histogram::Bins(), Isis::Histogram::MaxBinCount(), Isis::Histogram::Mode(), Isis::Histogram::Percent(), Isis::Histogram::RemoveData(), RemoveData(), Isis::Histogram::Reset(), and Isis::Histogram::SetBins().