ENVITask::Execute

This method runs the associated ENVITask.

Example

You can set properties as keywords to the ENVITask::Execute method if you prefer a more procedural style of programming:

task = ENVITask('RadiometricCalibration')

task.Execute, $

   INPUT_RASTER = inputRaster, $

   OUTPUT_RASTER = outputRaster, $

   etc...

Or, you can set them as properties to the ENVITask object after creation if you prefer a more object-oriented style:

task = ENVITask('RadiometricCalibration')

task.INPUT_RASTER = inputRaster

task.OUTPUT_RASTER = outputRaster

etc...

 

task.Execute

See the RadiometricCalibration task sample code for a full example.

Use the following code to print a list of available keywords that the Execute method can accept:

task = ENVITask('TaskName')

props = task.ParameterNames()

print, props

Syntax

ENVITask.Execute [, ERROR=variable] [, Keywords specific to a task]

Arguments

None

Keywords

ERROR

Set this keyword to a named variable that will contain any error message issued during execution of this routine. If no error occurs, the ERROR variable will be set to a null string (''). If an error occurs and the routine is a function, then the function result will be undefined.

When this keyword is not set and an error occurs, ENVI returns to the caller and execution halts. In this case, the error message is contained within !ERROR_STATE and can be caught using IDL's CATCH routine. See IDL Help for more information on !ERROR_STATE and CATCH.

See Manage Errors for more information on error handling in ENVI programming.

Version History

ENVI 5.1

Introduced

API Version

4.2

See Also

ENVITask