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.

This method is part of ENVI Deep Learning, which requires a separate license and installation.

Example


; Launch the application
e = ENVI(/HEADLESS)
 
; Open a label raster
File = Filepath('LabelRasterContainers.dat', $
  Subdir=['data','deep_learning'], Root_Dir=e.Root_Dir)
Raster = ENVIDeepLearningLabelRaster(File)
 
; Retrieve the deyhdrated form
Result = Raster.Dehydrate()
Print, Result, /IMPLIED_PRINT

Syntax


ENVIDeepLearningRaster.Dehydrate [, ERROR=variable]

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


Keywords are applied only during the initial creation of the object.

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 the Manage Errors topic in ENVI Help for more information on error handling.

Version History


Deep Learning 1.0

Introduced

See Also


ENVIDeepLearningLabelRaster