com.esri.arcgis.spatialanalyst
Interface INeighborhoodOp

All Superinterfaces:
Serializable
All Known Implementing Classes:
RasterNeighborhoodOp

public interface INeighborhoodOp
extends Serializable

Provides access to members that control the neighborhood operations.

Remarks

  • Read the Working with ArcGIS Spatial Analyst objects technical document for general information on implementing Spatial Analyst operations.
  • Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux


    Method Summary
     IGeoDataset blockStatistics(IGeoDataset geoDataset, int type, IRasterNeighborhood nbrhood, boolean ignoreNoData)
              Calculates statistics for a non-overlapping 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

    blockStatistics

    IGeoDataset blockStatistics(IGeoDataset geoDataset,
                                int type,
                                IRasterNeighborhood nbrhood,
                                boolean ignoreNoData)
                                throws IOException,
                                       AutomationException
    Calculates statistics for a non-overlapping neighborhood.

    Remarks

    geoDataset an input integer or floating-point 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 3-x 3-rectangle.

    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 minimum-bounding rectangle of the specified neighborhood. The minimum-bounding 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.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    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)
    Returns:
    A reference to a com.esri.arcgis.geodatabase.IGeoDataset
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    filter

    IGeoDataset filter(IGeoDataset geoDataset,
                       int type,
                       boolean ignoreNoData)
                       throws IOException,
                              AutomationException
    Performs a preset focal filter on the input.

    Remarks

    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 low-pass 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 high-pass 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.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
    type - A com.esri.arcgis.geoanalyst.esriGeoAnalysisFilterEnum constant (in)
    ignoreNoData - The ignoreNoData (in)
    Returns:
    A reference to a com.esri.arcgis.geodatabase.IGeoDataset
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    focalStatistics

    IGeoDataset focalStatistics(IGeoDataset geoDataset,
                                int type,
                                IRasterNeighborhood nbrhood,
                                boolean ignoreNoData)
                                throws IOException,
                                       AutomationException
    Calculates statistics for an overlapping neighborhood.

    Remarks

    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:

    esriGeoAnalysisStatsMajority                Majority
    
    esriGeoAnalysisStatsMaximum             Maximum                 
    
    esriGeoAnalysisStatsMean                Mean
    
    esriGeoAnalysisStatsMedian              Median
    
    esriGeoAnalysisStatsMinimum             Minimum
    
    esriGeoAnalysisStatsMinority            Minority
    
    esriGeoAnalysisStatsRange               Range
    
    esriGeoAnalysisStatsStd                 Standard Deviation
    
    EsriGeoAnalysisStatsSum                 Sum                             
    
    esriGeoAnalysisStatsVariety             Variety
    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 minimum-bounding rectangle of the specified neighborhood. The minimum-bounding 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.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    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)
    Returns:
    A reference to a com.esri.arcgis.geodatabase.IGeoDataset
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    focalFlow

    IGeoDataset focalFlow(IGeoDataset geoDataset,
                          Object thresholdValue)
                          throws IOException,
                                 AutomationException
    Calculates the flow of the values in the surface within each cells immediate neighborhood.

    Remarks

    geoDataset

    an input integer or floating-point 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.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
    thresholdValue - A Variant (in, optional, pass null if not required)
    Returns:
    A reference to a com.esri.arcgis.geodatabase.IGeoDataset
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    pointStatistics

    IGeoDataset pointStatistics(IGeoDataset pointDataset,
                                int type,
                                IRasterNeighborhood nbrhood)
                                throws IOException,
                                       AutomationException
    Calculates a statistic on the points in a neighborhood around each output cell.

    Remarks

    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 minimum-bounding rectangle of the specified neighborhood. The minimum-bounding rectangle will include more cells then the specified neighborhood in certain cases such as with a circle, annulus, and wedge.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    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)
    Returns:
    A reference to a com.esri.arcgis.geodatabase.IGeoDataset
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.

    lineStatistics

    IGeoDataset lineStatistics(IGeoDataset lineDataset,
                               int type,
                               double radius)
                               throws IOException,
                                      AutomationException
    Calculates a statistic on the attributes of lines in a circular neighborhood around each output cell.

    Remarks

    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.

    Product Availability

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

    Supported Platforms

    Windows, Solaris, Linux

    Parameters:
    lineDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
    type - A com.esri.arcgis.geoanalyst.esriGeoAnalysisStatisticsEnum constant (in)
    radius - The radius (in)
    Returns:
    A reference to a com.esri.arcgis.geodatabase.IGeoDataset
    Throws:
    IOException - If there are interop problems.
    AutomationException - If the ArcObject component throws an exception.