Welcome to the Harris Geospatial documentation center. Here you will find reference guides and help documents.


  >  Docs Center  >  ENVI API  >  Data Control  >  ENVIDataCollection::Remove

ENVIDataCollection::Remove

ENVIDataCollection::Remove

The Remove method lets you remove data objects from the Data Manager.

Example


The following example subsets an ENVIRaster and adds it to the Data Manager, then removes the original ENVIRaster from the Data Manager.

; Start the application
e = ENVI()
 
; Open an input file
File = Filepath('qb_boulder_msi',Subdir=['data'], $
   Root_Dir=e.Root_Dir)
Raster = e.OpenRaster(File)
 
; Process a spatial subset
Subset = ENVISubsetRaster(Raster, Sub_Rect=[600,200,799,399])
 
; Get the collection of data objects currently available in the Data Manager
DataColl = e.Data
 
; Add the subsetted raster to the Data Manager
DataColl.Add, Subset
 
; Remove the source image
DataColl.Remove, Raster

Syntax


ENVIDataCollection.Remove, Data [, ERROR=variable]

Arguments


Data

Specify a data object, or array of data objects, to remove from the Data Manager. Examples of data objects include ENVIRasters and ENVIVectors.

Keywords


ERROR (optional)

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


3.3

See Also


ENVIDataCollection



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