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

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

All Implemented Interfaces:

GPTool

public class LineDensity
extends AbstractGPTool

Calculates a magnitude per unit area from polyline features that fall within a radius around each cell. The Line Density tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• Only the portion of a line within the neighborhood is considered when calculating the density. If no lines fall within the neighborhood at a particular cell, that cell is assigned NoData.
• Larger values of the radius parameter produce a more generalized density raster. Smaller values produce a raster that shows more detail.
• If the area unit scale factor units are small relative to the features (length of line sections), the output values may be small. To obtain larger values, use the area unit scale factor for larger units (for example, square kilometers versus square meters).
• The values on the output raster will always be floating point.

Field Summary

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

vals

Constructor Summary

LineDensity()
Creates the Line Density tool with defaults.

LineDensity(Object inPolylineFeatures, Object populationField, Object outRaster)
Creates the Line Density tool with the required parameters.

Method Summary

String	getAreaUnitScaleFactor() Returns the Area units parameter of this tool .
Object	getCellSize() Returns the Output cell size 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 .
Object	getPopulationField() Returns the Population field parameter of this tool .
double	getSearchRadius() Returns the Search radius 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	setAreaUnitScaleFactor(String areaUnitScaleFactor) Sets the Area units parameter of this tool .
void	setCellSize(Object cellSize) Sets the Output cell size 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	setPopulationField(Object populationField) Sets the Population field parameter of this tool .
void	setSearchRadius(double searchRadius) Sets the Search radius 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

LineDensity

public LineDensity()

Creates the Line Density tool with defaults.

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

LineDensity

public LineDensity(Object inPolylineFeatures,
                   Object populationField,
                   Object outRaster)

Creates the Line Density 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 - the input line features for which to calculate the density.

populationField - numeric field denoting population values (the number of times the line should be counted) for each polyline. values in the population field may be integer or floating point. use Shape if input features contains Z. use None if no item or special value will be used and each feature will be counted once. otherwise, the default field is POPULATION. Further to this:

• If there is no POPULATION field, but there is a POPULATIONxxxx field, this is used by default. The "xxxx" can be any valid character, such as POPULATION6, POPULATION1974, or POPULATIONROADTYPE.
• If there is no POPULATION field or POPULATIONxxxx field, but there is a POP field, this is used by default.
• If there is no POPULATION field, POPULATIONxxxx field, or POP field, but there is a POPxxxx field, this is used by default.
• If there is no POPULATION field, POPULATIONxxxx field, POP field, or POPxxxx field, NONE is used by default.

outRaster - the output line density raster. it is always a floating point raster.

Method Detail

getInPolylineFeatures

public Object getInPolylineFeatures()

Returns the Input polyline features parameter of this tool . This parameter is the input line features for which to calculate the density. 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 the input line features for which to calculate the density. This is a required parameter.

Parameters:

inPolylineFeatures - the input line features for which to calculate the density.

getPopulationField

public Object getPopulationField()

Returns the Population field parameter of this tool . This parameter is numeric field denoting population values (the number of times the line should be counted) for each polyline. values in the population field may be integer or floating point. use Shape if input features contains Z. use None if no item or special value will be used and each feature will be counted once. otherwise, the default field is POPULATION. Further to this: This is a required parameter.

Returns:

the Population field

setPopulationField

public void setPopulationField(Object populationField)

Sets the Population field parameter of this tool . This parameter is numeric field denoting population values (the number of times the line should be counted) for each polyline. values in the population field may be integer or floating point. use Shape if input features contains Z. use None if no item or special value will be used and each feature will be counted once. otherwise, the default field is POPULATION. Further to this: This is a required parameter.

Parameters:

populationField - numeric field denoting population values (the number of times the line should be counted) for each polyline. values in the population field may be integer or floating point. use Shape if input features contains Z. use None if no item or special value will be used and each feature will be counted once. otherwise, the default field is POPULATION. Further to this:

• If there is no POPULATION field, but there is a POPULATIONxxxx field, this is used by default. The "xxxx" can be any valid character, such as POPULATION6, POPULATION1974, or POPULATIONROADTYPE.
• If there is no POPULATION field or POPULATIONxxxx field, but there is a POP field, this is used by default.
• If there is no POPULATION field, POPULATIONxxxx field, or POP field, but there is a POPxxxx field, this is used by default.
• If there is no POPULATION field, POPULATIONxxxx field, POP field, or POPxxxx field, NONE is used by default.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output line density raster. it is always a floating point raster. 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 the output line density raster. it is always a floating point raster. This is a required parameter.

Parameters:

outRaster - the output line density raster. it is always a floating point raster.

getCellSize

public Object getCellSize()

Returns the Output cell size parameter of this tool . This parameter is the cell size for the output raster dataset. this is the value in the environment if specifically set. If the environment is not set, then cell size is the shorter of the width or height of the extent of the input 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 the cell size for the output raster dataset. this is the value in the environment if specifically set. If the environment is not set, then cell size is the shorter of the width or height of the extent of the input features, in the output spatial reference, divided by 250. This is an optional parameter.

Parameters:

cellSize - the cell size for the output raster dataset. this is the value in the environment if specifically set. If the environment is not set, then cell size is the shorter of the width or height of the extent of the input features, in the output spatial reference, divided by 250.

getSearchRadius

public double getSearchRadius()

Returns the Search radius parameter of this tool . This parameter is the search radius within which to calculate density. Units are based on the linear unit of the projection of the output spatial reference. for example, if the units are in meters, to include all features within in a one mile neighbourhood, set the search radius equal to 1609.344 (1 mile = 1609.344 meters). the default is the shortest of the width or height of the extent of the input features in the output spatial reference, divided by 30. 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 the search radius within which to calculate density. Units are based on the linear unit of the projection of the output spatial reference. for example, if the units are in meters, to include all features within in a one mile neighbourhood, set the search radius equal to 1609.344 (1 mile = 1609.344 meters). the default is the shortest of the width or height of the extent of the input features in the output spatial reference, divided by 30. This is an optional parameter.

Parameters:

searchRadius - the search radius within which to calculate density. Units are based on the linear unit of the projection of the output spatial reference. for example, if the units are in meters, to include all features within in a one mile neighbourhood, set the search radius equal to 1609.344 (1 mile = 1609.344 meters). the default is the shortest of the width or height of the extent of the input features in the output spatial reference, divided by 30.

getAreaUnitScaleFactor

public String getAreaUnitScaleFactor()

Returns the Area units parameter of this tool . This parameter is the desired area units of the output density values. a default unit is selected based on the linear unit of the projection of the output spatial reference. You can change this to the appropriate unit if you wish to convert the density output. Values for line density convert the units of both length and area. for example, if your input units are meters the default output area density units will be square kilometers for point features or kilometers per square kilometer for polyline features. the default density units based on the input feature units are: This is an optional parameter.

Returns:

the Area units

setAreaUnitScaleFactor

public void setAreaUnitScaleFactor(String areaUnitScaleFactor)

Sets the Area units parameter of this tool . This parameter is the desired area units of the output density values. a default unit is selected based on the linear unit of the projection of the output spatial reference. You can change this to the appropriate unit if you wish to convert the density output. Values for line density convert the units of both length and area. for example, if your input units are meters the default output area density units will be square kilometers for point features or kilometers per square kilometer for polyline features. the default density units based on the input feature units are: This is an optional parameter.

Parameters:

areaUnitScaleFactor - the desired area units of the output density values. a default unit is selected based on the linear unit of the projection of the output spatial reference. You can change this to the appropriate unit if you wish to convert the density output. Values for line density convert the units of both length and area. for example, if your input units are meters the default output area density units will be square kilometers for point features or kilometers per square kilometer for polyline features. the default density units based on the input feature units are:

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