com.esri.arcgis.geodatabaseextensions
Interface ILasReturnStatistics

All Superinterfaces:
Serializable
All Known Implementing Classes:
LasReturnStatistics

public interface ILasReturnStatistics
extends Serializable

Provides access to LasReturnStatistics object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


Method Summary
 IEnvelope getExtent()
          The XYZ extent of points associated with this return (excluding withheld points).
 double getKeyPointCount()
          The number of Key points associated with this return.
 double getPointCount()
          The number of points associated with this return (excluding withheld points).
 int getReturnType()
          The return type associated with the statistics.
 double getSyntheticPointCount()
          The number of Synthetic points associated with this return.
 

Method Detail

getReturnType

int getReturnType()
                  throws IOException,
                         AutomationException
The return type associated with the statistics.

Description

The return type (see esriTerrainLasReturnType) these statistics are associated with.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A com.esri.arcgis.geodatabaseextensions.esriTerrainLasReturnType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPointCount

double getPointCount()
                     throws IOException,
                            AutomationException
The number of points associated with this return (excluding withheld points).

Description

Note, its possible for there to be a discrepancy between this and IHeaderInfo.GetNumberOfPointsByReturn or ILasFile.GetNumberOfPointsByReturn. This is because the value from ILasReturnStatistics is based on a scan of the point records (i.e., the actual file contents), while the other methods are simply echoing what's stated in the LAS file header(s) and some LAS files have been found to contain incorrect header information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSyntheticPointCount

double getSyntheticPointCount()
                              throws IOException,
                                     AutomationException
The number of Synthetic points associated with this return.

Description

The number of synthetic points, as defined by the LAS specification, that belong to the selected lidar return type. Since synthetic points are added to LAS files in a post-process, and are not associated with any laser pulses, the return number(s) associated with them are undefined. Generally, it's expected they'll be set to 1 since LAS readers are likely to expect return values in the range 1-5 and may fail with anything else (e.g., 0).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getKeyPointCount

double getKeyPointCount()
                        throws IOException,
                               AutomationException
The number of Key points associated with this return.

Description

The number of key points associated with the selected lidar return type (see esriTerrainLasReturnType). According to the LAS specification there are two means of defining key points: by class bit field encoding or by assignment of classification code 8. This method reports the count for the bit encoded key points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The XYZ extent of points associated with this return (excluding withheld points).

Description

The XYZ extent of the selected lidar return type. Withheld points, as defined by the LAS specification, are not taken into consideration.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.