Isis 3.0 Developer's Reference (API) |
Home |
Gaussian stretch class. More...
#include <GaussianStretch.h>
Inherits Isis::Statistics.
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 | 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. | |
double | Sum () const |
Returns the sum of all the data. | |
double | SumSquare () const |
Returns the sum of all the squared data. | |
Gaussian stretch class.
This class is used to stretch the input histogram to a gaussian distribution with the specified mean and standard deviation.
Isis::GaussianStretch::GaussianStretch | ( | Histogram & | histogram, |
const double | mean = 0.0 , |
||
const double | standardDeviation = 1.0 |
||
) |
Constructs a gaussian stretch object.
histogram | The input histogram |
mean | The mean of the output distribution |
standardDeviation | The standard deviation of the output distribution |
References Isis::Histogram::Bins(), Isis::GaussianDistribution::InverseCumulativeDistribution(), Isis::Statistics::Maximum(), Isis::Statistics::Minimum(), and Isis::Histogram::Percent().
|
inline |
|
inlineinherited |
Referenced by Isis::Statistics::AddData().
|
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.
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. |
Referenced by Isis::MultivariateStatistics::AddData(), Isis::CameraStatistics::addStats(), Isis::HiEqualization::HiCalculateFunctor::addStats(), Isis::Process::CalculateStatistics(), Isis::IndependentCubeViewport::cubeDataChanged(), Isis::ControlPoint::GetLineResidualRms(), Isis::ControlPoint::GetResidualRms(), Isis::ControlPoint::GetSampleResidualRms(), Isis::ControlPoint::GetStatistic(), Isis::StandardDeviationOperator::Interest(), Isis::ControlPointGraphicsItem::paint(), Isis::AutoReg::Reduce(), Isis::ReseauDistortionMap::SetFocalPlane(), Isis::VisualDisplay::setPixelData(), Isis::ReseauDistortionMap::SetUndistortedFocalPlane(), Isis::Chip::Statistics(), Isis::Cube::statistics(), and Isis::StretchTool::statsFromCube().
|
inlineinherited |
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.
data | The data to be added to the data set used for statistical calculations. |
References Isis::Statistics::AboveRange(), Isis::Statistics::InRange(), Isis::IsHisPixel(), Isis::IsHrsPixel(), Isis::IsLisPixel(), Isis::IsLrsPixel(), Isis::IsNullPixel(), and Isis::IsValidPixel().
|
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::MultivariateStatistics::Covariance(), Isis::ControlPointGraphicsItem::paint(), Isis::VisualDisplay::paintPixmap(), Isis::AutoReg::Reduce(), Isis::HistogramTool::refreshPlot(), and Isis::CameraStatistics::toPvl().
|
inlineinherited |
|
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::NULL8.
Referenced by Isis::IndependentCubeViewport::cubeDataChanged(), Isis::StretchTool::histFromBuffer(), Isis::VisualDisplay::setPixelData(), Isis::LinearStretchType::setStretch(), Isis::StretchTool::stretchBand(), and Isis::StretchTool::stretchBuffer().
|
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::NULL8.
Referenced by Isis::IndependentCubeViewport::cubeDataChanged(), Isis::StretchTool::histFromBuffer(), Isis::VisualDisplay::setPixelData(), Isis::LinearStretchType::setStretch(), Isis::StretchTool::stretchBand(), and Isis::StretchTool::stretchBuffer().
|
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_, and Isis::NULL8.
|
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_, and Isis::NULL8.
|
inherited |
Returns the total number of high instrument saturation (HIS) pixels encountered.
|
inherited |
Returns the total number of high representation saturation (HRS) pixels encountered.
|
inlineinherited |
Referenced by Isis::Statistics::AddData().
|
inherited |
Returns the total number of low instrument saturation (LIS) pixels encountered.
|
inherited |
Returns the total number of low representation saturation (LRS) pixels encountered.
double Isis::GaussianStretch::Map | ( | const double | value | ) | const |
Maps an input value to an output value based on the gaussian distribution.
value | Value to map |
|
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_, and Isis::NULL8.
Referenced by Isis::IndependentCubeViewport::cubeDataChanged(), Isis::QnetPointJigsawErrorFilter::filter(), Isis::QnetPointRegistrationErrorFilter::filter(), GaussianStretch(), Isis::ControlNet::GetMaximumResidual(), Isis::ControlPointGraphicsItem::paint(), Isis::VisualDisplay::paintPixmap(), Isis::HistogramTool::refreshPlot(), Isis::SawtoothStretchType::SawtoothStretchType(), Isis::ScatterPlotData::ScatterPlotData(), Isis::HistogramWidget::setHistogram(), Isis::BinaryStretchType::setStretch(), Isis::StretchTool::stretchBuffer(), and Isis::CameraStatistics::toPvl().
|
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_, and Isis::NULL8.
Referenced by Isis::IndependentCubeViewport::cubeDataChanged(), GaussianStretch(), Isis::VisualDisplay::paintPixmap(), Isis::HistogramTool::refreshPlot(), Isis::SawtoothStretchType::SawtoothStretchType(), Isis::ScatterPlotData::ScatterPlotData(), Isis::HistogramWidget::setHistogram(), Isis::BinaryStretchType::setStretch(), Isis::StretchTool::stretchBuffer(), and Isis::CameraStatistics::toPvl().
|
inherited |
Returns the total number of NULL pixels encountered.
|
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.
|
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.
data | The data to be removed from data set used for statistical calculations. |
count | The number of elements in the data to be removed. |
Isis::IException::Message | RemoveData is trying to remove data that doesn't exist. |
References _FILEINFO_, Isis::IsHisPixel(), Isis::IsHrsPixel(), Isis::IsLisPixel(), Isis::IsLrsPixel(), Isis::IsNullPixel(), and Isis::IsValidPixel().
Referenced by Isis::MultivariateStatistics::RemoveData().
|
inherited |
|
inherited |
Reset all accumulators and counters to zero.
Referenced by Isis::AutoReg::Reduce(), Isis::MultivariateStatistics::Reset(), Isis::VisualDisplay::setLines(), Isis::VisualDisplay::setPixelData(), and Isis::VisualDisplay::setSamples().
|
inherited |
Computes and returns the rms.
If there are no valid pixels, then NULL8 is returned.
References Isis::NULL8.
Referenced by Isis::ControlPoint::GetLineResidualRms(), Isis::ControlPoint::GetResidualRms(), and Isis::ControlPoint::GetSampleResidualRms().
|
inherited |
References _FILEINFO_.
Referenced by Isis::Cube::histogram(), Isis::StandardDeviationOperator::Interest(), Isis::Chip::Statistics(), and Isis::Cube::statistics().
|
inherited |
Computes and returns the standard deviation.
If there are no valid pixels, then NULL8 is returned.
References Isis::NULL8.
Referenced by Isis::MultivariateStatistics::Correlation(), Isis::StandardDeviationOperator::Interest(), Isis::VisualDisplay::paintPixmap(), Isis::HistogramTool::refreshPlot(), Isis::ReseauDistortionMap::SetFocalPlane(), Isis::ReseauDistortionMap::SetUndistortedFocalPlane(), and Isis::CameraStatistics::toPvl().
|
inlineinherited |
Returns the sum of all the data.
Referenced by Isis::MultivariateStatistics::Covariance(), and Isis::MultivariateStatistics::LinearRegression().
|
inlineinherited |
Returns the sum of all the squared data.
Referenced by Isis::MultivariateStatistics::LinearRegression().
|
inherited |
Returns the total number of pixels processed (valid and invalid).
Referenced by Isis::VisualDisplay::paintPixmap().
|
inherited |
Returns the total number of pixels under the valid range encountered.
|
inlineinherited |
|
inlineinherited |
|
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::IndependentCubeViewport::cubeDataChanged(), Isis::QHistogram::Load(), Isis::HistogramTool::refreshPlot(), Isis::StretchTool::stretchBuffer(), and Isis::StretchTool::updateHistograms().
|
inherited |
Computes and returns the variance.
If there are no valid pixels, then NULL8 is returned.
References Isis::NULL8.
Referenced by Isis::HistogramTool::refreshPlot().
|
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_.