Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


Harris Geospatial / Docs Center / ENVI API / ENVI Classic Data Control / ENVI_GET_ROI_INFORMATION

ENVI_GET_ROI_INFORMATION

ENVI_GET_ROI_INFORMATION

This routine is obsolete and has been replaced with ENVIROI and ENVIROI::PixelCount.

This procedure returns information associated with defined ROIs.

Syntax


ENVI_GET_ROI_INFORMATION, ROI_IDS [, /LONG_NAME] [, NL=variable] [, NPTS=variable] [, NS=variable] [, ROI_COLORS=variable] [, ROI_NAMES=variable] [, /SHORT_NAME ]

Arguments


ROI_IDS

This argument contains the IDs of defined ROIs from which to get information. ROI_IDS is returned from the function ENVI_GET_ROI_IDS.

Keywords


LONG_NAME (optional)

Set this keyword to return the ROI name, ROI color, number of points, and associated image size in the variable specified by ROI_NAMES. You cannot set this keyword if you set SHORT_NAME.

NL (optional)

Use this keyword to specify a named variable containing the number of lines associated with the desired ROIs.

NPTS (optional)

Use this keyword to specify a named variable that contains the number of points associated with each ROI ID.

NS (optional)

Use this keyword to specify the number of samples associated with the desired ROIs.

ROI_COLORS (optional)

Use this keyword to specify a named variable that contains the RGB color value for each ROI ID. ROI_COLORS is a byte array of size [3, #ROI IDs].

ROI_NAMES (optional)

Use this keyword to specify a named variable that contains a string array of ROI names for each ROI ID. The default name includes the ROI name, ROI color, and number of points. Set the keyword SHORT_NAME or LONG_NAME to modify the default ROI_NAMES.

SHORT_NAME (optional)

Set this keyword to return only the ROI name in the variable specified by ROI_NAMES. You cannot set this keyword if you set LONG_NAME.



© 2017 Exelis Visual Information Solutions, Inc. |  Legal
My Account    |    Buy    |    Contact Us