BuildObjectDetectionRasterFromROI Task

This task builds an object detection dataset from an input raster and an ROI file indicating features of interest.

Example

Sample data files are available on our ENVI Tutorials web page. Click the "Deep Learning" link in the ENVI Tutorial Data section to download a .zip file containing the data. Extract the contents of the .zip file to a local directory. Files are located in the object_detection folder.

; Start the application

e = ENVI()

; Update the following line with the correct path

; to the tutorial data files

File = 'C:\MyTutorialFiles\DRCOG_AerialImage1.dat'

Raster = e.OpenRaster(File)

; Update the following line with the correct path

; to the tutorial data files

ROIFile = 'C:\MyTutorialFiles\Handicap_Parking_Spots_ROIs1.xml'

ROI = e.OpenROI(ROIFile)

; Get the task from the catalog of ENVITasks

Task = ENVITask('BuildObjectDetectionRasterFromROI')

; Define inputs

Task.INPUT_RASTER = Raster

Task.INPUT_ROI = ROI

; Run the task

Task.Execute

; Add the output to the Data Manager

e.Data.Add, Task.OUTPUT_RASTER

; Display the result

View = e.GetView()

Layer = View.CreateLayer(Task.OUTPUT_RASTER)

Syntax

Result = ENVITask('BuildObjectDetectionRasterFromROI')

Input parameters (Set, Get): ENHANCE_DISPLAY, INPUT_RASTER, INPUT_ROI, OUTPUT_RASTER_URI, VISUAL_RGB

Output parameters (Get only): OUTPUT_RASTER

Properties marked as "Set" are those that you can set to specific values. You can also retrieve their current values any time. Properties marked as "Get" are those whose values you can retrieve but not set.

Input Parameters

ENHANCE_DISPLAY (optional)

Specify whether to apply an additional small stretch to the processed data to suppress noise and enhance feature visibility. The optional stretch is effective for improving visual clarity in imagery acquired from aerial platforms or sensors with higher noise profiles.

INPUT_RASTER (required)

Specify the input raster to use for label data.

INPUT_ROI (required)

Specify a polygon ROI that indicates the labeled pixels for the desired class in the input raster. Point and polyline ROIs are not supported.

OUTPUT_RASTER_URI (optional)

Specify a string with the fully qualified filename and path of the associated OUTPUT_RASTER. If you do not specify this property, or set it to an exclamation symbol (!), a temporary file will be created.

VISUAL_RGB (optional)

Specify whether to encode the output raster as a three-band RGB composite (red, green, blue) for color image processing. This ensures consistent band selection from ENVI display types (such as RGB, CIR, and pan) and supports integration of diverse data sources (such as MSI, panchromatic, and VNIR) without band mismatch.

Output Parameters

OUTPUT_RASTER

This is a reference to the output raster of filetype ENVI.

If INPUT_RASTER is not byte data then each band will be byte stretched to its minimum and maximum.

Methods

Execute

Parameter

ParameterNames

See ENVI Help for details on these ENVITask methods.

Properties

DESCRIPTION

DISPLAY_NAME

NAME

REVISION

Version History

Deep Learning 1.2

Introduced