ROIToKML Task

This task exports ENVI regions of interest (ROIs) to a Keyhole Markup Language (KML) file.

This task exports only the geometry-based ROIs to a KML file. Pixel-based ROIs and threshold-based ROIs should first be converted to geometry-based ROIs before using this task.

Example

; Start the application

e = ENVI()

 

; Open an ROI file

roiFile = Filepath('qb_boulder_roi.xml', Subdir=['data'], $

  Root_Dir=e.Root_Dir)

roi = e.OpenROI(roiFile)

 

; Define inputs

Task = ENVITask('ROIToKML')

Task.INPUT_ROI = roi

Task.FILL = !true

 

; Run the task

Task.Execute

Syntax

Result = ENVITask('ROIToKML')

Input properties (Set, Get): FILL, FILL_TRANSPARENCY, INPUT_ROI, OUTPUT_KML_URI, SPATIAL_REFERENCE, THICK

Output properties (Get only):

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.

Methods

This task inherits the following methods from ENVITask:

AddParameter

Execute

Parameter

ParameterNames

RemoveParameter

Properties

This task inherits the following properties from ENVITask:

COMMUTE_ON_DOWNSAMPLE

COMMUTE_ON_SUBSET

DESCRIPTION

DISPLAY_NAME

NAME

REVISION

TAGS

This task also contains the following properties:

FILL (optional)

Set this property if you want to fill ROI polygons in the KML.

FILL_TRANSPARENCY (optional)

Color transparency (from 0 to 100 : fully opaque to fully transparent) for filled ROI polygons in the KML.

INPUT_ROI (required)

Specify the ENVI ROIs to convert to KML. Only geometry-based ROIs are supported; pixel ROIs are not.

OUTPUT_KML_URI (optional)

Specify a string with the fully-qualified path and filename for the KML file.

SPATIAL_REFERENCE (optional)

Specify the spatial reference information for Classic ROIs.

THICK (optional)

The ROI outline thickness (width), in pixels.

Version History

ENVI 5.6.4

Introduced

API Version

4.2

See Also

ENVITask