TopographicModeling Task

This task performs topographic modeling on an input DEM.

Example

; Start the application

e = ENVI()

 

; Open an input file

File = Filepath('bhdemsub.img', $

  Subdir=['classic','data'], Root_Dir=e.Root_Dir)

Raster = e.OpenRaster(File)

 

; Get the task from the catalog of ENVITasks

Task = ENVITask('TopographicModeling')

 

; Define inputs

Task.INPUT_RASTER = Raster

Task.AZIMUTH = 60d

Task.ELEVATION = 60d

Task.KERNEL_SIZE = 3

 

; Run the task

Task.Execute

 

; Get the data collection

DataColl = e.Data

 

; Add the output to the data collection

DataColl.Add, Task.OUTPUT_RASTER

 

; Display the result

View = e.GetView()

Layer = View.CreateLayer(Task.OUTPUT_RASTER)

Syntax

Result = ENVITask('TopographicModeling')

Input parameters (Set, Get): AZIMUTH, ELEVATION, INPUT_RASTER, KERNEL_SIZE, OUTPUT_RASTER_URI, PIXEL_SIZE, PRODUCTS

Output parameters (Get only): OUTPUT_RASTER

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

Input Parameters

AZIMUTH (optional)

Specify the azimuth angle of an illumination source in degrees. The value will only be used for the Shaded Relief product. The default value is 45.

ELEVATION (optional)

Specify the elevation angle of an illumination source in degrees. The value will only be used for the Shaded Relief product. The default value is 45.

INPUT_RASTER (required)

Specify a raster on which to perform topographic modeling.

KERNEL_SIZE (optional)

Specify the size of the kernel used for processing. The default value is 3.

OUTPUT_RASTER_URI (optional)

Specify a string with the fully qualified filename and path of the associated OUTPUT_RASTER.

PIXEL_SIZE (optional)

Specify a double-precision array with the X and Y pixel size of the input raster, in meters. If these values are not set, they will be calculated from the spatial reference of the input image. The default value is 1.0 if the input image does not have a valid spatial reference.

PRODUCTS (optional)

Specify a string array with the products to calculate. By default, all products will be calculated.

See Background for descriptions of the options.

Output Parameters

OUTPUT_RASTER

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

Methods

Execute

Parameter

ParameterNames

Properties

DESCRIPTION

DISPLAY_NAME

NAME

REVISION

TAGS

Version History

ENVI 5.5

Introduced

See Also

ENVITask, TopographicFeatures Task, TopographicShadingUsingHLS Task,TopographicShadingUsingHSV Task, TopographicShadingUsingRGB Task, GenerateContourLines Task