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


INeighborhoodOp.Filter Method (ArcObjects .NET 10.5 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > SpatialAnalyst > ESRI.ArcGIS.SpatialAnalyst > Interfaces > IN > INeighborhoodOp Interface > INeighborhoodOp.Filter Method (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (SpatialAnalyst)  

INeighborhoodOp.Filter Method

Performs a preset focal filter on the input.

[Visual Basic .NET]
Public Function Filter ( _
    ByVal geoDataset As IGeoDataset, _
    ByVal Type As esriGeoAnalysisFilterEnum, _
    ByVal ignoreNoData As Boolean _
) As IGeoDataset

[C#]
public IGeoDataset Filter (
    IGeoDataset geoDataset,
    esriGeoAnalysisFilterEnum Type,
    bool ignoreNoData
);

[C++]
HRESULT Filter(
  IGeoDataset* geoDataset,
  esriGeoAnalysisFilterEnum Type,
  VARIANT_BOOL ignoreNoData,
  IGeoDataset** outGeodataset
);

[C++]

Parameters
geoDataset [in]

  geoDataset is a parameter of type IGeoDataset
Type [in]

  Type is a parameter of type esriGeoAnalysisFilterEnum
ignoreNoData [in]
  ignoreNoData is a parameter of type VARIANT_BOOL
outGeodataset [out, retval]

  outGeodataset is a parameter of type IGeoDataset

Product Availability

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

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.

 

See Also

INeighborhoodOp Interface