CAViewer::SetRoi

CAViewer class

Sets the position number of the first and last elements in the Region of Interest (ROI) of the specified array dimension.

BOOL SetRoi(
  short dim,
  long lbound,
  long ubound
  );

Parameters

dim

The array dimension that the following two arguments will be applied to. The dimension must be in the range 0 to rank-1, where rank is the rank of the currently loaded array.

lbound

The lower array index to be included in the ROI. The array index must be in the range 0 to extent-1, where extent is the extent of dimension dim.

ubound

The upper array index to be included in the ROI. This array index must be greater than or equal to lbound, and in the range 0 to extent-1, where extent is the extent of dimension dim.

Return Value

Returns TRUE if the operation was successful; otherwise, FALSE.

Remarks

This function can be used to select and view a subregion of the current array. You must call CAViewer::Update before the new ROI is mapped to the graph.

See Also

CAViewer::Update