ENVIVectorMaskRaster::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()

; Open an input file

file = FILEPATH('qb_boulder_msi', ROOT_DIR=e.ROOT_DIR, $

SUBDIRECTORY = ['data'])

raster = e.OpenRaster(file)

; select input vector data

vectorName = Filepath('qb_boulder_msi_vectors.shp', SUBDIR=['data'], $

ROOT_DIR=e.Root_Dir)

vector = e.OpenVector(vectorName)

; mask the input raster using all the records from the vector data

rasterWithMask = ENVIVectorMaskRaster(raster, vector)

; Retrieve the dehydrated hash

dehydratedForm = rasterWithMask.Dehydrate()

rasterWithMask.close

; Restore the object

newImage = ENVIVectorMask.Hydrate(dehydratedForm)

Print, newImage, /IMPLIED_PRINT

Syntax

Result = ENVIVectorMaskRaster.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 `VectorMaskRaster` 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" }
input_vector	Required. The input ENVIVector. Example: "input_vector": { "url": "/usr/local/INSTALL_DIR/envi/data/qb_boulder_msi_vectors.shp", "factory": "URLRaster" }
inverse	To invert the mask, set to 1. Pixels outside of the given data ranges will be masked in the output. Example: "inverse" : 1
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

Introduced

API Version

4.2