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

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?

Example

; Create a headless instance

e = ENVI(/HEADLESS)

; Open a las file

file = FILEPATH('DataSample.las', ROOT_DIR=e.ROOT_DIR, $

SUBDIRECTORY = ['data','lidar'])

pointcloud = e.OpenPointCloud(file, $

PROJECT_URI=Filepath('DataSample', /TMP))

; Create a spatial subset of 100m x 100m for processing

subset = ENVISpatialSubsetPointCloud(pointcloud, [593741.00, 5289518.0, 593841.00, 5289618.0])

; Retrieve the dehydrated hash

dehydratedForm = subset.Dehydrate()

subset.Close

pointcloud.Close

; Restore the object

newSubset = ENVISpatialSubsetPointCloud.Hydrate(dehydratedForm)

Print, newSubset, /IMPLIED_PRINT

Syntax

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

Return Value

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

Arguments

DehydratedForm

Key	Description
factory	Required. A string value of `SpatialSubsetPointCloud` indicating what object type the hash represents.
urlpointcloud	Required. An ENVIPointCloud object. Example: "urlpointcloud": { "url": "C:\\Program Files\\INSTALL_DIR\\envixx\\data\\lidar\\DataSample.las", "factory": "URLPointCloud", "project_uri": "C:\\lidar\\DataSample" } See ENVIPointCloud::Dehydrate for more information.
sub_rect	Required. A four-element double-precision array expressing the spatial range of the required subset. The array is of the form [x1, y1, x2, y2], where: x1 = the minimum X value to include in the subset y1 = the minimum Y value to include in the subset x2 = the maximum X value to include in the subset y2 = the maximum Y value to include in the subset Example: "sub_rect": [593741.00000000000, 5289518.0000000000, 593841.00000000000, 5289618.0000000000]

Key

Description

factory

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

urlpointcloud

Required. An ENVIPointCloud object. Example:

"urlpointcloud": {

"url": "C:\\Program Files\\INSTALL_DIR\\envixx\\data\\lidar\\DataSample.las",

"factory": "URLPointCloud",

"project_uri": "C:\\lidar\\DataSample"

}

See ENVIPointCloud::Dehydrate for more information.

sub_rect

Required. A four-element double-precision array expressing the spatial range of the required subset. The array is of the form [x1, y1, x2, y2], where:

x1 = the minimum X value to include in the subset
y1 = the minimum Y value to include in the subset
x2 = the maximum X value to include in the subset
y2 = the maximum Y value to include in the subset

Example:

"sub_rect": [593741.00000000000, 5289518.0000000000, 593841.00000000000, 5289618.0000000000]

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

4.2