>  Docs Center  >  ENVI API  >  Processing  >  ENVITopographicModelingTask

ENVITopographicModelingTask

ENVITopographicModelingTask

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 properties (Set, Get): AZIMUTH, ELEVATION, INPUT_RASTER, KERNEL_SIZE, OUTPUT_RASTER_URI, PIXEL_SIZE, PRODUCTS

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:

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:

AZIMUTH (optional)

Specify the azimuth angle of the model in degrees. The value will only be used for the Shaded Relief product. The default value is 0.

ELEVATION (optional)

Specify the elevation angle of the model in degrees. The value will only be used for the Shaded Relief product. The default value is 0.

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

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

OUTPUT_RASTER_URI (required)

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.

PIXEL_SIZE (optional)

Specify a double-precision array with the X and Y pixel size of the input raster, in meters.

PRODUCTS (optional)

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

  • Slope
  • Aspect
  • Shaded Relief
  • Profile Convexity
  • Plan Convexity
  • Longitudinal Convexity
  • Cross Sectional Convexity
  • Minimum Curvature
  • Maximum Curvature
  • RMS
  • Slope Percent

Version History


ENVI 5.5

Introduced

API Version


3.3

See Also


ENVITask, ENVITask::Parameter, ENVISubsetRaster, ENVITopographicFeaturesTask, ENVITopographicShadingUsingHLSTask,ENVITopographicShadingUsingHSVTask, ENVITopographicShadingUsingRGBTask, ENVIGenerateContourLinesTask



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