This document is archived and information here might be outdated.  Recommended version.


IDensityOp.KernelDensity Method (ArcObjects .NET 10.5 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > SpatialAnalyst > ESRI.ArcGIS.SpatialAnalyst > Interfaces > ID > IDensityOp Interface > IDensityOp.KernelDensity Method (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (SpatialAnalyst)  

IDensityOp.KernelDensity Method

Calculates the kernel density of points or lines in a radius around each output cell. A kernel function is used to distribute density values around each point or line.

[Visual Basic .NET]
Public Function KernelDensity ( _
    ByVal sourceFeatures As IGeoDataset, _
    [ByRef radiusDistance As Object], _
    [ByRef scaleFactor As Object] _
) As IGeoDataset

[C#]
public IGeoDataset KernelDensity (
    IGeoDataset sourceFeatures,
    ref object radiusDistance,
    ref object scaleFactor
);
[C#]

Optional Values

radiusDistance   To indicate that this parameter is undefined, first define a variable object Missing=Type.Missing; then pass this in as ref Missing.
scaleFactor   To indicate that this parameter is undefined, first define a variable object Missing=Type.Missing; then pass this in as ref Missing. 
[C++]
HRESULT KernelDensity(
  IGeoDataset* sourceFeatures,
  VARIANT* radiusDistance,
  VARIANT* scaleFactor,
  IGeoDataset** KernelDensity
);

[C++]

Parameters
sourceFeatures [in]

  sourceFeatures is a parameter of type IGeoDataset
radiusDistance [optional]
  radiusDistance is a parameter of type VARIANT

  To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.
scaleFactor [optional]
  scaleFactor is a parameter of type VARIANT

  To indicate this parameter is undefined pass a reference to a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.
KernelDensity [out, retval]

  KernelDensity is a parameter of type IGeoDataset

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Remarks

pointFeatures

Input point featureclass, featureclass descriptor or featureDataset used to calculate the density of point features around each output cell.

For density functions, SPOT is the default field used when no field has been specified. If a SPOT field does not exist, then no field will be used, and each feature will be counted only once in the calculation. This is similar to specifying a keyword for the field of "NONE". If a field other than NONE is used, the field's value (the item value) determines the number of times to count the point. To specify the field use the FeatureClassDescriptor object.

[radiusDistance]

A circular neighborhood with the given radius. The default radius is calculated so that all cells in the output grid have at least one point within the neighborhood.

[scaleFactor]

Used to convert the map units of the input dataset to different units. The default value is 1, which calculates density in units of number of points per one square map unit. Effectively, output raster values are multiplied by the square of this factor.

 

See Also

IDensityOp Interface