ENVIAgZones::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. See the ENVIHydrate topic in ENVI Help.

If you set the URI keyword for ENVIAgZones, that URI will be used in the dehydrated hash. If you did not specify the URI keyword, a file will be created in ENVI's temporary directory with a .sav extension.

This method is part of ENVI Crop Science, which requires a separate license and installation.

Example

This example runs ENVIAgCreateZonesTask to create a classification raster and a zones object named outZones.

; Start the application

e = ENVI(/HEADLESS)

; Open a DEM file

File = Filepath('FieldDEM.dat', $

  Subdir=['data','crop_science'], $

  Root_Dir=e.Root_Dir)

Raster = e.OpenRaster(File)

; Get the task from the catalog of ENVITasks

Task = ENVITask('AgCreateZones')

; Define inputs

Task.INPUT_RASTER = Raster

Task.MINIMUM_AREA = 2023

Task.NUMBER_OF_APPLICATION_CATEGORIES = 5

; Define outputs

Task.OUTPUT_RASTER_URI = e.GetTemporaryFilename()

; Run the task

Task.Execute

; Get the zones object

outZones = Task.OUTPUT_ZONES

Result = outZones.Dehydrate()

Print, Result, /IMPLIED_PRINT

Syntax

Result = ENVIAgZones.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, refer to the Hydrate help topic for that object in ENVI Help.

Arguments

None

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

Version History

1.1	Introduced