com.esri.arcgis.geodatabaseextensions
Class LasStatistics

java.lang.Object
  com.esri.arcgis.geodatabaseextensions.LasStatistics

All Implemented Interfaces:

ILasStatistics, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class LasStatistics
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILasStatistics

Esri LasStatistics object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

LasStatistics(Object obj)
Construct a LasStatistics using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
ISimpleStatistics	getAttributeStatistics(int attribute) Get statistics of the specified LAS attribute.
ILasClassCodeStatistics	getClassCodeStatistics(int classCode) Get statistics associated with the specified class code.
ILasReturnStatistics	getReturnStatistics(int type) Get statistics associated with the specified return type.
ILongArray	getUniqueClassCodes() Get unique class codes.
ILongArray	getUniqueReturns() Get unique returns (as esriTerrainLasReturnType).
IEnvelope	getWithheldExtent() The XYZ extent of withheld points.
double	getWithheldPointCount() The number of withheld points.
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

LasStatistics

public LasStatistics(Object obj)
              throws IOException

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

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

Throws:

IOException - if there are interop problems LasStatistics theLasStatistics = (LasStatistics) 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

getWithheldPointCount

public double getWithheldPointCount()
                             throws IOException,
                                    AutomationException

The number of withheld points.

Description

Returns the number of points flagged as withheld in the file/dataset. Withheld points are those identified using the bit field encoding scheme laid out in the LAS Specification. Generally, these points are intended to be excluded from use.

Product Availability

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

Specified by:

getWithheldPointCount in interface ILasStatistics

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWithheldExtent

public IEnvelope getWithheldExtent()
                            throws IOException,
                                   AutomationException

The XYZ extent of withheld points.

Description

Returns the XYZ extent of points flagged as withheld in the file/dataset. Withheld points are those identified using the bit field encoding scheme laid out in the LAS Specification. Generally, these points are intended to be excluded from use. The envelope will be empty (IEnvelope.IsEmpty == TRUE) if there are no withheld points.

Product Availability

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

Specified by:

getWithheldExtent in interface ILasStatistics

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.

getAttributeStatistics

public ISimpleStatistics getAttributeStatistics(int attribute)
                                         throws IOException,
                                                AutomationException

Get statistics of the specified LAS attribute.

Description

Returns the LasAttributeStatistics for the specified attribute.

Product Availability

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

Specified by:

getAttributeStatistics in interface ILasStatistics

Parameters:

attribute - A com.esri.arcgis.geodatabaseextensions.esriLasAttributeType constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabaseextensions.ISimpleStatistics

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUniqueReturns

public ILongArray getUniqueReturns()
                            throws IOException,
                                   AutomationException

Get unique returns (as esriTerrainLasReturnType).

Description

Returns an ILongArray of esriTerrainLasReturnType. The number of entries in the array will equal the number of return types present in the file/dataset. These include the returns with explicit return numbers (i.e., returns 1-5) plus those which are inferred by comparing the return number for a point to the total returns for the pulse associated with the point (e.g., to derive first of many, last of many, single, etc.).

Note:

Some LAS files in the wild have been found to contain returns numbered "0". These are not valid returns but if they exist in the file they will be reported in the LongArray with a value of "0". Their presence will induce the addition of others like esriTerrainLasReturnLast (for point records that have both return number and number of returns set to 0) and esriTerrainLasReturnAll.

Product Availability

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

Specified by:

getUniqueReturns in interface ILasStatistics

Returns:

A reference to a com.esri.arcgis.system.ILongArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUniqueClassCodes

public ILongArray getUniqueClassCodes()
                               throws IOException,
                                      AutomationException

Get unique class codes.

Description

Returns an Array of LasClassCodeStatistics. The number of entries in the array will equal the number of classes present in the file/dataset.

Product Availability

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

Specified by:

getUniqueClassCodes in interface ILasStatistics

Returns:

A reference to a com.esri.arcgis.system.ILongArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReturnStatistics

public ILasReturnStatistics getReturnStatistics(int type)
                                         throws IOException,
                                                AutomationException

Get statistics associated with the specified return type.

Description

Provides the LasReturnStatistics for the specified return type. NULL is returned if there are no points of the specified type.

Note:

Some LAS files in the wild have been found to contain returns numbered "0". These are not valid returns but you can check to see if they are present by passing a "0" for the return type instead of one of the esriTerrainLasReturnType values.

Product Availability

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

Specified by:

getReturnStatistics in interface ILasStatistics

Parameters:

type - A com.esri.arcgis.geodatabaseextensions.esriTerrainLasReturnType constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabaseextensions.ILasReturnStatistics

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassCodeStatistics

public ILasClassCodeStatistics getClassCodeStatistics(int classCode)
                                               throws IOException,
                                                      AutomationException

Get statistics associated with the specified class code.

Description

Returns the LasClassCodeStatistics for the specified class. The valid range for las class codes is 0-31 for LAS files rev 1.1 through 1.3. NULL is returned if there are no points with that class code.

Product Availability

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

Specified by:

getClassCodeStatistics in interface ILasStatistics

Parameters:

classCode - The classCode (in)

Returns:

A reference to a com.esri.arcgis.geodatabaseextensions.ILasClassCodeStatistics

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.