com.esri.arcgis.geodatabaseextensions
Class LasReturnStatistics

java.lang.Object
  extended by com.esri.arcgis.geodatabaseextensions.LasReturnStatistics
All Implemented Interfaces:
ILasReturnStatistics, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class LasReturnStatistics
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILasReturnStatistics

Esri LasReturnStatistics object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
LasReturnStatistics(Object obj)
          Construct a LasReturnStatistics using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 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.
 int hashCode()
          the hashcode for this object
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

LasReturnStatistics

public LasReturnStatistics(Object obj)
                    throws IOException
Construct a LasReturnStatistics using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to LasReturnStatistics.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
LasReturnStatistics o = (LasReturnStatistics)obj; // will not work

LasReturnStatistics o = new LasReturnStatistics(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
IOException - if there are interop problems LasReturnStatistics theLasReturnStatistics = (LasReturnStatistics) obj;
Method Detail

equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getReturnType

public 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.

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

getPointCount

public 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.

Specified by:
getPointCount in interface ILasReturnStatistics
Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSyntheticPointCount

public 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.

Specified by:
getSyntheticPointCount in interface ILasReturnStatistics
Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getKeyPointCount

public 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.

Specified by:
getKeyPointCount in interface ILasReturnStatistics
Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public 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.

Specified by:
getExtent in interface ILasReturnStatistics
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.