ENVITask::AddParameter

This method allows the addition of an IDLParameter class after ENVITask creation.

Example

You can replace an parameter with a new definition. For example, if you want the OUTPUT_KERNEL parameter on the LowPassKernel task to be an array of DOUBLEs instead of FLOATs:

; Start the application

e = ENVI()

 

; Load the task

task = ENVITask('LowPassKernel')

 

; Get the current parameter to use as a reference

param = task.Parameter('OUTPUT_KERNEL')

 

; Create new parameter, copying most properties from the current one

newParam = IDLParameterDoubleArray( $

  NAME='OUTPUT_KERNEL', $

  DIMENSIONS='[*,*]', $

  DISPLAY_NAME=param.DISPLAY_NAME, $

  DIRECTION=param.DIRECTION, $

  REQUIRED=param.REQUIRED, $

  DESCRIPTION=param.DESCRIPTION)

 

; Replace the parameter on the task with the new definition

task.AddParameter, newParam

Syntax

ENVITask.AddParameter, Parameter [, ERROR=variable]

Arguments

Parameter

Specify an object inheriting from IDLParameter to add to the task. If the NAME property of this parameter matches that of an existing parameter owned by the task, then it will replace the original parameter with this reference.

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.3. 2	Introduced
ENVI 5.4.1	Uses the appropriate IDLParameter class instead of ENVITaskParameter (which has been deprecated)

API Version

4.2

See Also

ENVITask