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

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

All Implemented Interfaces:

GPTool

public class PointFileInformation
extends AbstractGPTool

Generates a new output feature class containing statistical information about one or more point files. The Point File Information tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• Input file(s) must be in either a LAS, XYZ, XYZI, or GENERATE format.
• When a folder containing point data files is selected as input the suffix must be entered. If a single file is selected as input the suffix is not a requirement.
• When the summarize option is not used the statistical information presented in the feature attribute table consists of the point count, average point spacing, z minimum, and z maximum of each point file entered. A separate row is created for each input file encountered. The point spacing is an estimate that assumes the points within the input file are evenly spaced over the XY extent of each input file.
• An output polygon feature class is created with the XY extents of the input file(s). Alternatively, Multipatch features can be generated by utilizing z minimum and z maximum extent information for each input file. These provide a 3D bounding box representation that can be viewed in ArcScene or ArcGlobe.
• The summarize option is useful to statistical summarize information for each class code in the input file, but can is expensive as each file must be scanned and analyzed.
• The point spacing reported by Point File Information is not exact, it is an estimate. The point spacing given is a summary when looking at trends for collections of files. The tool uses a rough estimate that simply compares the area of the file's bounding box with the point count. It is most accurate when the rectangular extent of the file being examined is filled with data. Files with points over large water bodies or on the perimeter of a study area, only partially occupied with data, will not produce accurate estimates.

Field Summary

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

vals

Constructor Summary

PointFileInformation()
Creates the Point File Information tool with defaults.

PointFileInformation(Object input, Object outFeatureClass, String inFileType)
Creates the Point File Information tool with the required parameters.

Method Summary

String	getDecimalSeparator() Returns the Decimal separator parameter of this tool .
String	getExtrudeGeometry() Returns the Create extruded geometry shapes parameter of this tool .
String	getFileSuffix() Returns the File Suffix parameter of this tool .
String	getFolderRecursion() Returns the Process input folders recursively parameter of this tool .
String	getInFileType() Returns the Input File Format parameter of this tool .
Object	getInput() Returns the Input parameter of this tool .
Object	getInputCoordinateSystem() Returns the Input Coordinate System parameter of this tool .
double	getMinPointSpacing() Returns the Average Point Spacing parameter of this tool (Read only).
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
String	getSummarizeByClassCode() Returns the Summarize by class code 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.
void	setDecimalSeparator(String decimalSeparator) Sets the Decimal separator parameter of this tool .
void	setExtrudeGeometry(String extrudeGeometry) Sets the Create extruded geometry shapes parameter of this tool .
void	setFileSuffix(String fileSuffix) Sets the File Suffix parameter of this tool .
void	setFolderRecursion(String folderRecursion) Sets the Process input folders recursively parameter of this tool .
void	setInFileType(String inFileType) Sets the Input File Format 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	setSummarizeByClassCode(String summarizeByClassCode) Sets the Summarize by class code 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

PointFileInformation

public PointFileInformation()

Creates the Point File Information tool with defaults.

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

PointFileInformation

public PointFileInformation(Object input,
                            Object outFeatureClass,
                            String inFileType)

Creates the Point File Information 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 point data files or folders.

outFeatureClass - the output feature class.

inFileType - the format of the input file(s). Input file(s) must be in either a LAS, XYZ, XYZI, or GENERATE format.

Method Detail

getInput

public Object getInput()

Returns the Input parameter of this tool . This parameter is one or more point data files or folders. 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 point data files or folders. This is a required parameter.

Parameters:

input - one or more point data files or folders.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output feature class. 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 output feature class. This is a required parameter.

Parameters:

outFeatureClass - the output feature class.

getInFileType

public String getInFileType()

Returns the Input File Format parameter of this tool . This parameter is the format of the input file(s). Input file(s) must be in either a LAS, XYZ, XYZI, or GENERATE format. This is a required parameter.

Returns:

the Input File Format

setInFileType

public void setInFileType(String inFileType)

Sets the Input File Format parameter of this tool . This parameter is the format of the input file(s). Input file(s) must be in either a LAS, XYZ, XYZI, or GENERATE format. This is a required parameter.

Parameters:

inFileType - the format of the input file(s). Input file(s) must be in either a LAS, XYZ, XYZI, or GENERATE format.

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.

getInputCoordinateSystem

public Object getInputCoordinateSystem()

Returns the Input Coordinate System parameter of this tool . This parameter is the coordinate system of the input data. 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 data. This is an optional parameter.

Parameters:

inputCoordinateSystem - the coordinate system of the input data.

getFolderRecursion

public String getFolderRecursion()

Returns the Process input folders recursively parameter of this tool . This parameter is scans through subfolders when an input folder is selected containing data in a subfolders directory. The output feature class will be generated with a column row for each file encountered in the directory structure. This is an optional parameter.

Returns:

the Process input folders recursively

setFolderRecursion

public void setFolderRecursion(String folderRecursion)

Sets the Process input folders recursively parameter of this tool . This parameter is scans through subfolders when an input folder is selected containing data in a subfolders directory. The output feature class will be generated with a column row for each file encountered in the directory structure. This is an optional parameter.

Parameters:

folderRecursion - scans through subfolders when an input folder is selected containing data in a subfolders directory. The output feature class will be generated with a column row for each file encountered in the directory structure.

getExtrudeGeometry

public String getExtrudeGeometry()

Returns the Create extruded geometry shapes parameter of this tool . This parameter is a 3D multipatch feature class will be generated based on the z minimum / maximum values of each input file. This is an optional parameter.

Returns:

the Create extruded geometry shapes

setExtrudeGeometry

public void setExtrudeGeometry(String extrudeGeometry)

Sets the Create extruded geometry shapes parameter of this tool . This parameter is a 3D multipatch feature class will be generated based on the z minimum / maximum values of each input file. This is an optional parameter.

Parameters:

extrudeGeometry - a 3D multipatch feature class will be generated based on the z minimum / maximum values of each input file.

getDecimalSeparator

public String getDecimalSeparator()

Returns the Decimal separator parameter of this tool . This parameter is separator symbol used in ASCII files. The default is decimal point. Allows user to declare if decimal symbol used in file(s) is a point or comma. This is an optional parameter.

Returns:

the Decimal separator

setDecimalSeparator

public void setDecimalSeparator(String decimalSeparator)

Sets the Decimal separator parameter of this tool . This parameter is separator symbol used in ASCII files. The default is decimal point. Allows user to declare if decimal symbol used in file(s) is a point or comma. This is an optional parameter.

Parameters:

decimalSeparator - separator symbol used in ASCII files. The default is decimal point. Allows user to declare if decimal symbol used in file(s) is a point or comma.

getSummarizeByClassCode

public String getSummarizeByClassCode()

Returns the Summarize by class code parameter of this tool . This parameter is scans through the LAS files and analyzes the class code values. The attribute table of the output feature class will contain statistical information for each class code encountered. This is an optional parameter.

Returns:

the Summarize by class code

setSummarizeByClassCode

public void setSummarizeByClassCode(String summarizeByClassCode)

Sets the Summarize by class code parameter of this tool . This parameter is scans through the LAS files and analyzes the class code values. The attribute table of the output feature class will contain statistical information for each class code encountered. This is an optional parameter.

Parameters:

summarizeByClassCode - scans through the LAS files and analyzes the class code values. The attribute table of the output feature class will contain statistical information for each class code encountered.

getMinPointSpacing

public double getMinPointSpacing()

Returns the Average Point Spacing parameter of this tool (Read only). This is an derived parameter.

Returns:

the Average Point Spacing

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