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


IRasterNeighborhood.SetCircle Method (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (GeoAnalyst)  

IRasterNeighborhood.SetCircle Method

Sets a circle neighborhood object.

[Visual Basic .NET]
Public Sub SetCircle ( _
    ByVal radius As Double, _
    ByVal unitsType As esriGeoAnalysisUnitsEnum _
)

[C#]
public void SetCircle (
    double radius,
    esriGeoAnalysisUnitsEnum unitsType
);

[C++]
HRESULT SetCircle(
  double radius,
  esriGeoAnalysisUnitsEnum unitsType
);

[C++]

Parameters
radius [in]

  radius is a parameter of type double
unitsType [in]

  unitsType is a parameter of type esriGeoAnalysisUnitsEnum

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Remarks

radius

Specifies the radius from the center of the processing cell that the circle neighborhood will span. 

unitsType

An esriGeoAnalysisUnitsEnum defining the type of units to calculate the neighborhood.
The enumeration types are:

esriUnitsMap  - neghbourhood is identified by map units (i.e., meters, feet) 
esriUnitsCells - neighbourhood is identified by number of cells

 

The size of the circle depends on the specified radius. The radius is identified in cells or map units, measured perpendicular to the x- or y-axis.  Any cell center encompassed by the circle will be included in the processing of the neighborhood.

See Also

IRasterNeighborhood Interface