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


Harris Geospatial / Docs Center / ENVI API / Data Control / ENVIRaster::Dehydrate

ENVIRaster::Dehydrate

ENVIRaster::Dehydrate

The Dehydrate function method returns a hash describing this object. You can use this information in a later ENVI session to restore the object using the object’s static ::Hydrate method or the ENVIHydrate function.

There are many functions that create an ENVIRaster object. ENVIRaster can be created from an input file on disk from a remote dataset URL like OGC-WCS, or it can be created from virtual raster functions.

Example


; Start the application
e = ENVI(/HEADLESS)
 
; Create an ENVIRaster object
file = FILEPATH('qb_boulder_msi', ROOT_DIR=e.ROOT_DIR, $
  SUBDIRECTORY = ['data'])
raster = e.OpenRaster(file)
 
; Retrieve the dehydrated form
Result = raster.Dehydrate()
Print, Result, /IMPLIED_PRINT

Syntax


Result = ENVIRaster.Dehydrate(ERROR=value)

Return Value


This function method returns a hash containing the key/value pairs representing the current object state. You can build your own hash without instantiating an object. To see the required key/value pairs for the object see the object’s Hydrate method.

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.3, Service Pack 1

Introduced

API Version


3.1.0

See Also


ENVIRaster, ENVIRaster::Hydrate, ENVIHydratable, ENVIHydrate



© 2017 Exelis Visual Information Solutions, Inc. |  Legal
My Account    |    Buy    |    Contact Us