CStats:Min

The Min method computes the minimum value for a data sample. The sample may be a Lua table or a class object of type CImage, CArray, or CMatrix. For CImage and CMatrix objects, an optional CRect object can be used to define the points used in the calculation.

Syntax

nMin = CStats:Min( table )

nMin = CStats:Min( CImage, )

nMin = CStats:Min( CImage, CRect )

nMin = CStats:Min( CArray )

nMin = CStats:Min( CArray, CRect )

nMin = CStats:Min( CMatrix )

where

table is a lua table containing the data.

CImage, CArray, and CMatrix are class objects containing the data to measure,

CRect is a CRect rectangle object that defines the region to measure.

nMin is the minimum value of the data. On failure, 0,0 is returned.

Examples

Suppose that CImage object I and CRect object R exist. The following script returns the minimum value inside a rectangle on the image:

S = CStats:new()	-- create a CStats object
nVal = S:Min( I, R )	-- returns the minimum value
Printf("Min=%lg\n", nVal)	-- list the result

The following script returns the minimum value in a table of data:

S = CStats:new()	-- create a CStats object
t = { 4, 4, 2, 5, 6.4, -1.42, -12, 3.4 }	-- create some data in a table
Printf("min=%lg\n", S:Min(t) )	-- list the result