>  Docs Center  >  ENVI API  >  Data Control  >  ENVIDataValuesMaskRaster::Hydrate



Use the Hydrate static function method to create the object from its dehydrated form. The dehydrated form consists of a hash containing the object’s properties and values. The Hydrate and Dehydrate methods let you store the object state in memory and restore it later.

Representing an object as a hash is necessary for running ENVI analytics with the ENVI Task Engine and the ENVI Services Engine.

See the ENVIHydrate function if you are creating a general IDL routine that will restore multiple object types.

For additional information, see "What are Hydrate and Dehydrate routines used for?" in the ENVI API Programming Guide.


; Start the application
; Open an input file
file = FILEPATH('qb_boulder_msi', ROOT_DIR=e.ROOT_DIR, $
  SUBDIRECTORY = ['data'])
raster = e.OpenRaster(file)
; set two different data ranges to mask
ranges = [[0, 350], $
[700, 10000]]
; mask the input raster using the given data ranges
dataValuesRaster = ENVIDataValuesMaskRaster(raster, ranges)
; Retrieve the dehydrated hash
dehydratedForm = dataValuesRaster.Dehydrate()
; Restore the object
newImage = ENVIDataValuesMaskRaster.Hydrate(dehydratedForm)
Print, newImage, /IMPLIED_PRINT


Result = ENVIDataValuesMaskRaster.Hydrate(DehydratedForm, ERROR=value)

Return Value

The result is a reference to a new object instance of this virtual raster class.






Required. A string value of DataValuesMaskRaster indicating what object type the hash represents.


Required. The input ENVIRaster for use in ENVI processing.


"input_raster": {
    "url": "/usr/local/harris/envi/data/qb_boulder_msi",
    "factory": "URLRaster"


A (2,n) array of one or more data ranges where the first element of each range is the minimum data value to consider (inclusive) and the second element of each range is the maximum data value to consider (inclusive) for the pixels of the input raster. Example:

"input_ranges": [[0,350], [700,10000]]


To invert the mask, set to 1. Pixels outside of the given data ranges will be masked in the output. Example:

"inverse" : 1


A string that identifies the raster.


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


API Version


See Also

ENVIDataValuesMaskRaster, ENVIDataValuesMaskRaster::Dehydrate, ENVIHydratable, ENVIHydrate

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