E3De::GetProductsInfo

The GetProductsInfo function method returns an E3DProductsInfo object which contains the fully-qualified file names for all the products generated by ENVI LiDAR processing. Processing must have been done previously to return valid information.

This method has been deprecated. Use ENVIPointCloudProductsInfo instead.

Example

; Create a headless instance

e = E3De(/HEADLESS)

; Open a las file

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

  SUBDIRECTORY = 'DataSample')

lidar = e.OpenLidar(file, AUXILIARY_URI='C:\lidar\DataSample')

; Set the production parameters

prodParams = e.GetProductionParameters(lidar, ERROR=error)

prodParams.BUILDINGS_GENERATE = 1

prodParams.DEM_GENERATE = 1

prodParams.DSM_GENERATE = 1

prodParams.ORTHOPHOTO_GENERATE = 1

prodParams.POWERLINES_GENERATE = 1

prodParams.TREES_GENERATE = 1

; Generate the products

e.GenerateProducts, lidar, prodParams, ERROR=error

; Get the generated products information

productsInfo = e.GetProductsInfo(lidar, ERROR=error)

print, productsInfo

; Close any open lidar objects

e.Close

Syntax

Result = E3De.GetProductsInfo(E3dlidar, [ERROR=variable])

Return Value

An E3DProductsInfo object containing the generated products information for the specified E3DLidar object, which may be !NULL if the data has not been processed at all, or if none of the expected products can be found on the file system.

Arguments

E3dlidar

The E3DLidar object for which the generated products information should be retrieved. If this E3DLidar object was opened with DIRECT_READ set, then an error will be thrown.

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

3.2	Introduced
ENVI 5.3	Obsolete