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.
Usage tips:
- Larger values of the search radius parameter produce a smoother, more generalized density raster. Smaller values produce a raster that shows more detail.
- 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.
- 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).
Constructor Summary |
KernelDensity()
Creates the Kernel Density tool with defaults. |
KernelDensity(java.lang.Object inFeatures,
java.lang.Object populationField,
java.lang.Object outRaster)
Creates the Kernel Density tool with the required parameters. |
Method Summary |
java.lang.String |
getAreaUnitScaleFactor()
Returns the Area units parameter of this tool . |
java.lang.Object |
getCellSize()
Returns the Output cell size parameter of this tool . |
java.lang.Object |
getInFeatures()
Returns the Input point or polyline features parameter of this tool . |
java.lang.Object |
getOutRaster()
Returns the Output raster parameter of this tool . |
java.lang.Object |
getPopulationField()
Returns the Population field parameter of this tool . |
double |
getSearchRadius()
Returns the Search radius parameter of this tool . |
java.lang.String |
getToolboxAlias()
Returns the alias of the tool box containing this tool. |
java.lang.String |
getToolboxName()
Returns the name of the tool box containing this tool. |
java.lang.String |
getToolName()
Returns the name of this tool. |
void |
setAreaUnitScaleFactor(java.lang.String areaUnitScaleFactor)
Sets the Area units parameter of this tool . |
void |
setCellSize(java.lang.Object cellSize)
Sets the Output cell size parameter of this tool . |
void |
setInFeatures(java.lang.Object inFeatures)
Sets the Input point or polyline features parameter of this tool . |
void |
setOutRaster(java.lang.Object outRaster)
Sets the Output raster parameter of this tool . |
void |
setPopulationField(java.lang.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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
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(java.lang.Object inFeatures,
java.lang.Object populationField,
java.lang.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
- the input features (point or line) for which to calculate the density.populationField
- field denoting population values for each feature. The Population
field is the count or quantity to be spread across the landscape to
create a continuous surface. 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 kernel density raster. it is always a floating point raster.
getInFeatures
public java.lang.Object getInFeatures()
- Returns the Input point or polyline features parameter of this tool .
This parameter is the input features (point or line) for which to calculate the density.
This is a required parameter.
- Returns:
- the Input point or polyline features
setInFeatures
public void setInFeatures(java.lang.Object inFeatures)
- Sets the Input point or polyline features parameter of this tool .
This parameter is the input features (point or line) for which to calculate the density.
This is a required parameter.
- Parameters:
inFeatures
- the input features (point or line) for which to calculate the density.
getPopulationField
public java.lang.Object getPopulationField()
- Returns the Population field parameter of this tool .
This parameter is field denoting population values for each feature. The Population
field is the count or quantity to be spread across the landscape to
create a continuous surface. 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(java.lang.Object populationField)
- Sets the Population field parameter of this tool .
This parameter is field denoting population values for each feature. The Population
field is the count or quantity to be spread across the landscape to
create a continuous surface. 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
- field denoting population values for each feature. The Population
field is the count or quantity to be spread across the landscape to
create a continuous surface. 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 java.lang.Object getOutRaster()
- Returns the Output raster parameter of this tool .
This parameter is the output kernel density raster. it is always a floating point raster.
This is a required parameter.
- Returns:
- the Output raster
setOutRaster
public void setOutRaster(java.lang.Object outRaster)
- Sets the Output raster parameter of this tool .
This parameter is the output kernel density raster. it is always a floating point raster.
This is a required parameter.
- Parameters:
outRaster
- the output kernel density raster. it is always a floating point raster.
getCellSize
public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String getToolName()
- Returns the name of this tool.
- Returns:
- the tool name
getToolboxName
public java.lang.String getToolboxName()
- Returns the name of the tool box containing this tool.
- Returns:
- the tool box name
getToolboxAlias
public java.lang.String getToolboxAlias()
- Returns the alias of the tool box containing this tool.
- Returns:
- the tool box alias