Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


Harris Geospatial / Docs Center / ENVI API / Crop Science / ENVIAgCrops::Dehydrate

ENVIAgCrops::Dehydrate

ENVIAgCrops::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 ENVIAgCrops, 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 .json extension.

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

Example


This example counts the crops in a spectral index image of a citrus orchard. It creates an ENVIAgCrops object named outCrops.

; Start the application
e = ENVI(/HEADLESS)
 
; Open an input file
File = Filepath('CitrusOrthophoto.dat', $
  Subdir=['data','crop_science'], $
  Root_Dir=e.Root_Dir)
Raster = e.OpenRaster(File)
 
; Preprocess the image so that crops are bright
MTVIImage = ENVISpectralIndexRaster(Raster, 'MTVI')
 
; Count the crops and create an ENVIAgCrops object
outCrops = ENVIAgCropCount(MTVIImage, 2.0, 5.0, $
  GAUSSIAN_FACTOR = 0, $
  /INCLUDE_EDGES, $
  INTENSITY_THRESHOLD = 0.8, $
  NUMBER_OF_INCREMENTS = 4, $
  PERCENT_OVERLAP = 100.0)
 
Result = outCrops.Dehydrate()
Print, Result, /IMPLIED_PRINT

Syntax


Result = ENVIAgCrops.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.0

Introduced

See Also


ENVIAgCrops, ENVIAgCrops::Hydrate



© 2017 Exelis Visual Information Solutions, Inc. |  Legal
My Account    |    Buy    |    Contact Us