com.esri.arcgis.spatialanalyst
Interface IGPSANeighborhood

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPSANeighborhood

public interface IGPSANeighborhood
extends Serializable

Provides access to IGPSANeighborhood interface.

Product Availability

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

Method Summary

int	getType() The type of the neighborhood.
int	getTypeOfUnits() The type of units being used.
void	setAnnulus(double innerRadius, double outerRadius, int unitsType) Sets an annulus neighborhood object.
void	setCircle(double radius, int unitsType) Sets a circle neighborhood object.
void	setDefault() Sets a default neighborhood object.
void	setHighPassFilter() Sets a high-pass filter neighborhood of size of 3*3.
void	setIrregular(int height, int width, Object entryValues) Sets a neighborhood object each of whose entries can be turned on or off.
void	setLowPassFilter() Sets a low-pass filter neighborhood of size of 3*3.
void	setRectangle(double width, double height, int unitsType) Sets a rectangle neighborhood object.
void	setWedge(double radius, double startAngle, double endAngle, int unitsType) Sets a wedge neighborhood object.
void	setWeight(int height, int width, Object entryValues) Sets a neighborhood object each of whose entries can be assigned a weight.

Method Detail

getType

int getType()
            throws IOException,
                   AutomationException

The type of the neighborhood.

Product Availability

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

Returns:

A com.esri.arcgis.geoanalyst.esriRasterNeighborhoodEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTypeOfUnits

int getTypeOfUnits()
                   throws IOException,
                          AutomationException

The type of units being used.

Product Availability

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

Returns:

A com.esri.arcgis.geoanalyst.esriGeoAnalysisUnitsEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefault

void setDefault()
                throws IOException,
                       AutomationException

Sets a default neighborhood object.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnnulus

void setAnnulus(double innerRadius,
                double outerRadius,
                int unitsType)
                throws IOException,
                       AutomationException

Sets an annulus neighborhood object.

Product Availability

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

Parameters:

innerRadius - The innerRadius (in)

outerRadius - The outerRadius (in)

unitsType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisUnitsEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCircle

void setCircle(double radius,
               int unitsType)
               throws IOException,
                      AutomationException

Sets a circle neighborhood object.

Product Availability

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

Parameters:

radius - The radius (in)

unitsType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisUnitsEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIrregular

void setIrregular(int height,
                  int width,
                  Object entryValues)
                  throws IOException,
                         AutomationException

Sets a neighborhood object each of whose entries can be turned on or off.

Product Availability

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

Parameters:

height - The height (in)

width - The width (in)

entryValues - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRectangle

void setRectangle(double width,
                  double height,
                  int unitsType)
                  throws IOException,
                         AutomationException

Sets a rectangle neighborhood object.

Product Availability

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

Parameters:

width - The width (in)

height - The height (in)

unitsType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisUnitsEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWedge

void setWedge(double radius,
              double startAngle,
              double endAngle,
              int unitsType)
              throws IOException,
                     AutomationException

Sets a wedge neighborhood object.

Product Availability

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

Parameters:

radius - The radius (in)

startAngle - The startAngle (in)

endAngle - The endAngle (in)

unitsType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisUnitsEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWeight

void setWeight(int height,
               int width,
               Object entryValues)
               throws IOException,
                      AutomationException

Sets a neighborhood object each of whose entries can be assigned a weight.

Product Availability

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

Parameters:

height - The height (in)

width - The width (in)

entryValues - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHighPassFilter

void setHighPassFilter()
                       throws IOException,
                              AutomationException

Sets a high-pass filter neighborhood of size of 3*3.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLowPassFilter

void setLowPassFilter()
                      throws IOException,
                             AutomationException

Sets a low-pass filter neighborhood of size of 3*3.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.