

PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 
public interface INeighborhoodOp
Provides access to members that control the neighborhood operations.
Method Summary  

IGeoDataset 
blockStatistics(IGeoDataset geoDataset,
int type,
IRasterNeighborhood nbrhood,
boolean ignoreNoData)
Calculates statistics for a nonoverlapping neighborhood. 
IGeoDataset 
filter(IGeoDataset geoDataset,
int type,
boolean ignoreNoData)
Performs a preset focal filter on the input. 
IGeoDataset 
focalFlow(IGeoDataset geoDataset,
Object thresholdValue)
Calculates the flow of the values in the surface within each cells immediate neighborhood. 
IGeoDataset 
focalStatistics(IGeoDataset geoDataset,
int type,
IRasterNeighborhood nbrhood,
boolean ignoreNoData)
Calculates statistics for an overlapping neighborhood. 
IGeoDataset 
lineStatistics(IGeoDataset lineDataset,
int type,
double radius)
Calculates a statistic on the attributes of lines in a circular neighborhood around each output cell. 
IGeoDataset 
pointStatistics(IGeoDataset pointDataset,
int type,
IRasterNeighborhood nbrhood)
Calculates a statistic on the points in a neighborhood around each output cell. 
Method Detail 

IGeoDataset blockStatistics(IGeoDataset geoDataset, int type, IRasterNeighborhood nbrhood, boolean ignoreNoData) throws IOException, AutomationException
geoDataset  an input integer or floatingpoint
Raster, RasterDataset, RasterBand, or RasterDescriptor that
identifies the values of the cells in a specified neighborhood
If no neighborhood is specified, the default neighborhood is a 3x 3rectangle. 
type  an esriGeoAnalysisStatisticsEnum
defining the block statitistic to calculate within each block
The enumeration types are: esriGeoAnalysisStatsMajority for the majority value, esriGeoAnalysisStatsMaximum for the maximum value, esriGeoAnalysisStatsMean for the mean, esriGeoAnalysisStatsMedian for the median, esriGeoAnalysisStatsMinimum for the minimum value, esriGeoAnalysisStatsMinority for the minority value, esriGeoAnalysisStatsRange for the range of values, esriGeoAnalysisStatsStd for the standard deviation, esriGeoAnalysisStatsSum for the sum of the values, or esriGeoAnalysisStatsVariety for the variety of the values. 
nbrhood  an IRasterNeighborhood defining the
configuration of the blocks within which the block statistics will
be calculated
INeighborhood::BlockStatistics supports any neighborhood supported by IRasterNeighborhood. They include a rectangle, circle, annulus, wedge, and an irregular shaped neighborhood. The block will be defined by the minimumbounding rectangle of the specified neighborhood. The minimumbounding rectangle will include more cells then the specified neighborhood in certain cases such as with a circle, annulus, and wedge. 
ignoreNoData  a Boolean defining the manner in which
NoData values within a neighborhood will influence the output
results
If True, then if a NoData value exists within a neighborhood, then the NoData value will be ignored. Only cells within the neighborhood that have data values will be used in determining the statistics of the values. If False, then if any cell in a neighborhood has a value of NoData, then the output for each cell in the corresponding block will receive NoData. When the Boolean is False, the presence of a NoData value implies that there is insufficient information to determine the statistics of the values of the neighborhood. 
geoDataset
 A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)type
 A com.esri.arcgis.geoanalyst.esriGeoAnalysisStatisticsEnum constant (in)nbrhood
 A reference to a com.esri.arcgis.geoanalyst.IRasterNeighborhood (in)ignoreNoData
 The ignoreNoData (in)
IOException
 If there are interop problems.
AutomationException
 If the ArcObject component throws an exception.IGeoDataset filter(IGeoDataset geoDataset, int type, boolean ignoreNoData) throws IOException, AutomationException
geoDataset 
the input Raster, RasterDataset, RasterBand, or RasterDescriptor 
Type 
the esriGeoAnalysisFilterEnum constant whose value represents the filter type to perform. It can be of type esriGeoAnalysisFilter3x3LowPass  Traverses a lowpass filter over the raster. This option smoothes the entire input and reduces the significance of anomalous cells. This is the default option. estiGeoAnalysisFilter3x3HighPass  Traverses a highpass filter over the raster. This option enhances the edges of subdued features in a raster. 
ignoreNoDatat 
a Boolean specifying where NODATA values are ignored by the filter calculation If TRUE, when a NoData value exists within the filter, then the NoData value will be ignored. Only cells within the filter that have data values will be used in determining the output. If FALSE, when a NoData value exists within the filter, then the output for the processing cell will be NoData. 
geoDataset
 A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)type
 A com.esri.arcgis.geoanalyst.esriGeoAnalysisFilterEnum constant (in)ignoreNoData
 The ignoreNoData (in)
IOException
 If there are interop problems.
AutomationException
 If the ArcObject component throws an exception.IGeoDataset focalStatistics(IGeoDataset geoDataset, int type, IRasterNeighborhood nbrhood, boolean ignoreNoData) throws IOException, AutomationException
geoDataset  an input Raster, RasterDataset, RasterBand, or RasterDescriptor that identifies the values of the focal or processing cell and the values of the cells in its specified neighborhood 
type  an esriGeoAnalysisStatisticsEnum
defining the focal statistic to calculate within each neighborhood
The enumeration types are:

nbrhood  an RasterNeighborhood defining the
configuration of the neighborhoods within which the focal
statistics will be calculated
INeighborhoodOp::FocalStatistics supports any neighborhood supported by IRasterNeighborhood. They include a rectangle, circle, annulus, wedge, and an irregular shaped neighborhood. The neighborhood will be defined by the minimumbounding rectangle of the specified neighborhood. The minimumbounding rectangle will include more cells than the specified neighborhood in certain cases such as with a circle, annulus, and wedge. 
ignoreNoData  a Boolean defining the manner in which
NoData values within a neighborhood will influence the output
results
If True, then if a NoData value exists within the neighborhood of the processing cell, then the NoData value will be ignored. Only cells within the neighborhood that have data values will be used in determining the statistic. If False, then if any cell in a neighborhood has a value of NoData, then the output for the processing cell of the neighborhood will be NoData. When False, the presence of a NoData value implies that there is insufficient information to determine the statistic of the values of the neighborhood. 
geoDataset
 A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)type
 A com.esri.arcgis.geoanalyst.esriGeoAnalysisStatisticsEnum constant (in)nbrhood
 A reference to a com.esri.arcgis.geoanalyst.IRasterNeighborhood (in)ignoreNoData
 The ignoreNoData (in)
IOException
 If there are interop problems.
AutomationException
 If the ArcObject component throws an exception.IGeoDataset focalFlow(IGeoDataset geoDataset, Object thresholdValue) throws IOException, AutomationException
geoDataset 
an input integer or floatingpoint grid that identifies the values of the focal or processing cell and the values of the cells in its specified neighborhood INeighborhood::FocalFlow evaluates the eight immediate neighbors of a cell to determine flow. 
[thresholdValue] 
defines a value that constitutes the threshold, which must be equalled or exceeded before flow can occur If the difference between the value at a neighboring cell location and the value of the processing cell is less than or equal to the threshold value, the output will be ‘0’ (or no flow). The data type for thresholdValue can be either integer or floating point. 
geoDataset
 A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)thresholdValue
 A Variant (in, optional, pass null if not required)
IOException
 If there are interop problems.
AutomationException
 If the ArcObject component throws an exception.IGeoDataset pointStatistics(IGeoDataset pointDataset, int type, IRasterNeighborhood nbrhood) throws IOException, AutomationException
pointDataset 
input FeatureClass or FeatureClassDescriptor containing point features 
type 
an esriGeoAnalysisStatisticsEnum to determine which statistic will be calculated on the values of points in the neighborhood of each output Raster cell The enumeration types are: esriGeoAnalysisStatsMajority for the majority value, esriGeoAnalysisStatsMaximum for the maximum value, esriGeoAnalysisStatsMean for the mean, esriGeoAnalysisStatsMedian for the median, esriGeoAnalysisStatsMinimum for the minimum value, esriGeoAnalysisStatsMinority for the minority value, esriGeoAnalysisStatsRange for the range of values, esriGeoAnalysisStatsStd for the standard deviation, esriGeoAnalysisStatsSum for the sum of the values, or esriGeoAnalysisStatsVariety for the variety of the values. 
nbrhood 
an IRasterNeighborhood defining the configuration of the neighborhoods within which the point statistics will be calculated INeighborhood::PointStatistics supports any neighborhood supported by IRasterNeighborhood. They include a rectangle, circle, annulus, wedge, and an irregular shaped neighborhood. The neighborhood will be defined by the minimumbounding rectangle of the specified neighborhood. The minimumbounding rectangle will include more cells then the specified neighborhood in certain cases such as with a circle, annulus, and wedge. 
pointDataset
 A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)type
 A com.esri.arcgis.geoanalyst.esriGeoAnalysisStatisticsEnum constant (in)nbrhood
 A reference to a com.esri.arcgis.geoanalyst.IRasterNeighborhood (in)
IOException
 If there are interop problems.
AutomationException
 If the ArcObject component throws an exception.IGeoDataset lineStatistics(IGeoDataset lineDataset, int type, double radius) throws IOException, AutomationException
lineDataset 
input FeatureClass or FeatureClassDescriptor containing line features 
type 
an esriGeoAnalysisStatisticsEnum indicating which statistic will be calculated for all lines in the neighborhood Enumeration types are: esriGeoAnalysisStatsMajority for the majority value, esriGeoAnalysisStatsMaximum for the maximum value, esriGeoAnalysisStatsMean for the mean, esriGeoAnalysisStatsMedian for the median, esriGeoAnalysisStatsMinimum for the minimum value, esriGeoAnalysisStatsMinority for the minority value, esriGeoAnalysisStatsRange for the range of values, esriGeoAnalysisStatsStd for the standard deviation, esriGeoAnalysisStatsSum for the sum of the values, or esriGeoAnalysisStatsVariety for the variety of the values. 
radius 
the radius of the circular neighborhood around each output grid cell, expressed in map units A commonly used radius is 5 times the output cell size. 
lineDataset
 A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)type
 A com.esri.arcgis.geoanalyst.esriGeoAnalysisStatisticsEnum constant (in)radius
 The radius (in)
IOException
 If there are interop problems.
AutomationException
 If the ArcObject component throws an exception.


PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 