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


  >  Docs Center  >  ENVI API  >  Data Control  >  ENVIGLTRasterSpatialRef::Hydrate

ENVIGLTRasterSpatialRef::Hydrate

ENVIGLTRasterSpatialRef::Hydrate

Use the Hydrate static function method to create the object from its dehydrated form. The dehydrated form consists of a hash containing the object’s properties and values. The Hydrate and Dehydrate methods let you store the object state in memory and restore it later.

Representing an object as a hash is necessary for running ENVI analytics with the ENVI Task Engine and the ENVI Services Engine.

See the ENVIHydrate function if you are creating a general IDL routine that will restore multiple object types.

Example


See the code example for ENVIGLTRasterSpatialRef. After creating the GLT spatial reference object, use the Hydrate method as follows

 
; Retrieve the dehydrated hash
dehydratedForm = GLTspatialRef.Dehydrate()
GLTspatialRef.close
 
; Restore the object
newGLT = ENVIGLTRasterSpatialRef.Hydrate(dehydratedForm)
Print, newGLT, /IMPLIED_PRINT

Syntax


Result = ENVIGLTRasterSpatialRef.Hydrate(DehydratedForm, ERROR=value)

Return Value


The result is a reference to a new object instance of the spatial reference.

Arguments


DehydratedForm

Key

Description

factory

Required. A string value of GLTRasterSpatialRef indicating what object type the hash represents.

xmap_grid

Required. A single-band, two-dimensional dehydrated ENVIRaster that contains longitude values.

ymap_grid

Required. A single-band, two-dimensional dehydrated ENVIRaster that contains latitude values.

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.4

Introduced

API Version


3.2

See Also


ENVIGLTRasterSpatialRef, ENVIGLTRasterSpatialRef::Dehydrate, ENVIHydratable, ENVIHydrate



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