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

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

All Implemented Interfaces:

GPTool

public class KernelDensity
extends AbstractGPTool

Calculates a magnitude per unit area from point or polyline features using a kernel function to fit a smoothly tapered surface to each point or polyline. The Kernel Density tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Kernel Density works

Software restrictions: none

Usage tips:

• Only the points or portions of a line that fall within the neighborhood are considered in calculating density. If no points or line sections fall within the neighborhood of a particular cell, that cell is assigned NoData.
• Larger values of the radius parameter produce a smoother, 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 (distance between points or length of line sections, depending on feature type), the output values may be small. To obtain larger values, select 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.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

KernelDensity()
Creates the Kernel Density tool with defaults.

KernelDensity(Object inFeatures, Object populationField, Object outRaster)
Creates the Kernel 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	getInFeatures() Returns the Input point or 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	setInFeatures(Object inFeatures) Sets the Input point or 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

KernelDensity

public KernelDensity()

Creates the Kernel Density tool with defaults.

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

KernelDensity

public KernelDensity(Object inFeatures,
                     Object populationField,
                     Object outRaster)

Creates the Kernel 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:

inFeatures - Composite Geodataset, the input features (point or line) to calculate the density for.

populationField - Field, otherwise, the default field is . Further to this:

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input point or polyline features parameter of this tool . This parameter is Composite Geodataset, the input features (point or line) to calculate the density for. This is a required parameter.

Returns:

the Input point or polyline features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input point or polyline features parameter of this tool . This parameter is Composite Geodataset, the input features (point or line) to calculate the density for. This is a required parameter.

Parameters:

inFeatures - Composite Geodataset, the input features (point or line) to calculate the density for.

getPopulationField

public Object getPopulationField()

Returns the Population field parameter of this tool . This parameter is Field, otherwise, the default field is . 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 Field, otherwise, the default field is . Further to this: This is a required parameter.

Parameters:

populationField - Field, otherwise, the default field is . Further to this:

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 the environment is not set, then cell size is the shortest of the width or height of the extent of in_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 the environment is not set, then cell size is the shortest of the width or height of the extent of in_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 the environment is not set, then cell size is the shortest of the width or height of the extent of in_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 is the shortest of the width or height of the extent of in_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 Double, the default is the shortest of the width or height of the extent of in_features in the output spatial reference, divided by 30. This is an optional parameter.

Parameters:

searchRadius - Double, the default is the shortest of the width or height of the extent of in_features in the output spatial reference, divided by 30.

getAreaUnitScaleFactor

public String getAreaUnitScaleFactor()

Returns the Area units parameter of this tool . This parameter is String, 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 String, the default density units based on the input feature units are: This is an optional parameter.

Parameters:

areaUnitScaleFactor - String, 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