ENVIROIMaskRaster::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. 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)

; select input ROIs

fileName = Filepath('qb_boulder_roi.xml', SUBDIR=['data'], $

ROOT_DIR=e.Root_Dir)

rois = e.OpenRoi(fileName)

; create a masked raster using the water ROI

maskedRaster = ENVIRoiMaskRaster(raster, rois[2])

; Retrieve the dehydrated hash

Result = maskedRaster.Dehydrate()

Print, Result, /IMPLIED_PRINT

Syntax

Result = ENVIROIMaskRaster.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 (optional)

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