ENVIRasterSeries::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.

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)

; Locate a raster series file

seriesFile = Filepath('AirTemp.series', Subdir=['data','time_series'], $

  Root_Dir = e.Root_Dir)

; Create a raster series object

series = ENVIRasterSeries(seriesFile)

; Retrieve the dehydrated hash

dehydratedForm = series.Dehydrate()

series.close

; Restore the object

newRasterSeries = ENVIRasterSeries.Hydrate(dehydratedForm)

Print, newRasterSeries, /IMPLIED_PRINT

Syntax

Result = ENVIRasterSeries.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 URLRasterSeries indicating what object type the hash represents.
url	Required. A uniform resource locator (URL) identifying an ENVIRasterSeries file for use in ENVI processing. Example: "url" : "/usr/local/INSTALL_DIR/envi/mydata/example.series"
auxiliary_url	A string array containing the URLs for the raster files (including .hdr files) contained in an ENVIRasterSeries. This key is generated on output if auxiliary files exist. On input this key is ignored to allow ENVIRasterSeries to override various behaviors.
dataset_index	This applies to file formats with multiple datasets per file such as ECRG, HDF5, Multi-page TIFF, NetCDF-4, NITF with multiple image segments, Proba-V, and SkySat-1. Specify a zero-based index number that corresponds to a specific raster dataset that you want to open within a raster series Example: "dataset_index": 1,

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
ENVI 5.5	Added auxiliary_url key to the hash that is returned.

API Version

4.3