TopographicBreaklines Task

This task performs raster calculations of topographic breaklines.

For additional details on topographic breaklines, see Topographic Breaklines.

Example

; Start the application

e = ENVI()

; Open an input file

File = FILEPATH(bhdemsub.img', $

  SUBDIRECTORY=['classic','data'], $

  ROOT_DIR=e.ROOT_DIR)

Raster = e.OpenRaster(File)

; Get the task from the catalog of ENVITasks

Task = ENVITask('TopographicBreaklines')

; Define the input raster

Task.INPUT_RASTER = Raster

; Run the task

Task.Execute

; Get the collection of data objects currently available in the Data Manager

DataColl = e.Data

; Add the output to the Data Manager

DataColl.Add, Task.OUTPUT_RASTER

; Display the result

View = e.GetView()

Layer = View.CreateLayer(Task.OUTPUT_RASTER)

Syntax

Result = ENVITask('TopographicBreaklines')

Input properties (Set, Get): INPUT_RASTER, KERNEL_SIZE, OUTPUT_URI

Output properties (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.

Methods

This task inherits the following methods from ENVITask:

Properties

This task inherits the following properties from ENVITask:

COMMUTE_ON_DOWNSAMPLE

INPUT_RASTER (required)

Specify a digital elevation model raster on which to calculate topographic breaklines.

KERNEL_SIZE (optional)

Specify the size of the kernel that will be used to calculate the breakline values. Permitted values are 5, 9, 17, and 33. The default value is 9.

OUTPUT_RASTER

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

OUTPUT_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.

Version History

ENVI 6.1

Introduced

API Version

4.3