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


  >  Docs Center  >  ENVI API  >  Data Control  >  ENVIRasterLayer::AddROI

ENVIRasterLayer::AddROI

ENVIRasterLayer::AddROI

The AddROI function method creates and returns a new ENVIROILayer object. The ROI layer is displayed on an ENVIRasterLayer object.

Example


; Launch the application
e = ENVI()
 
; open and display qb_boulder_msi
file = Filepath('qb_boulder_msi', ROOT_DIR=e.Root_Dir, $
  SUBDIRECTORY=['data'])
raster = e.OpenRaster(file)
view = e.GetView()
layer = view.CreateLayer(raster)
 
; open and display the ROIs from qb_boulder_roi
file = Filepath('qb_boulder_roi.xml', ROOT_DIR=e.Root_Dir, $
  SUBDIRECTORY=['data'])
rois = e.OpenRoi(file)
numRois = N_Elements(rois)
roiLayers = Objarr(numRois)
FOR i=0, N_Elements(rois)-1 DO $
  roiLayers[i] = layer.AddRoi(rois[i])

Syntax


Result = ENVIRasterLayer.AddRoi(Data [, ERROR=variable])

Return Value


This method returns a reference to the ENVIROILayer object.

Arguments


Data

An ENVIROI reference.

Keywords


Keywords are applied only during the initial creation of the object.

ERROR

Set this keyword to a named variable that will contain any error message issued during execution of this routine. If no error occurs, the ERROR variable will be set to a null string (''). If an error occurs and the routine is a function, then the function result will be undefined.

When this keyword is not set and an error occurs, ENVI returns to the caller and execution halts. In this case, the error message is contained within !ERROR_STATE and can be caught using IDL's CATCH routine. See IDL Help for more information on !ERROR_STATE and CATCH.

See Manage Errors for more information on error handling in ENVI programming.

Version History


ENVI 5.1

Introduced

API Version


3.2

See Also


ENVIRasterLayer, ENVIROILayer, ENVIROI, ENVI::OpenROI



© 2018 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us