com.esri.arcgis.geoprocessing.tools.analyst3dtools
Class LASToMultipoint

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analyst3dtools.LASToMultipoint

All Implemented Interfaces:

GPTool

public class LASToMultipoint
extends AbstractGPTool

This tool imports one or more files in LAS format, the industry standard for lidar data, into a new multipoint feature class. Supported LAS file format versions are 1.0, 1.1, and 1.2. The LAS to Multipoint tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• LAS points can be classified into a number of categories including bare earth or ground, top of canopy, and water. The different classes are defined using numeric integer codes. Unfortunately, the LAS 1.0 specification does not have a predefined classification scheme, nor do the files summarize what, if any, class codes are used by the points. You need to be given this information from the data provider.If you are working with the LAS 1.1 or 1.2 specification, refer to the predefined classification schemes defined by American Society for Photogrammetry and Remote Sensing (ASPRS) for the desired data category. The following table lists the LAS class codes based on LAS version 1.2 defined by ASPRS.To import predefined LAS points from the LAS file or files, you can specify them in the Input Class Codes parameter.Classification ValueMeaning0Created, never classified1Unclassified2Ground3Low Vegetation4Medium Vegetation5High Vegetation6Building7Low Points (noise)8Model Key-Points (mass points)9Water10Reserved for ASPRS Definition11Reserved for ASPRS Definition12Overlap Points13-31Reserved fro ASPRS Definition
• Supported LAS versions are 1.0, 1.1, and 1.2.
• If you are not interested in importing points based on their return number, or if all returns specified in the file or files are set to 0 because the points have been filtered or classified, select ANY_RETURN.
• When loading multiple LAS attributes into an Oracle database, you'll need to make sure all DBTUNE keywords for parameter attribute_binary are set to use binary large objects (BLOBs), not LONGRAW. This is because LAS attributes are loaded as BLOBs, and Oracle does not support multiple BLOBs in LONGRAW tables. See your Oracle database administrator for assistance.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

LASToMultipoint()
Creates the LAS to Multipoint tool with defaults.

LASToMultipoint(Object input, Object outFeatureClass, double averagePointSpacing)
Creates the LAS to Multipoint tool with the required parameters.

Method Summary

Object	getAttribute() Returns the Input Attribute Names parameter of this tool .
double	getAveragePointSpacing() Returns the Average Point Spacing parameter of this tool .
Object	getClassCode() Returns the Input Class Codes parameter of this tool .
String	getFileSuffix() Returns the File Suffix parameter of this tool .
Object	getInput() Returns the Input parameter of this tool .
Object	getInputCoordinateSystem() Returns the Input Coordinate System parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
Object	getReturn() Returns the Input Return Values parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
double	getZFactor() Returns the Z Factor parameter of this tool .
void	setAttribute(Object attribute) Sets the Input Attribute Names parameter of this tool .
void	setAveragePointSpacing(double averagePointSpacing) Sets the Average Point Spacing parameter of this tool .
void	setClassCode(Object classCode) Sets the Input Class Codes parameter of this tool .
void	setFileSuffix(String fileSuffix) Sets the File Suffix parameter of this tool .
void	setInput(Object input) Sets the Input parameter of this tool .
void	setInputCoordinateSystem(Object inputCoordinateSystem) Sets the Input Coordinate System parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setReturn(Object returnVal) Sets the Input Return Values parameter of this tool .
void	setZFactor(double zFactor) Sets the Z Factor parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LASToMultipoint

public LASToMultipoint()

Creates the LAS to Multipoint tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

LASToMultipoint

public LASToMultipoint(Object input,
                       Object outFeatureClass,
                       double averagePointSpacing)

Creates the LAS to Multipoint tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

input - one or more files or folders with data in the LAS version 1.0, 1.1, and 1.2 format. The LAS format is the industry standard for lidar data.

outFeatureClass - the newly created multipoint feature class to which lidar points are added.

averagePointSpacing - the average 2D distance between points in the input file or files. This can be an approximation. If areas have been sampled at different densities, specify the smaller spacing. The value needs to be provided in the projection units of the output coordinate system.

Method Detail

getInput

public Object getInput()

Returns the Input parameter of this tool . This parameter is one or more files or folders with data in the LAS version 1.0, 1.1, and 1.2 format. The LAS format is the industry standard for lidar data. This is a required parameter.

Returns:

the Input

setInput

public void setInput(Object input)

Sets the Input parameter of this tool . This parameter is one or more files or folders with data in the LAS version 1.0, 1.1, and 1.2 format. The LAS format is the industry standard for lidar data. This is a required parameter.

Parameters:

input - one or more files or folders with data in the LAS version 1.0, 1.1, and 1.2 format. The LAS format is the industry standard for lidar data.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the newly created multipoint feature class to which lidar points are added. This is a required parameter.

Returns:

the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output Feature Class parameter of this tool . This parameter is the newly created multipoint feature class to which lidar points are added. This is a required parameter.

Parameters:

outFeatureClass - the newly created multipoint feature class to which lidar points are added.

getAveragePointSpacing

public double getAveragePointSpacing()

Returns the Average Point Spacing parameter of this tool . This parameter is the average 2D distance between points in the input file or files. This can be an approximation. If areas have been sampled at different densities, specify the smaller spacing. The value needs to be provided in the projection units of the output coordinate system. This is a required parameter.

Returns:

the Average Point Spacing

setAveragePointSpacing

public void setAveragePointSpacing(double averagePointSpacing)

Sets the Average Point Spacing parameter of this tool . This parameter is the average 2D distance between points in the input file or files. This can be an approximation. If areas have been sampled at different densities, specify the smaller spacing. The value needs to be provided in the projection units of the output coordinate system. This is a required parameter.

Parameters:

averagePointSpacing - the average 2D distance between points in the input file or files. This can be an approximation. If areas have been sampled at different densities, specify the smaller spacing. The value needs to be provided in the projection units of the output coordinate system.

getClassCode

public Object getClassCode()

Returns the Input Class Codes parameter of this tool . This parameter is numeric classification codes to use as a query filter. The default is no filter. This is an optional parameter.

Returns:

the Input Class Codes

setClassCode

public void setClassCode(Object classCode)

Sets the Input Class Codes parameter of this tool . This parameter is numeric classification codes to use as a query filter. The default is no filter. This is an optional parameter.

Parameters:

classCode - numeric classification codes to use as a query filter. The default is no filter.

getReturn

public Object getReturn()

Returns the Input Return Values parameter of this tool . This parameter is the return values used as a query filter. Valid return values are 1-5, LAST_RETURNS, and ANY_RETURNS. The default is ANY_RETURNS. This is an optional parameter.

Returns:

the Input Return Values

setReturn

public void setReturn(Object returnVal)

Sets the Input Return Values parameter of this tool . This parameter is the return values used as a query filter. Valid return values are 1-5, LAST_RETURNS, and ANY_RETURNS. The default is ANY_RETURNS. This is an optional parameter.

Parameters:

returnVal - the return values used as a query filter. Valid return values are 1-5, LAST_RETURNS, and ANY_RETURNS. The default is ANY_RETURNS.

getAttribute

public Object getAttribute()

Returns the Input Attribute Names parameter of this tool . This parameter is one or more LAS attributes to load and store and optionally the field names to use. The default is none. Supported attribute keywords are INTENSITY, RETURN_NUMBER, NUMBER_OF_RETURNS, SCAN_DIRECTION_FLAG, EDGE_OF_FLIGHTLINE, CLASSIFICATION, SCAN_ANGLE_RANK, FILE_MARKER, USER_BIT_FIELD, and GPS_TIME. This is an optional parameter.

Returns:

the Input Attribute Names

setAttribute

public void setAttribute(Object attribute)

Sets the Input Attribute Names parameter of this tool . This parameter is one or more LAS attributes to load and store and optionally the field names to use. The default is none. Supported attribute keywords are INTENSITY, RETURN_NUMBER, NUMBER_OF_RETURNS, SCAN_DIRECTION_FLAG, EDGE_OF_FLIGHTLINE, CLASSIFICATION, SCAN_ANGLE_RANK, FILE_MARKER, USER_BIT_FIELD, and GPS_TIME. This is an optional parameter.

Parameters:

attribute - one or more LAS attributes to load and store and optionally the field names to use. The default is none. Supported attribute keywords are INTENSITY, RETURN_NUMBER, NUMBER_OF_RETURNS, SCAN_DIRECTION_FLAG, EDGE_OF_FLIGHTLINE, CLASSIFICATION, SCAN_ANGLE_RANK, FILE_MARKER, USER_BIT_FIELD, and GPS_TIME.

getInputCoordinateSystem

public Object getInputCoordinateSystem()

Returns the Input Coordinate System parameter of this tool . This parameter is the coordinate system of the input LAS file. This defaults to that specified in the LAS file. If for some reason it's not defined in the file but you know what it is, provide it here. This is an optional parameter.

Returns:

the Input Coordinate System

setInputCoordinateSystem

public void setInputCoordinateSystem(Object inputCoordinateSystem)

Sets the Input Coordinate System parameter of this tool . This parameter is the coordinate system of the input LAS file. This defaults to that specified in the LAS file. If for some reason it's not defined in the file but you know what it is, provide it here. This is an optional parameter.

Parameters:

inputCoordinateSystem - the coordinate system of the input LAS file. This defaults to that specified in the LAS file. If for some reason it's not defined in the file but you know what it is, provide it here.

getFileSuffix

public String getFileSuffix()

Returns the File Suffix parameter of this tool . This parameter is the suffix of the files to import when a folder is specified on input. This is an optional parameter.

Returns:

the File Suffix

setFileSuffix

public void setFileSuffix(String fileSuffix)

Sets the File Suffix parameter of this tool . This parameter is the suffix of the files to import when a folder is specified on input. This is an optional parameter.

Parameters:

fileSuffix - the suffix of the files to import when a folder is specified on input.

getZFactor

public double getZFactor()

Returns the Z Factor parameter of this tool . This parameter is specifies a factor by which to multiply the surface heights. Used to convert z units to x and y units. This is an optional parameter.

Returns:

the Z Factor

setZFactor

public void setZFactor(double zFactor)

Sets the Z Factor parameter of this tool . This parameter is specifies a factor by which to multiply the surface heights. Used to convert z units to x and y units. This is an optional parameter.

Parameters:

zFactor - specifies a factor by which to multiply the surface heights. Used to convert z units to x and y units.

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias