This routine is obsolete and has been replaced with the ENVIROI::PixelAddresses method.

This function returns the 1D spatial addresses (pointers) of each point in an ROI. The address of an ROI pixel at (r_sample, r_line) is calculated as:

r_sample + r_line * ns.

Syntax

---

Result = ENVI_GET_ROI(ROI_ID, ROI_COLOR=variable, ROI_NAME=variable)

Arguments

---

ROI_ID

This is a single ID returned from the function ENVI_GET_ROI_IDS.

Keywords

---

ROI_COLOR

Use this keyword to specify a named variable that contains the RGB color value for ROI_ID. ROI_COLOR is a byte array of size three.

ROI_NAME

Use this keyword to specify a named variable that contains a string with the ROI name.