PCL
Classes | Public Member Functions | List of all members
pcl::ImageStatistics Class Reference

Descriptive image statistics. More...

#include <ImageStatistics.h>

+ Inheritance diagram for pcl::ImageStatistics:

Classes

class  Data
 Statistical data in the normalized [0,1] range. More...
 

Public Member Functions

 ImageStatistics ()=default
 
 ImageStatistics (const ImageStatistics &)=default
 
 ~ImageStatistics () override
 
void Assign (const ImageStatistics &x)
 
double AverageDeviation () const
 
double AvgDev () const
 
double BendMidvariance () const
 
double BiweightMidvariance () const
 
double BWMV () const
 
size_type Count () const
 
void DisableAvgDev (bool disable=true)
 
void DisableBWMV (bool disable=true)
 
void DisableExtremes (bool disable=true)
 
void DisableMAD (bool disable=true)
 
void DisableMean (bool disable=true)
 
void DisableMedian (bool disable=true)
 
void DisablePBMV (bool disable=true)
 
void DisableQn (bool disable=true)
 
void DisableRejection (bool disableLow=true, bool disableHigh=true)
 
void DisableSn (bool disable=true)
 
void DisableSumOfSquares (bool disable=true)
 
void DisableVariance (bool disable=true)
 
void EnableAvgDev (bool enable=true)
 
void EnableBWMV (bool enable=true)
 
void EnableExtremes (bool enable=true)
 
void EnableMAD (bool enable=true)
 
void EnableMean (bool enable=true)
 
void EnableMedian (bool enable=true)
 
void EnablePBMV (bool enable=true)
 
void EnableQn (bool enable=true)
 
void EnableRejection (bool enableLow=true, bool enableHigh=true)
 
void EnableSn (bool enable=true)
 
void EnableSumOfSquares (bool enable=true)
 
void EnableVariance (bool enable=true)
 
const Data & GetData () const
 
bool IsAvgDevEnabled () const
 
bool IsBWMVEnabled () const
 
bool IsExtremesEnabled () const
 
bool IsHighRejectionEnabled () const
 
bool IsLowRejectionEnabled () const
 
bool IsMADEnabled () const
 
bool IsMeanEnabled () const
 
bool IsMedianEnabled () const
 
bool IsPBMVEnabled () const
 
bool IsQnEnabled () const
 
bool IsSnEnabled () const
 
bool IsSumOfSquaresEnabled () const
 
bool IsVarianceEnabled () const
 
double MAD () const
 
double Max () const
 
double Maximum () const
 
Point MaximumPosition () const
 
Point MaxPos () const
 
double Mean () const
 
double Median () const
 
double Min () const
 
double Minimum () const
 
Point MinimumPosition () const
 
Point MinPos () const
 
const DImage & operator<< (const DImage &image)
 
const Image & operator<< (const Image &image)
 
const ImageVariant & operator<< (const ImageVariant &image)
 
const UInt16Image & operator<< (const UInt16Image &image)
 
const UInt32Image & operator<< (const UInt32Image &image)
 
const UInt8Image & operator<< (const UInt8Image &image)
 
ImageStatistics & operator= (const ImageStatistics &)=default
 
double PBMV () const
 
double Qn () const
 
double RejectionHigh () const
 
double RejectionLow () const
 
void SetRejectionLimits (double low, double high)
 
double Sn () const
 
double StandardDeviation () const
 
double StdDev () const
 
double SumOfSquares () const
 
double Var () const
 
double Variance () const
 
- Public Member Functions inherited from pcl::ParallelProcess
 ParallelProcess ()=default
 
 ParallelProcess (const ParallelProcess &)=default
 
virtual ~ParallelProcess ()
 
void DisableParallelProcessing (bool disable=true) noexcept
 
void EnableParallelProcessing (bool enable=true, int maxProcessors=0) noexcept
 
bool IsParallelProcessingEnabled () const noexcept
 
int MaxProcessors () const noexcept
 
ParallelProcess & operator= (const ParallelProcess &)=default
 
void SetMaxProcessors (int maxProcessors) noexcept
 
void Swap (ParallelProcess &process) noexcept
 

Detailed Description

ImageStatistics provides basic descriptive statistics of pixel sample values:

  • Pixel sample count.
  • Arithmetic mean.
  • Median.
  • Variance and standard deviation from the mean.
  • Sum of squared samples.
  • Average deviation from the median.
  • Median absolute deviation from the median (MAD).
  • Biweight midvariance.
  • Percentage bend midvariance.
  • Sn and Qn scale estimators of Rousseeuw/Croux.
  • Extreme pixel sample values: minimum and maximum, and the image coordinates of their first occurrences.

All statistics can be enabled/disabled individually.

ImageStatistics works like a unidirectional image transformation, although it isn't actually a derived class of ImageTransformation. Example of use:

Image image;
// ...
ImageStatistics S;
S.DisableVariance(); // disable variance and sigma calculations
image.SelectChannel( 2 ); // select the third channel of image
image.SelectRectangle( 80, 100, 450, 600 ); // select a rectangular region
S << image; // calculate image statistics for selected samples
Console().WriteLn( String().Format( "<end><cbr>The median is: %.5f", S.Median() ) );
pcl::ImageStatistics::ImageStatistics
ImageStatistics()=default
Image
32-bit floating point real image.

ImageStatistics calculates statistical values for the currently selected region and channel of its source image.

Definition at line 116 of file ImageStatistics.h.

Constructor & Destructor Documentation

◆ ImageStatistics() [1/2]

pcl::ImageStatistics::ImageStatistics ( )
default

Constructs an ImageStatistics object.

◆ ImageStatistics() [2/2]

pcl::ImageStatistics::ImageStatistics ( const ImageStatistics &  )
default

Copy constructor.

◆ ~ImageStatistics()

pcl::ImageStatistics::~ImageStatistics ( )
inlineoverride

Destroys an ImageStatistics object.

Definition at line 221 of file ImageStatistics.h.

Member Function Documentation

◆ Assign()

void pcl::ImageStatistics::Assign ( const ImageStatistics &  x)
inline

Copies other ImageStatistics object x to this object.

Definition at line 233 of file ImageStatistics.h.

◆ AverageDeviation()

double pcl::ImageStatistics::AverageDeviation ( ) const
inline

Returns the average deviation from the median of the evaluated sample values in the normalized [0,1] range.

The average deviation is an estimator of the variability of a distribution around its central value. In the case of a deep sky image, the average deviation provides a good estimation of the width of the main histogram peak.

Definition at line 330 of file ImageStatistics.h.

◆ AvgDev()

double pcl::ImageStatistics::AvgDev ( ) const
inline

Returns the average deviation from the median of the evaluated sample values in the normalized [0,1] range.

This member function is a synonym for AverageDeviation().

Definition at line 341 of file ImageStatistics.h.

◆ BendMidvariance()

double pcl::ImageStatistics::BendMidvariance ( ) const
inline

Returns the percentage bend midvariance of the evaluated pixel sample values in the normalized [0,1] range.

The square root of the percentage bend midvariance is a robust estimator of scale. As implemented in ImageStatistics (beta=0.2), its Gaussian efficiency is 67%.

Definition at line 390 of file ImageStatistics.h.

◆ BiweightMidvariance()

double pcl::ImageStatistics::BiweightMidvariance ( ) const
inline

Returns the biweight midvariance of the evaluated pixel sample values in the normalized [0,1] range.

The square root of the biweight midvariance is a robust estimator of scale. It is an efficient estimator with respect to many statistical distributions (about 87% Gaussian efficiency), and appears to have a breakdown point close to 0.5 (the best possible breakdown).

Definition at line 366 of file ImageStatistics.h.

◆ BWMV()

double pcl::ImageStatistics::BWMV ( ) const
inline

Returns the biweight midvariance of the evaluated pixel sample values in the normalized [0,1] range.

This member function is a synonym for BiweightMidvariance().

Definition at line 377 of file ImageStatistics.h.

◆ Count()

size_type pcl::ImageStatistics::Count ( ) const
inline

Returns the total number of evaluated samples.

Definition at line 249 of file ImageStatistics.h.

◆ DisableAvgDev()

void pcl::ImageStatistics::DisableAvgDev ( bool  disable = true)
inline

Disables calculation of the average deviation from the median for this ImageStatistics object.

Definition at line 771 of file ImageStatistics.h.

◆ DisableBWMV()

void pcl::ImageStatistics::DisableBWMV ( bool  disable = true)
inline

Disables calculation of the biweight midvariance (BWMV) for this ImageStatistics object.

Definition at line 834 of file ImageStatistics.h.

◆ DisableExtremes()

void pcl::ImageStatistics::DisableExtremes ( bool  disable = true)
inline

Disables calculation of extreme pixel sample values for this ImageStatistics object.

Definition at line 624 of file ImageStatistics.h.

◆ DisableMAD()

void pcl::ImageStatistics::DisableMAD ( bool  disable = true)
inline

Disables calculation of the median deviation from the median (MAD) for this ImageStatistics object.

When MAD calculation is disabled, the biweight midvariance estimator is also disabled implicitly.

Definition at line 807 of file ImageStatistics.h.

◆ DisableMean()

void pcl::ImageStatistics::DisableMean ( bool  disable = true)
inline

Disables calculation of the arithmetic mean for this ImageStatistics object.

When arithmetic mean calculation is disabled, the variance (and hence the standard deviation) is also disabled implicitly.

Definition at line 660 of file ImageStatistics.h.

◆ DisableMedian()

void pcl::ImageStatistics::DisableMedian ( bool  disable = true)
inline

Disables calculation of the median for this ImageStatistics object.

When median calculation is disabled, the average deviation, MAD, biweight midvariance and bend midvariance estimators are also disabled implicitly.

Definition at line 744 of file ImageStatistics.h.

◆ DisablePBMV()

void pcl::ImageStatistics::DisablePBMV ( bool  disable = true)
inline

Disables calculation of the percentage bend midvariance (PBMV) for this ImageStatistics object.

Definition at line 861 of file ImageStatistics.h.

◆ DisableQn()

void pcl::ImageStatistics::DisableQn ( bool  disable = true)
inline

Disables calculation of the Rousseeuw/Croux Qn estimator of scale for this ImageStatistics object.

Note
The Qn estimator is disabled by default.

Definition at line 927 of file ImageStatistics.h.

◆ DisableRejection()

void pcl::ImageStatistics::DisableRejection ( bool  disableLow = true,
bool  disableHigh = true 
)
inline

Disables low and/or high sample rejection.

This is a convenience member function, equivalent to EnableRejection( !disableLow, !disableHigh ).

Definition at line 597 of file ImageStatistics.h.

◆ DisableSn()

void pcl::ImageStatistics::DisableSn ( bool  disable = true)
inline

Disables calculation of the Rousseeuw/Croux Sn estimator of scale for this ImageStatistics object.

Note
The Sn estimator is disabled by default.

Definition at line 894 of file ImageStatistics.h.

◆ DisableSumOfSquares()

void pcl::ImageStatistics::DisableSumOfSquares ( bool  disable = true)
inline

Disables calculation of the sum of squares for this object.

Definition at line 685 of file ImageStatistics.h.

◆ DisableVariance()

void pcl::ImageStatistics::DisableVariance ( bool  disable = true)
inline

Disables calculation of the variance for this ImageStatistics object.

Definition at line 710 of file ImageStatistics.h.

◆ EnableAvgDev()

void pcl::ImageStatistics::EnableAvgDev ( bool  enable = true)
inline

Enables calculation of the average deviation from the median for this ImageStatistics object.

Definition at line 762 of file ImageStatistics.h.

◆ EnableBWMV()

void pcl::ImageStatistics::EnableBWMV ( bool  enable = true)
inline

Enables calculation of the biweight midvariance (BWMV) for this ImageStatistics object.

Definition at line 825 of file ImageStatistics.h.

◆ EnableExtremes()

void pcl::ImageStatistics::EnableExtremes ( bool  enable = true)
inline

Enables calculation of extreme pixel sample values for this ImageStatistics object.

Definition at line 615 of file ImageStatistics.h.

◆ EnableMAD()

void pcl::ImageStatistics::EnableMAD ( bool  enable = true)
inline

Enables calculation of the median deviation from the median (MAD) for this ImageStatistics object.

When MAD calculation is disabled, the biweight midvariance estimator is also disabled implicitly.

Definition at line 795 of file ImageStatistics.h.

◆ EnableMean()

void pcl::ImageStatistics::EnableMean ( bool  enable = true)
inline

Enables calculation of the arithmetic mean for this ImageStatistics object.

When arithmetic mean calculation is disabled, the variance (and hence the standard deviation) is also disabled implicitly.

Definition at line 648 of file ImageStatistics.h.

◆ EnableMedian()

void pcl::ImageStatistics::EnableMedian ( bool  enable = true)
inline

Enables calculation of the median for this ImageStatistics object.

When median calculation is disabled, the average deviation, MAD, biweight midvariance and bend midvariance estimators are also disabled implicitly.

Definition at line 733 of file ImageStatistics.h.

◆ EnablePBMV()

void pcl::ImageStatistics::EnablePBMV ( bool  enable = true)
inline

Enables calculation of the percentage bend midvariance (PBMV) for this ImageStatistics object.

Definition at line 852 of file ImageStatistics.h.

◆ EnableQn()

void pcl::ImageStatistics::EnableQn ( bool  enable = true)
inline

Enables calculation of the Rousseeuw/Croux Qn estimator of scale for this ImageStatistics object.

Note
The Qn estimator is disabled by default.

Definition at line 916 of file ImageStatistics.h.

◆ EnableRejection()

void pcl::ImageStatistics::EnableRejection ( bool  enableLow = true,
bool  enableHigh = true 
)
inline

Enables low and/or high sample rejections.

When sample rejection is enabled, sample values inside the ranges [0,low] and [high,1] will be ignored during statistics calculation (where low and high are the current low and high rejection limits).

Definition at line 585 of file ImageStatistics.h.

◆ EnableSn()

void pcl::ImageStatistics::EnableSn ( bool  enable = true)
inline

Enables calculation of the Rousseeuw/Croux Sn estimator of scale for this ImageStatistics object.

Note
The Sn estimator is disabled by default.

Definition at line 883 of file ImageStatistics.h.

◆ EnableSumOfSquares()

void pcl::ImageStatistics::EnableSumOfSquares ( bool  enable = true)
inline

Enables calculation of the sum of squares for this object.

Definition at line 677 of file ImageStatistics.h.

◆ EnableVariance()

void pcl::ImageStatistics::EnableVariance ( bool  enable = true)
inline

Enables calculation of the variance for this ImageStatistics object.

Definition at line 702 of file ImageStatistics.h.

◆ GetData()

const Data& pcl::ImageStatistics::GetData ( ) const
inline

Returns a constant reference to the statistical data in this object.

Definition at line 241 of file ImageStatistics.h.

◆ IsAvgDevEnabled()

bool pcl::ImageStatistics::IsAvgDevEnabled ( ) const
inline

Returns true iff calculation of the average deviation from the median is currently enabled for this instance of ImageStatistics.

Definition at line 753 of file ImageStatistics.h.

◆ IsBWMVEnabled()

bool pcl::ImageStatistics::IsBWMVEnabled ( ) const
inline

Returns true iff calculation of the biweight midvariance (BWMV) is currently enabled for this instance of ImageStatistics.

Definition at line 816 of file ImageStatistics.h.

◆ IsExtremesEnabled()

bool pcl::ImageStatistics::IsExtremesEnabled ( ) const
inline

Returns true iff calculation of extreme pixel sample values is currently enabled for this instance of ImageStatistics.

Definition at line 606 of file ImageStatistics.h.

◆ IsHighRejectionEnabled()

bool pcl::ImageStatistics::IsHighRejectionEnabled ( ) const
inline

Returns true iff high sample rejection is enabled in this ImageStatistics object.

When high sample rejection is enabled, sample values greater than or equal to the high sample rejection limit will be ignored during statistics calculation.

Definition at line 573 of file ImageStatistics.h.

◆ IsLowRejectionEnabled()

bool pcl::ImageStatistics::IsLowRejectionEnabled ( ) const
inline

Returns true iff low sample rejection is enabled in this ImageStatistics object.

When low sample rejection is enabled, sample values less than or equal to the low sample rejection limit will be ignored during statistics calculation.

Definition at line 560 of file ImageStatistics.h.

◆ IsMADEnabled()

bool pcl::ImageStatistics::IsMADEnabled ( ) const
inline

Returns true iff calculation of the median deviation from the median (MAD) is currently enabled for this instance of ImageStatistics.

When MAD calculation is disabled, the biweight midvariance estimator is also disabled implicitly.

Definition at line 783 of file ImageStatistics.h.

◆ IsMeanEnabled()

bool pcl::ImageStatistics::IsMeanEnabled ( ) const
inline

Returns true iff calculation of the arithmetic mean is currently enabled for this instance of ImageStatistics.

When arithmetic mean calculation is disabled, the variance (and hence the standard deviation) is also disabled implicitly.

Definition at line 636 of file ImageStatistics.h.

◆ IsMedianEnabled()

bool pcl::ImageStatistics::IsMedianEnabled ( ) const
inline

Returns true iff calculation of the median is currently enabled for this instance of ImageStatistics.

When median calculation is disabled, the average deviation, MAD and biweight midvariance estimators are also disabled implicitly.

Definition at line 722 of file ImageStatistics.h.

◆ IsPBMVEnabled()

bool pcl::ImageStatistics::IsPBMVEnabled ( ) const
inline

Returns true iff calculation of the percentage bend midvariance (PBMV) is currently enabled for this instance of ImageStatistics.

Definition at line 843 of file ImageStatistics.h.

◆ IsQnEnabled()

bool pcl::ImageStatistics::IsQnEnabled ( ) const
inline

Returns true iff calculation of the Rousseeuw/Croux Qn estimator of scale is currently enabled for this instance of ImageStatistics.

Note
The Qn estimator is disabled by default.

Definition at line 905 of file ImageStatistics.h.

◆ IsSnEnabled()

bool pcl::ImageStatistics::IsSnEnabled ( ) const
inline

Returns true iff calculation of the Rousseeuw/Croux Sn estimator of scale is currently enabled for this instance of ImageStatistics.

Note
The Sn estimator is disabled by default.

Definition at line 872 of file ImageStatistics.h.

◆ IsSumOfSquaresEnabled()

bool pcl::ImageStatistics::IsSumOfSquaresEnabled ( ) const
inline

Returns true iff calculation of the sum of squares is currently enabled for this instance of ImageStatistics.

Definition at line 669 of file ImageStatistics.h.

◆ IsVarianceEnabled()

bool pcl::ImageStatistics::IsVarianceEnabled ( ) const
inline

Returns true iff calculation of the variance is currently enabled for this instance of ImageStatistics.

Definition at line 694 of file ImageStatistics.h.

◆ MAD()

double pcl::ImageStatistics::MAD ( ) const
inline

Returns the median absolute deviation from the median (MAD) of the evaluated sample values in the normalized [0,1] range.

The MAD is a well-known robust estimator of dispersion.

Definition at line 352 of file ImageStatistics.h.

◆ Max()

double pcl::ImageStatistics::Max ( ) const
inline

Returns the maximum evaluated sample value in the normalized [0,1] range.

This member function is a synonym for Maximum().

Definition at line 489 of file ImageStatistics.h.

◆ Maximum()

double pcl::ImageStatistics::Maximum ( ) const
inline

Returns the maximum evaluated sample value in the normalized [0,1] range.

Definition at line 479 of file ImageStatistics.h.

◆ MaximumPosition()

Point pcl::ImageStatistics::MaximumPosition ( ) const
inline

Returns the position (x,y coordinates) of the first occurrence of the maximum evaluated sample value.

Definition at line 498 of file ImageStatistics.h.

◆ MaxPos()

Point pcl::ImageStatistics::MaxPos ( ) const
inline

Returns the position (x,y coordinates) of the first occurrence of the maximum evaluated sample value.

This member function is a synonym for MaximumPosition().

Definition at line 509 of file ImageStatistics.h.

◆ Mean()

double pcl::ImageStatistics::Mean ( ) const
inline

Returns the arithmetic mean of the evaluated sample values in the normalized [0,1] range.

Definition at line 258 of file ImageStatistics.h.

◆ Median()

double pcl::ImageStatistics::Median ( ) const
inline

Returns the median of the evaluated sample values in the normalized [0,1] range.

Definition at line 276 of file ImageStatistics.h.

◆ Min()

double pcl::ImageStatistics::Min ( ) const
inline

Returns the minimum evaluated sample value in the normalized [0,1] range.

This member function is a synonym for Maximum().

Definition at line 451 of file ImageStatistics.h.

◆ Minimum()

double pcl::ImageStatistics::Minimum ( ) const
inline

Returns the minimum evaluated sample value in the normalized [0,1] range.

Definition at line 441 of file ImageStatistics.h.

◆ MinimumPosition()

Point pcl::ImageStatistics::MinimumPosition ( ) const
inline

Returns the position (x,y coordinates) of the first occurrence of the minimum evaluated sample value.

Definition at line 460 of file ImageStatistics.h.

◆ MinPos()

Point pcl::ImageStatistics::MinPos ( ) const
inline

Returns the position (x,y coordinates) of the first occurrence of the minimum evaluated sample value.

This member function is a synonym for MinimumPosition().

Definition at line 471 of file ImageStatistics.h.

◆ operator<<() [1/6]

const DImage& pcl::ImageStatistics::operator<< ( const DImage &  image)

Calculates statistical data for a 64-bit floating point image. Returns a reference to the source image.

◆ operator<<() [2/6]

const Image& pcl::ImageStatistics::operator<< ( const Image &  image)

Calculates statistical data for a 32-bit floating point image. Returns a reference to the source image.

◆ operator<<() [3/6]

const ImageVariant& pcl::ImageStatistics::operator<< ( const ImageVariant &  image)
inline

Calculates statistical data for an image transported by an ImageVariant instance. Returns a reference to the source image.

Definition at line 966 of file ImageStatistics.h.

References pcl::ImageVariant::BitsPerSample(), pcl::ImageVariant::IsComplexSample(), and pcl::ImageVariant::IsFloatSample().

◆ operator<<() [4/6]

const UInt16Image& pcl::ImageStatistics::operator<< ( const UInt16Image &  image)

Calculates statistical data for a 16-bit unsigned integer image. Returns a reference to the source image.

◆ operator<<() [5/6]

const UInt32Image& pcl::ImageStatistics::operator<< ( const UInt32Image &  image)

Calculates statistical data for a 32-bit unsigned integer image. Returns a reference to the source image.

◆ operator<<() [6/6]

const UInt8Image& pcl::ImageStatistics::operator<< ( const UInt8Image &  image)

Calculates statistical data for an 8-bit unsigned integer image. Returns a reference to the source image.

◆ operator=()

ImageStatistics& pcl::ImageStatistics::operator= ( const ImageStatistics &  )
default

Copy assignment operator. Returns a reference to this object.

◆ PBMV()

double pcl::ImageStatistics::PBMV ( ) const
inline

Returns the percentage bend midvariance of the evaluated pixel sample values in the normalized [0,1] range.

This member function is a synonym for BendMidvariance().

Definition at line 401 of file ImageStatistics.h.

◆ Qn()

double pcl::ImageStatistics::Qn ( ) const
inline

Returns the Qn scale estimator of Rousseeuw and Croux in the normalized [0,1] range.

Qn is a robust estimator of scale (dispersion). It has the same outlier rejection properties as the MAD, but its Gaussian efficiency is higher (87%; the efficiency of MAD is only 37%). Unlike the MAD, Qn does not measure variability around a central value, but between pairs of data points. This makes Qn a potentially better estimator for asymmetrical or skewed distributions.

Definition at line 433 of file ImageStatistics.h.

◆ RejectionHigh()

double pcl::ImageStatistics::RejectionHigh ( ) const
inline

Returns the high sample rejection limit in the [0,1] range.

When high sample rejection is enabled, sample values greater than or equal to the value returned by this function will be ignored during statistics calculation.

Definition at line 533 of file ImageStatistics.h.

◆ RejectionLow()

double pcl::ImageStatistics::RejectionLow ( ) const
inline

Returns the low sample rejection limit in the [0,1] range.

When low sample rejection is enabled, sample values less than or equal to the value returned by this function will be ignored during statistics calculation.

Definition at line 521 of file ImageStatistics.h.

◆ SetRejectionLimits()

void pcl::ImageStatistics::SetRejectionLimits ( double  low,
double  high 
)
inline

Sets the low and high rejection limits in the [0,1] range.

When sample rejection is enabled, sample values inside the ranges [0,low] and [high,1] will be ignored during statistics calculation.

Definition at line 544 of file ImageStatistics.h.

◆ Sn()

double pcl::ImageStatistics::Sn ( ) const
inline

Returns the Sn scale estimator of Rousseeuw and Croux in the normalized [0,1] range.

Sn is a robust estimator of scale (dispersion). It has the same outlier rejection properties as the MAD but its Gaussian efficiency is higher (58%; the efficiency of MAD is only 37%). Unlike the MAD, Sn does not measure variability around a central value, but between pairs of data points. This makes Sn a potentially better estimator for asymmetrical or skewed distributions.

Definition at line 417 of file ImageStatistics.h.

◆ StandardDeviation()

double pcl::ImageStatistics::StandardDeviation ( ) const
inline

Returns the standard deviation from the mean of the evaluated sample values in the normalized [0,1] range.

Definition at line 305 of file ImageStatistics.h.

◆ StdDev()

double pcl::ImageStatistics::StdDev ( ) const
inline

Returns the standard deviation from the mean of the evaluated sample values in the normalized [0,1] range.

This member function is a synonym for StandardDeviation().

Definition at line 316 of file ImageStatistics.h.

◆ SumOfSquares()

double pcl::ImageStatistics::SumOfSquares ( ) const
inline

Returns the sum of squares for the evaluated sample values. Samples are evaluated in the normalized [0,1] range.

Definition at line 267 of file ImageStatistics.h.

◆ Var()

double pcl::ImageStatistics::Var ( ) const
inline

Returns the variance from the mean of the evaluated sample valuess in the normalized [0,1] range.

This member function is a synonym for Variance().

Definition at line 296 of file ImageStatistics.h.

References pcl::Variance().

◆ Variance()

double pcl::ImageStatistics::Variance ( ) const
inline

Returns the variance from the mean of the evaluated sample valuess in the normalized [0,1] range.

Definition at line 285 of file ImageStatistics.h.

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