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


  >  Docs Center  >  ENVI API  >  Data Control  >  ENVIMosaicRaster::Dehydrate

ENVIMosaicRaster::Dehydrate

ENVIMosaicRaster::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.

Example


The example uses sample images from the ENVI Resource DVD (in the mosaic folder). The images are also available from the ENVI Tutorials web page. Click the "ENVI Tutorial Data" hyperlink. Copy the images to your local drive, and update the file location with your own directory.

PRO ENVIMosaicRasterDehydrateExample
  COMPILE_OPT IDL2
   
  ; Start the application
  e = ENVI(/HEADLESS)
   
  ; Select input scenes
  files = REVERSE(FILE_SEARCH('C:\MyData\', 'airphoto*.dat'))
  scenes = !NULL
  FOR i=0, N_ELEMENTS(files)-1 DO BEGIN
     raster = e.OpenRaster(files[i], DATA_IGNORE_VALUE=0)
     scenes = [scenes, raster]
  ENDFOR
   
  ; Create a mosaic raster
  mosaic = ENVIMosaicRaster(scenes)
   
  ; Retrieve the dehydrated hash
  Result = mosaic.Dehydrate()
  Print, Result, /IMPLIED_PRINT
END

Syntax


Result = ENVIMosaicRaster.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

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


3.3

See Also


ENVIMosaicRaster, ENVIMosaicRaster::Hydrate, ENVIHydratable, ENVIHydrate



© 2019 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us