CAViewer::SetRoi2D

CAViewer class

Sets the Region of Interest (ROI) within the current 2D array "slice".

BOOL SetRoi2D(
  long col_start,
  long row_start,
  long num_cols,
  long num_rows
  );

Parameters

col_start

The lower array index of the current column dimension to be included in the ROI.

row_start

The lower array index of the current row dimension to be included in the ROI.

num_cols

The number of columns to be included in the ROI.

num_rows

The number of rows to be included ROI.

Return Value

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

Remarks

This subroutine is similar to the SetRoi subroutine, which also updates the current ROI. However, SetRoi2D is more convenient to use in cases where the current 2D slice of the array is not being changed.