GetRoi Method

Gets the position number of the first or last active elements in the region of interest (ROI) for the specified array dimension.

Syntax

indexvalue = object.GetRoi (dim, LBorUB)

Parameters

dim
A Short expression that contains the dimension number of an array dimension.

LBorUB
A Short expression that contains the value 0, if the value of first active element in the ROI is desired. It contains the value 1, if the value of the last active element in the ROI is desired.

Return Value

indexvalue
A Long value containing the position number of the first or last active element in the specified dimension for the array.

Remarks

Both dimension numbering and array indexing begin with 0.

See Also

SetROI