CStats:MaxClipMean

CStats:MaxClipMean

The MaxClipMean method computes the maximum-clipped mean value inside a rectangular region of the image. The rectangle and image must have been previously initialized for the CStats object.

Syntax

nMean = CStats:MaxClipMean()

On success, returns the max-clipped mean value as a number.
On failure, returns 0.

Remarks

The calculated statistic excludes the highest (maximum value) pixel inside the region. Use this method to avoid a biased result when the region is known to contain one deviant, high pixel value.

Example

Suppose a CImage named I and a CRect named R exist. The following script fragment returns the mean value inside a rectangle on the image, discarding the 1 highest pixel value:

S = CStats:new()	-- create a CStats object
S:Init( I, R )	-- specify CImage and CRect to measure
nVal = S:MaxClipMean()	-- returns the mean value
Printf("mean=%lg\n", nVal)	-- list the result
S:delete()	-- when done with S, remove it from memory