Isis 3.0 Object Programmers' Reference |
Home |
Gaussian stretch class. More...
#include <GaussianStretch.h>
Public Member Functions | |
GaussianStretch (Histogram &histogram, const double mean=0.0, const double standardDeviation=1.0) | |
Constructs a gaussian stretch object. | |
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. | |
Private Attributes | |
Stretch | p_stretch |
Value of the mean. | |
Gaussian stretch class.
This class is used to stretch the input histogram to a gaussian distribution with the specified mean and standard deviation.
2006-05-25 Jacob Danton Original Version
2006-10-28 Stuart Sides Fixed stretch pair ordering
2008-09-09 Steven Lambright Fixed stretch pair ordering again; this fix does not solve our problem but makes our tests work and isn't wrong.
Definition at line 51 of file GaussianStretch.h.
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 |
Definition at line 41 of file GaussianStretch.cpp.
References Isis::Histogram::Bins(), Isis::GaussianDistribution::InverseCumulativeDistribution(), Isis::Statistics::Maximum(), Isis::Statistics::Minimum(), and Isis::Histogram::Percent().
|
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. |
Definition at line 66 of file Statistics.cpp.
Referenced by Isis::MultivariateStatistics::AddData(), Isis::CameraStatistics::addStats(), Isis::Process::CalculateStatistics(), Isis::Gruen::CheckConstraints(), Isis::BundleAdjust::ComputeBundleStatistics(), Isis::AutoReg::ComputeChipZScore(), Isis::ChipViewport::computeStretch(), Isis::ControlPoint::GetLineResidualRms(), Isis::ControlNetStatistics::GetPointDoubleStats(), Isis::ControlPoint::GetResidualRms(), Isis::ControlPoint::GetSampleResidualRms(), Isis::SpatialPlotTool::getSpatialStatistics(), Isis::SpectralPlotTool::getSpectralStatistics(), Isis::ControlPoint::GetStatistic(), Isis::StatisticsTool::getStatistics(), Isis::MosaicSceneItem::getStretch(), Isis::StandardDeviationOperator::Interest(), 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. |
Definition at line 94 of file Statistics.h.
References Isis::IsHisPixel(), Isis::IsHrsPixel(), Isis::IsLisPixel(), Isis::IsLrsPixel(), Isis::IsNullPixel(), Isis::IsValidPixel(), Isis::Statistics::p_hisPixels, Isis::Statistics::p_hrsPixels, Isis::Statistics::p_lisPixels, Isis::Statistics::p_lrsPixels, Isis::Statistics::p_maximum, Isis::Statistics::p_minimum, Isis::Statistics::p_nullPixels, Isis::Statistics::p_overRangePixels, Isis::Statistics::p_sum, Isis::Statistics::p_sumsum, Isis::Statistics::p_totalPixels, Isis::Statistics::p_underRangePixels, and Isis::Statistics::p_validPixels.
|
inherited |
Computes and returns the average.
If there are no valid pixels, then NULL8 is returned.
Definition at line 150 of file Statistics.cpp.
Referenced by Isis::OverlapNormalization::AddOverlap(), Isis::ControlNet::AverageResidual(), Isis::MultivariateStatistics::Covariance(), Isis::ControlNetStatistics::GetPointDoubleStats(), Isis::SpatialPlotTool::getSpatialStatistics(), Isis::SpectralPlotTool::getSpectralStatistics(), Isis::StatisticsTool::getStatistics(), Isis::VisualDisplay::paintPixmap(), Isis::AutoReg::Reduce(), Isis::HistogramTool::refreshPlot(), Isis::OverlapNormalization::Solve(), Isis::Gruen::StatsLog(), and Isis::CameraStatistics::toPvl().
|
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. |
Definition at line 427 of file Statistics.cpp.
Referenced by Isis::ChipViewport::computeStretch(), Isis::MosaicSceneItem::getStretch(), 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. |
Definition at line 405 of file Statistics.cpp.
Referenced by Isis::ChipViewport::computeStretch(), Isis::MosaicSceneItem::getStretch(), 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 |
Definition at line 380 of file Statistics.cpp.
References _FILEINFO_.
|
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 |
Definition at line 354 of file Statistics.cpp.
References _FILEINFO_.
|
inherited |
Returns the total number of high instrument saturation (HIS) pixels encountered.
Definition at line 315 of file Statistics.cpp.
|
inherited |
Returns the total number of high representation saturation (HRS) pixels encountered.
Definition at line 325 of file Statistics.cpp.
|
inherited |
Returns the total number of low instrument saturation (LIS) pixels encountered.
Definition at line 295 of file Statistics.cpp.
|
inherited |
Returns the total number of low representation saturation (LRS) pixels encountered.
Definition at line 305 of file Statistics.cpp.
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 |
Definition at line 73 of file GaussianStretch.cpp.
|
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. |
Definition at line 228 of file Statistics.cpp.
References _FILEINFO_.
Referenced by Isis::BinaryStretchType::calculateNewStretch(), Isis::SawtoothStretchType::calculateNewStretch(), Isis::AutoReg::ComputeChipZScore(), Isis::BinaryStretchType::endEditChanged(), Isis::LinearStretchType::endEditChanged(), Isis::BinaryStretchType::endSliderMoved(), Isis::LinearStretchType::endSliderMoved(), Isis::QnetPointJigsawErrorFilter::filter(), Isis::QnetPointRegistrationErrorFilter::filter(), GaussianStretch(), Isis::ControlNet::GetMaximumResidual(), Isis::ControlNetStatistics::GetPointDoubleStats(), Isis::StatisticsTool::getStatistics(), Isis::SawtoothStretchType::offsetEditChanged(), Isis::SawtoothStretchType::offsetSliderMoved(), Isis::VisualDisplay::paintPixmap(), Isis::HistogramTool::refreshPlot(), Isis::SawtoothStretchType::SawtoothStretchType(), Isis::ScatterPlotData::ScatterPlotData(), Isis::HistogramWidget::setHistogram(), Isis::BinaryStretchType::setStretch(), Isis::BinaryStretchType::startEditChanged(), Isis::LinearStretchType::startEditChanged(), Isis::BinaryStretchType::startSliderMoved(), Isis::LinearStretchType::startSliderMoved(), Isis::Gruen::StatsLog(), Isis::StretchTool::stretchBuffer(), Isis::CameraStatistics::toPvl(), Isis::SawtoothStretchType::widthEditChanged(), and Isis::SawtoothStretchType::widthSliderMoved().
|
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. |
Definition at line 208 of file Statistics.cpp.
References _FILEINFO_.
Referenced by Isis::BinaryStretchType::calculateNewStretch(), Isis::SawtoothStretchType::calculateNewStretch(), Isis::AutoReg::ComputeChipZScore(), Isis::BinaryStretchType::endEditChanged(), Isis::LinearStretchType::endEditChanged(), Isis::BinaryStretchType::endSliderMoved(), Isis::LinearStretchType::endSliderMoved(), GaussianStretch(), Isis::ControlNetStatistics::GetPointDoubleStats(), Isis::StatisticsTool::getStatistics(), Isis::SawtoothStretchType::offsetEditChanged(), Isis::SawtoothStretchType::offsetSliderMoved(), Isis::VisualDisplay::paintPixmap(), Isis::HistogramTool::refreshPlot(), Isis::SawtoothStretchType::SawtoothStretchType(), Isis::ScatterPlotData::ScatterPlotData(), Isis::HistogramWidget::setHistogram(), Isis::BinaryStretchType::setStretch(), Isis::BinaryStretchType::startEditChanged(), Isis::LinearStretchType::startEditChanged(), Isis::BinaryStretchType::startSliderMoved(), Isis::LinearStretchType::startSliderMoved(), Isis::Gruen::StatsLog(), Isis::StretchTool::stretchBuffer(), Isis::CameraStatistics::toPvl(), Isis::SawtoothStretchType::widthEditChanged(), and Isis::SawtoothStretchType::widthSliderMoved().
|
inherited |
Returns the total number of NULL pixels encountered.
Definition at line 285 of file Statistics.cpp.
|
inherited |
Returns the total number of pixels outside of the valid range encountered.
Definition at line 335 of file Statistics.cpp.
|
inherited |
Returns the total number of pixels over the valid range encountered.
Definition at line 266 of file Statistics.cpp.
|
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. |
Definition at line 88 of file Statistics.cpp.
References _FILEINFO_, Isis::IsHisPixel(), Isis::IsHrsPixel(), Isis::IsLisPixel(), Isis::IsLrsPixel(), Isis::IsNullPixel(), and Isis::IsValidPixel().
Referenced by Isis::MultivariateStatistics::RemoveData().
|
inherited |
Reset all accumulators and counters to zero.
Definition at line 36 of file Statistics.cpp.
Referenced by Isis::AutoReg::Reduce(), Isis::MultivariateStatistics::Reset(), Isis::Gruen::resetStats(), 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.
Definition at line 192 of file Statistics.cpp.
Referenced by Isis::BundleAdjust::ComputeBundleStatistics(), Isis::ControlPoint::GetLineResidualRms(), Isis::ControlPoint::GetResidualRms(), and Isis::ControlPoint::GetSampleResidualRms().
|
inherited |
Computes and returns the standard deviation.
If there are no valid pixels, then NULL8 is returned.
Definition at line 161 of file Statistics.cpp.
Referenced by Isis::MultivariateStatistics::Correlation(), Isis::StatisticsTool::getStatistics(), Isis::StandardDeviationOperator::Interest(), Isis::VisualDisplay::paintPixmap(), Isis::HistogramTool::refreshPlot(), Isis::ReseauDistortionMap::SetFocalPlane(), Isis::ReseauDistortionMap::SetUndistortedFocalPlane(), Isis::OverlapNormalization::Solve(), Isis::Gruen::StatsLog(), and Isis::CameraStatistics::toPvl().
|
inlineinherited |
Returns the sum of all the data.
Definition at line 176 of file Statistics.h.
References Isis::Statistics::p_sum.
Referenced by Isis::MultivariateStatistics::Covariance(), and Isis::MultivariateStatistics::LinearRegression().
|
inlineinherited |
Returns the sum of all the squared data.
Definition at line 185 of file Statistics.h.
References Isis::Statistics::p_sumsum.
Referenced by Isis::MultivariateStatistics::LinearRegression().
|
inherited |
Returns the total number of pixels processed (valid and invalid).
Definition at line 244 of file Statistics.cpp.
Referenced by Isis::VisualDisplay::paintPixmap().
|
inherited |
Returns the total number of pixels under the valid range encountered.
Definition at line 276 of file Statistics.cpp.
|
inherited |
Returns the total number of valid pixels processed.
Only valid pixels are utilized when computing the average, standard deviation, variance, minimum and maximum.
Definition at line 256 of file Statistics.cpp.
Referenced by Isis::OverlapNormalization::AddOverlap(), Isis::ControlNetStatistics::GetPointDoubleStats(), Isis::StatisticsTool::getStatistics(), 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.
Definition at line 176 of file Statistics.cpp.
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. |
Definition at line 446 of file Statistics.cpp.
References _FILEINFO_.
Referenced by Isis::AutoReg::ComputeChipZScore().
|
private |
Value of the mean.
Definition at line 59 of file GaussianStretch.h.