CStats:new

CStats Class


The CStats class computes statistics or estimator values for numeric data. The data may be in the form of a lua array or a class object of type CImage, CArray, or CMatrix. For the CImage and CMatrix classes, you can optionally specify a rectangle that bounds the data region. For a CImage, the data may have multiple channels as with an RGB image. This class uses the same algorithms as the CImCombine class.

Usage

Construction

Object = CStats:new()

Destruction

Object:delete()

Properties

This class has no exposed properties.

Construction & Destruction

new

Creates a new instance of the CImage class.

delete

Deletes the instance of the CImage object and deletes its image from memory.

Operations

AlphaClipMean

Computes the alpha-clipped mean and standard deviation.

ContraMean

Computes the contra-power mean and standard deviation.

GeomMean

Computes the geometric mean and standard deviation.

Kurtosis

Computes the kurtosis of the data set.

Max

Computes the maximum value and its coordinate.

MaxClipMean

Computes the mean value with the maximum data value discarded, plus the standard deviation.

MaxPix

Computes the coordinate of the maximum value.

Mean

Computes the mean and standard deviation.

Median

Computes the median and standard deviation.

Min

Computes the minimum value and its coordinate.

MinClipMean

Computes the mean value with the minimum data value discarded, plus the standard deviation.

MinMaxClipMean

Computes the mean value with its minimum and maximum data values discarded, plus the standard deviation..

MinPix

Computes the coordinate of the minimum value.

MtmSigmaClipMean

Computes the Modified Trimmed Mean and standard deviation.

RankClipMean

Computes the rank percentile clipped mean and the standard deviation.

Rank

Computes the percentile rank value and standard deviation.

Sdev

Computes the standard deviation or the standard deviation about a specified mean value.

SigmaClipMean

Computes the sigma clipped mean and standard deviation.

Skewness

Computes the skewness of the data set.

YpMean

Computes the Y-power Mean and standard deviation.

Accessing and Initializing Properties

GetErrMsg

Returns the error message for a method failed.

GetStatus

Returns a non-zero error code if a method failed.

Init

Specifies both the CImage and CRect objects to be measured.

SetImage

Specifies the CImage to be measured.

Related Topics

CImage, CArray, CMatrix, CRect