CStats:Class Description

CStats Class

The CStats class computes statistics over a rectangular region of an image. This class uses the same statistical algorithms as the CImCombine class.

Usage

Construction	Object = CStats:new()
Destruction	Object:delete()

Data Members

ptr	A pointer to the Mira statistics object. It is not wise to work directly with the value of ptr. If it is needed by another class, use the GetStatsPtr method to access it.

Methods

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.

Accessing and Initializing Data Members

GetStatsPtr	Returns a pointer to the Mira statistics object wrapped by the CStats class.
GetErrMsg	Returns the error message after a statistics calculation.
GetImage	Returns a CImage for the image being measured.
GetRect	Returns a CRect for the rectangle being measured.
GetStatus	Returns 0 if a calculation succeeded or a non zero error code if it failed.
Init	Specifies both the CImage and CRect objects to be measured.
SetImage	Specifies the CImage to be measured.

Operations

AlphaClipMean	Returns the alpha clipped mean value.
ContraMean	Returns the contra-power mean value.
GeomMean	Returns the geometric mean value.
Max	Returns the maximum value.
MaxClipMean	Returns the maximum clipped mean value.
MaxPix	Returns the coordinate of the maximum value.
Mean	Returns the mean value.
MeanSdev	Returns the mean and standard deviation.
Median	Returns the median value.
Min	Returns the minimum value.
MinClipMean	Returns the minimum clipped mean value.
MinMaxClipMean	Returns the minimum and maximum clipped mean value.
MinPix	Returns the coordinate of the minimum value.
MtmSigmaClipMean	Returns the Modified Trimmed Mean value.
RankClipMean	Returns the rank percentile clipped mean value.
Sdev	Returns the standard deviation using the computed mean or a specified mean.
SigmaClipMean	Returns the sigma clipped mean value.
YpMean	Returns the Yp Mean value.

Related Topics