com.esri.arcgis.geoprocessing.tools.spatialanalysttools
Class LineStatistics

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialanalysttools.LineStatistics

All Implemented Interfaces:

GPTool

public class LineStatistics
extends AbstractGPTool

Calculates a statistic on the attributes of lines in a circular neighborhood around each output cell. The Line Statistics tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Line Statistics works

Software restrictions: none

Usage tips:

• Only the part of a line within the neighborhood is considered for the Majority, Mean, Median, and Minority types. For the others, it does not matter whether a part or the whole line is used.
• If there are no lines in the neighborhood of a raster cell, the Variety statistic assigns a value of zero. For the other statistics, NoData is assigned.
• The statistic types Majority, Mean, Median, and Minority are weighted according to the length of the lines. If a line is twice as long as another, its value is considered to occur twice as often.
• The values on the output raster will always be integer in the case of Variety. They will always be floating point for Mean and STD. For the other statistics, the output data type is the same as the input item value type.
• When the field is integer, the available overlay statistic choices are Mean, Majority, Maximum, Median, Minimum, Minority, Range, STD, and Variety. When the field is floating point, the only allowed statistics are Mean, Maximum, Minimum, Range, and STD.
• For statistic types Majority, Maximum, Median, Minimum, Minority and Range, the output data type of the raster will be the same as the input field type. For statistics types Mean and STD, the output raster will always be floating point. For Variety, the output raster will always be integer.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

LineStatistics()
Creates the Line Statistics tool with defaults.

LineStatistics(Object inPolylineFeatures, Object field, Object outRaster)
Creates the Line Statistics tool with the required parameters.

Method Summary

Object	getCellSize() Returns the Output cell size parameter of this tool .
Object	getField() Returns the Field parameter of this tool .
Object	getInPolylineFeatures() Returns the Input polyline features parameter of this tool .
Object	getOutRaster() Returns the Output raster parameter of this tool .
double	getSearchRadius() Returns the Search radius parameter of this tool .
String	getStatisticsType() Returns the Statistics type 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	setCellSize(Object cellSize) Sets the Output cell size parameter of this tool .
void	setField(Object field) Sets the Field parameter of this tool .
void	setInPolylineFeatures(Object inPolylineFeatures) Sets the Input polyline features parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .
void	setSearchRadius(double searchRadius) Sets the Search radius parameter of this tool .
void	setStatisticsType(String statisticsType) Sets the Statistics type 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

LineStatistics

public LineStatistics()

Creates the Line Statistics tool with defaults.

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

LineStatistics

public LineStatistics(Object inPolylineFeatures,
                      Object field,
                      Object outRaster)

Creates the Line Statistics 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:

inPolylineFeatures - Composite Geodataset, the input polyline features to calculate the Line Statistics for.

field - Field, field can be any numeric field of in_polyline_features. Field can be the shape field if in_polyline_features contains z.

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInPolylineFeatures

public Object getInPolylineFeatures()

Returns the Input polyline features parameter of this tool . This parameter is Composite Geodataset, the input polyline features to calculate the Line Statistics for. This is a required parameter.

Returns:

the Input polyline features

setInPolylineFeatures

public void setInPolylineFeatures(Object inPolylineFeatures)

Sets the Input polyline features parameter of this tool . This parameter is Composite Geodataset, the input polyline features to calculate the Line Statistics for. This is a required parameter.

Parameters:

inPolylineFeatures - Composite Geodataset, the input polyline features to calculate the Line Statistics for.

getField

public Object getField()

Returns the Field parameter of this tool . This parameter is Field, field can be any numeric field of in_polyline_features. Field can be the shape field if in_polyline_features contains z. This is a required parameter.

Returns:

the Field

setField

public void setField(Object field)

Sets the Field parameter of this tool . This parameter is Field, field can be any numeric field of in_polyline_features. Field can be the shape field if in_polyline_features contains z. This is a required parameter.

Parameters:

field - Field, field can be any numeric field of in_polyline_features. Field can be the shape field if in_polyline_features contains z.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. This is a required parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(Object outRaster)

Sets the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. This is a required parameter.

Parameters:

outRaster - Raster Dataset, the raster to be created.

getCellSize

public Object getCellSize()

Returns the Output cell size parameter of this tool . This parameter is Analysis cell size, this is the value in the environment if specifically set. If not set in the environment, it is the shorter of the width or height of the extent of in_polyline_features in the output spatial reference, divided by 250. This is an optional parameter.

Returns:

the Output cell size

setCellSize

public void setCellSize(Object cellSize)

Sets the Output cell size parameter of this tool . This parameter is Analysis cell size, this is the value in the environment if specifically set. If not set in the environment, it is the shorter of the width or height of the extent of in_polyline_features in the output spatial reference, divided by 250. This is an optional parameter.

Parameters:

cellSize - Analysis cell size, this is the value in the environment if specifically set. If not set in the environment, it is the shorter of the width or height of the extent of in_polyline_features in the output spatial reference, divided by 250.

getSearchRadius

public double getSearchRadius()

Returns the Search radius parameter of this tool . This parameter is Double, the default radius is five times the output cell size. This is an optional parameter.

Returns:

the Search radius

setSearchRadius

public void setSearchRadius(double searchRadius)

Sets the Search radius parameter of this tool . This parameter is Double, the default radius is five times the output cell size. This is an optional parameter.

Parameters:

searchRadius - Double, the default radius is five times the output cell size.

getStatisticsType

public String getStatisticsType()

Returns the Statistics type parameter of this tool . This parameter is String, statistics are calculated on the value of the specified for all lines in the neighborhood. This is an optional parameter.

Returns:

the Statistics type

setStatisticsType

public void setStatisticsType(String statisticsType)

Sets the Statistics type parameter of this tool . This parameter is String, statistics are calculated on the value of the specified for all lines in the neighborhood. This is an optional parameter.

Parameters:

statisticsType - String, statistics are calculated on the value of the specified for all lines in the neighborhood.

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