ArcObjects Library Reference (SpatialAnalyst)  

IDensityOp.LineDensity Method

Calculates the simple density of lines in a radius around each output cell. Density is measured as length of lines per unit area.

[Visual Basic .NET]
Public Function LineDensity ( _
    ByVal lineFeatures As IGeoDataset, _
    [ByRef radiusDistance As Object], _
    [ByRef scaleFactor As Object] _
) As IGeoDataset
[C#]
public IGeoDataset LineDensity (
    IGeoDataset lineFeatures,
    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 LineDensity(
  IGeoDataset* lineFeatures,
  VARIANT* radiusDistance,
  VARIANT* scaleFactor,
  IGeoDataset** LineDensity
);
[C++]

Parameters

lineFeatures [in]

  lineFeatures 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.

LineDensity [out, retval]

  LineDensity is a parameter of type IGeoDataset

Product Availability

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

Remarks

lineFeatures

Input polyline featureclass, featureclass descriptor or featureDataset used to calculate the density of lines 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 length of the line is considered to be its actual length times the value of the field for that line.  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