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.

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

For additional information, see What are Hydrate and Dehydrate routines used for?

Example

; Start the application
e = ENVI(/HEADLESS)
 
; Open an input file
file = FILEPATH('qb_boulder_msi', ROOT_DIR=e.ROOT_DIR, $
  SUBDIRECTORY = ['data'])
raster = e.OpenRaster(file)
 
; Cast the raster to floating point values
castRaster = ENVICastRaster(raster, 'float')
 
; Retrieve the dehydrated hash
dehydratedForm = castRaster.Dehydrate()
castRaster.close
 
; Restore the object
newCastRaster = ENVICastRaster.Hydrate(dehydratedForm)
Print, newCastRaster, /IMPLIED_PRINT

Syntax

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

Return Value

The result is a reference to a new object instance of this virtual raster class.

Arguments

DehydratedForm

Key

Description

factory

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

input_raster

Required. The input ENVIRaster for use in ENVI processing. Example:

"input_raster": {
    "url": "/usr/local/INSTALL_DIR/envi/data/qb_boulder_msi",
    "factory": "URLRaster"
}

data_ignore_value

Specify a numeric pixel value that will be ignored upon export. Example:

"data_ignore_value" : 0

data_type

 

Specify a string indicating the data type to cast the pixel values to. Choose one of the following values, which are supported by any ENVIRaster:

  • byte
  • int
  • long
  • float
  • double
  • uint
  • ulong

Example:

"data_type" : "float"

name

A string that identifies the raster.

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

Introduced

API Version

4.2

See Also

ENVICastRaster