ENVIGCPSet::Remove

The Remove method removes individual ground control points (GCPs) from an ENVIGCPSet object.

Example

; Start the application

e = ENVI()

; Open an existing GCP file

GCPFile = Dialog_Pickfile(TITLE='Select an ENVI .pts file')

GCPs = ENVIGCPSet(GCPFile)

Print, GCPs

; Remove a GCP whose ID is 0

GCPs.Remove, 0

; Remove all GCPs

GCPs.Remove, /ALL

Syntax

ENVIGCPSet.Remove [, ID] [, Keywords=value]

Return Value

This method returns the number of GCPs that were removed.

Arguments

ID

Set this optional argument to a valid identifier of an individual GCP that you want to remove. Use the PRINT command on the ENVIGCPSet object to obtain ID numbers, if needed.

Keywords

ALL

Set this keyword to remove all GCPs. This results in an empty ENVIGCPSet object.

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