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


IRasterNeighborhood.SetAnnulus Method (ArcObjects .NET 10.4 SDK)
ArcObjects namespaces > GeoAnalyst > ESRI.ArcGIS.GeoAnalyst > Interfaces > IR > IRasterNeighborhood Interface > IRasterNeighborhood.SetAnnulus Method (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (GeoAnalyst)  

IRasterNeighborhood.SetAnnulus Method

Sets an annulus neighborhood object.

[Visual Basic .NET]
Public Sub SetAnnulus ( _
    ByVal innerRadius As Double, _
    ByVal outerRadius As Double, _
    ByVal unitsType As esriGeoAnalysisUnitsEnum _
)

[C#]
public void SetAnnulus (
    double innerRadius,
    double outerRadius,
    esriGeoAnalysisUnitsEnum unitsType
);

[C++]
HRESULT SetAnnulus(
  double innerRadius,
  double outerRadius,
  esriGeoAnalysisUnitsEnum unitsType
);

[C++]

Parameters
innerRadius [in]
  innerRadius is a parameter of type double
outerRadius [in]
  outerRadius 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

innerRadius

specifies the radius of the inner circle of the annulus from the center of the processing cell.

outerRadius

specifies the radius of the outer circle of the annulus neighborhood from the center of the processing cell.  The outer circle defines the extent of the neighboorhood.

unitsType

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

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

 

The annulus shape comprises one smaller circle within a larger circle (a donut shape). Cells that fall outside the radius of the smaller circle but inside the radius of the larger circle will be included in the processing of the neighborhood.

 

See Also

IRasterNeighborhood Interface