|
Isis 3.0 Object Programmers' Reference |
Home |
#include <GaussianStretch.h>
Inheritance diagram for Isis::GaussianStretch:
This class is used to stretch the input histogram to a gaussian distribution with the specified mean and standard deviation.
For internal use only.
Definition at line 51 of file GaussianStretch.h.
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 | 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. | |
| 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::Stretch::AddPair(), Isis::Histogram::Bins(), Isis::Stretch::ClearPairs(), Isis::Statistics::Maximum(), Isis::Statistics::Minimum(), p_stretch, and Isis::Histogram::Percent().
| void Isis::Statistics::AddData | ( | const double | data | ) | [inline, inherited] |
Add a double to the accumulators and counters.
This method can be invoked multiple times (for example: once for each pixel in a cube) before obtaining statistics.
| data | The data to be added to the data set used for statistical calculations. |
Definition at line 92 of file Statistics.h.
References Isis::Statistics::AboveRange(), Isis::Statistics::InRange(), 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.
| void Isis::Statistics::AddData | ( | const double * | data, | |
| const unsigned int | count | |||
| ) | [inherited] |
Add an array of doubles to the accumulators and counters.
This method can be invoked multiple times (for example: once for each line in a cube) before obtaining statistics.
| 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. |
Reimplemented in Isis::Histogram.
Definition at line 66 of file Statistics.cpp.
References value.
Referenced by Isis::MultivariateStatistics::AddData(), Isis::Histogram::AddData(), Isis::BundleAdjust::AddPartials(), Qisis::PlotTool::changePlot(), Isis::AutoReg::ComputeChipZScore(), Isis::Histogram::InitializeFromCube(), Isis::StandardDeviationOperator::Interest(), Isis::AutoReg::Reduce(), Isis::ReseauDistortionMap::SetFocalPlane(), Qisis::VisualDisplay::setPixelData(), Isis::ReseauDistortionMap::SetUndistortedFocalPlane(), Isis::Cube::Statistics(), Isis::Chip::Statistics(), and Isis::Gruen::TestConstraints().
| double Isis::Statistics::Average | ( | ) | const [inherited] |
Computes and returns the average.
If there are no valid pixels, then NULL8 is returned.
Definition at line 140 of file Statistics.cpp.
References Isis::NULL8, Isis::Statistics::p_sum, and Isis::Statistics::p_validPixels.
Referenced by Isis::OverlapNormalization::AddOverlap(), Qisis::HistogramTool::changePlot(), Isis::Statistics::ChebyshevMaximum(), Isis::Statistics::ChebyshevMinimum(), Isis::MultivariateStatistics::Covariance(), Isis::operator<<(), Qisis::VisualDisplay::paintPixmap(), Isis::AutoReg::Reduce(), Isis::Histogram::Skew(), Isis::Gruen::StatsLog(), and Isis::Statistics::ZScore().
| 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.
| 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 401 of file Statistics.cpp.
References Isis::Statistics::ChebyshevMaximum(), Isis::Statistics::Maximum(), Isis::NULL8, and Isis::Statistics::p_validPixels.
Referenced by Qisis::MosaicItem::getStretch(), Isis::Histogram::InitializeFromCube(), Qisis::VisualDisplay::setPixelData(), Qisis::StretchTool::stretchBuffer(), and Qisis::StretchTool::stretchEntireCube().
| 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.
| 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 379 of file Statistics.cpp.
References Isis::Statistics::ChebyshevMinimum(), Isis::Statistics::Minimum(), Isis::NULL8, and Isis::Statistics::p_validPixels.
Referenced by Qisis::MosaicItem::getStretch(), Isis::Histogram::InitializeFromCube(), Qisis::VisualDisplay::setPixelData(), Qisis::StretchTool::stretchBuffer(), and Qisis::StretchTool::stretchEntireCube().
| 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.
| percent | The probability that the maximum 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_, Isis::Statistics::Average(), Isis::iException::Message(), Isis::NULL8, Isis::Statistics::p_validPixels, and Isis::Statistics::StandardDeviation().
Referenced by Isis::Statistics::BestMaximum().
| double Isis::Statistics::ChebyshevMinimum | ( | const double | percent = 99.5 |
) | const [inherited] |
This method returns a minimum such that X percent of the data will fall with K standard deviations of the average (Chebyshev's Theorem).
It can be used to obtain a minimum that does not include statistical outliers.
| percent | The probability that the minimum is within K standard deviations of the mean. Default value = 99.5. |
| Isis::iException::Message |
Definition at line 328 of file Statistics.cpp.
References _FILEINFO_, Isis::Statistics::Average(), Isis::iException::Message(), Isis::NULL8, Isis::Statistics::p_validPixels, and Isis::Statistics::StandardDeviation().
Referenced by Isis::Statistics::BestMinimum().
| BigInt Isis::Statistics::HisPixels | ( | ) | const [inherited] |
Returns the total number of high instrument saturation (HIS) pixels encountered.
Definition at line 289 of file Statistics.cpp.
References Isis::Statistics::p_hisPixels.
| BigInt Isis::Statistics::HrsPixels | ( | ) | const [inherited] |
Returns the total number of high representation saturation (HRS) pixels encountered.
Definition at line 299 of file Statistics.cpp.
References Isis::Statistics::p_hrsPixels.
| BigInt Isis::Statistics::LisPixels | ( | ) | const [inherited] |
Returns the total number of low instrument saturation (LIS) pixels encountered.
Definition at line 269 of file Statistics.cpp.
References Isis::Statistics::p_lisPixels.
| BigInt Isis::Statistics::LrsPixels | ( | ) | const [inherited] |
Returns the total number of low representation saturation (LRS) pixels encountered.
Definition at line 279 of file Statistics.cpp.
References Isis::Statistics::p_lrsPixels.
| 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.
References Isis::Stretch::Map(), and p_stretch.
| 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.
| Isis::iException::Message | The data set is blank, so the maximum is invalid. |
Definition at line 202 of file Statistics.cpp.
References _FILEINFO_, Isis::iException::Message(), Isis::NULL8, Isis::Statistics::p_maximum, Isis::Statistics::p_removedData, and Isis::Statistics::p_validPixels.
Referenced by Isis::Statistics::BestMaximum(), Qisis::PlotTool::changePlot(), Qisis::HistogramTool::changePlot(), Isis::AutoReg::ComputeChipZScore(), GaussianStretch(), Qisis::VisualDisplay::paintPixmap(), Qisis::HistogramWidget::setHistogram(), Qisis::StretchTool::setStretch(), Isis::Gruen::StatsLog(), Qisis::StretchTool::stretchBuffer(), Qisis::StretchTool::stretchEntireCube(), Qisis::StretchTool::updateTool(), and Isis::Statistics::ZScore().
| 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.
| Isis::iException::Message | The data set is blank, so the minimum is invalid. |
Definition at line 182 of file Statistics.cpp.
References _FILEINFO_, Isis::iException::Message(), Isis::NULL8, Isis::Statistics::p_minimum, Isis::Statistics::p_removedData, and Isis::Statistics::p_validPixels.
Referenced by Isis::Statistics::BestMinimum(), Qisis::PlotTool::changePlot(), Qisis::HistogramTool::changePlot(), Isis::AutoReg::ComputeChipZScore(), GaussianStretch(), Qisis::VisualDisplay::paintPixmap(), Qisis::HistogramWidget::setHistogram(), Qisis::StretchTool::setStretch(), Isis::Gruen::StatsLog(), Qisis::StretchTool::stretchBuffer(), Qisis::StretchTool::stretchEntireCube(), and Qisis::StretchTool::updateTool().
| BigInt Isis::Statistics::NullPixels | ( | ) | const [inherited] |
Returns the total number of NULL pixels encountered.
Definition at line 259 of file Statistics.cpp.
References Isis::Statistics::p_nullPixels.
| BigInt Isis::Statistics::OutOfRangePixels | ( | ) | const [inherited] |
Returns the total number of pixels outside of the valid range encountered.
Definition at line 309 of file Statistics.cpp.
References Isis::Statistics::p_overRangePixels, and Isis::Statistics::p_underRangePixels.
| BigInt Isis::Statistics::OverRangePixels | ( | ) | const [inherited] |
Returns the total number of pixels over the valid range encountered.
Definition at line 240 of file Statistics.cpp.
References Isis::Statistics::p_overRangePixels.
| void Isis::Statistics::RemoveData | ( | const double * | data, | |
| const unsigned int | count | |||
| ) | [inherited] |
Remove an array of doubles from the accumulators and counters.
Note that is invalidates the absolute minimum and maximum. They will no longer be usable.
| 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. |
Reimplemented in Isis::Histogram.
Definition at line 88 of file Statistics.cpp.
References _FILEINFO_, Isis::Statistics::AboveRange(), Isis::Statistics::InRange(), Isis::IsHisPixel(), Isis::IsHrsPixel(), Isis::IsLisPixel(), Isis::IsLrsPixel(), Isis::IsNullPixel(), Isis::IsValidPixel(), Isis::iException::Message(), Isis::Statistics::p_hisPixels, Isis::Statistics::p_hrsPixels, Isis::Statistics::p_lisPixels, Isis::Statistics::p_lrsPixels, Isis::Statistics::p_nullPixels, Isis::Statistics::p_overRangePixels, Isis::Statistics::p_removedData, Isis::Statistics::p_sum, Isis::Statistics::p_sumsum, Isis::Statistics::p_totalPixels, Isis::Statistics::p_underRangePixels, and Isis::Statistics::p_validPixels.
Referenced by Isis::Statistics::RemoveData(), Isis::MultivariateStatistics::RemoveData(), and Isis::Histogram::RemoveData().
| void Isis::Statistics::Reset | ( | ) | [inherited] |
Reset all accumulators and counters to zero.
Reimplemented in Isis::Histogram.
Definition at line 36 of file Statistics.cpp.
References 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_removedData, Isis::Statistics::p_sum, Isis::Statistics::p_sumsum, Isis::Statistics::p_totalPixels, Isis::Statistics::p_underRangePixels, and Isis::Statistics::p_validPixels.
Referenced by Isis::AutoReg::Reduce(), Isis::MultivariateStatistics::Reset(), Isis::Histogram::Reset(), Isis::Gruen::resetStats(), Qisis::VisualDisplay::setLines(), Qisis::VisualDisplay::setPixelData(), Qisis::VisualDisplay::setSamples(), Isis::BundleAdjust::Solve(), and Isis::Statistics::Statistics().
| double Isis::Statistics::StandardDeviation | ( | ) | const [inherited] |
Computes and returns the standard deviation.
If there are no valid pixels, then NULL8 is returned.
Reimplemented in Isis::GaussianDistribution.
Definition at line 151 of file Statistics.cpp.
References Isis::NULL8, Isis::Statistics::p_validPixels, and Isis::Statistics::Variance().
Referenced by Qisis::HistogramTool::changePlot(), Isis::Statistics::ChebyshevMaximum(), Isis::Statistics::ChebyshevMinimum(), Isis::MultivariateStatistics::Correlation(), Isis::StandardDeviationOperator::Interest(), Isis::operator<<(), Qisis::VisualDisplay::paintPixmap(), Isis::ReseauDistortionMap::SetFocalPlane(), Isis::ReseauDistortionMap::SetUndistortedFocalPlane(), Isis::Histogram::Skew(), Isis::Gruen::StatsLog(), and Isis::Statistics::ZScore().
| double Isis::Statistics::Sum | ( | ) | const [inline, inherited] |
Returns the sum of all the data.
Definition at line 156 of file Statistics.h.
References Isis::Statistics::p_sum.
Referenced by Isis::MultivariateStatistics::Covariance(), and Isis::MultivariateStatistics::LinearRegression().
| double Isis::Statistics::SumSquare | ( | ) | const [inline, inherited] |
Returns the sum of all the squared data.
Definition at line 163 of file Statistics.h.
References Isis::Statistics::p_sumsum.
Referenced by Isis::MultivariateStatistics::LinearRegression(), and Isis::BundleAdjust::Solve().
| BigInt Isis::Statistics::TotalPixels | ( | ) | const [inherited] |
Returns the total number of pixels processed (valid and invalid).
Definition at line 218 of file Statistics.cpp.
References Isis::Statistics::p_totalPixels.
Referenced by Isis::operator<<(), Qisis::VisualDisplay::paintPixmap(), and Isis::BundleAdjust::Solve().
| BigInt Isis::Statistics::UnderRangePixels | ( | ) | const [inherited] |
Returns the total number of pixels under the valid range encountered.
Definition at line 250 of file Statistics.cpp.
References Isis::Statistics::p_underRangePixels.
| 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.
Definition at line 230 of file Statistics.cpp.
References Isis::Statistics::p_validPixels.
Referenced by Isis::OverlapNormalization::AddOverlap(), Qisis::HistogramTool::changePlot(), Qisis::StretchTool::getHistogramPercent(), Isis::Histogram::InitializeFromCube(), Qisis::QHistogram::Load(), Isis::operator<<(), Isis::Histogram::Percent(), and Isis::Histogram::Skew().
| double Isis::Statistics::Variance | ( | ) | const [inherited] |
Computes and returns the variance.
If there are no valid pixels, then NULL8 is returned.
For internal use only.
Definition at line 166 of file Statistics.cpp.
References Isis::NULL8, Isis::Statistics::p_sum, Isis::Statistics::p_sumsum, and Isis::Statistics::p_validPixels.
Referenced by Qisis::HistogramTool::changePlot(), Isis::operator<<(), and Isis::Statistics::StandardDeviation().
| 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.
| value | The value to calculate the z-score of. |
Definition at line 420 of file Statistics.cpp.
References _FILEINFO_, Isis::Statistics::Average(), Isis::Statistics::Maximum(), Isis::iException::Message(), and Isis::Statistics::StandardDeviation().
Referenced by Isis::AutoReg::ComputeChipZScore().
Stretch Isis::GaussianStretch::p_stretch [private] |
Value of the mean.
Definition at line 59 of file GaussianStretch.h.
Referenced by GaussianStretch(), and Map().