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


BackgroundFilter Class (ArcObjects .NET 10.8 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > DataSourcesRaster > ESRI.ArcGIS.DataSourcesRaster > Classes > B > BackgroundFilter Class
ArcGIS Developer Help

BackgroundFilterClass Class

A raster background filter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Description

The BackgroundFilter is a pixel filter that trims left and right pixels with a given background value (by setting them to NoData), until the first non background pixel is encountered. This pixel filter works the best when the pixel block spans the entire scan line. It can be used to implement the background functionality in ArcSDE command line command SDERASTER.

To filter multiple background values, multiple filters can be stacked into a PixelFilterCollection.

 

Supported Platforms

Windows, Solaris, Linux

Interfaces

Interfaces Description
IBackgroundFilter Provides access to members that control a background filter.
IPixelFilter Provides access to members that control a pixel filter.

Remarks


The BackgroundFilter sets boundary pixels to NoData.

See Also

IBackgroundFilter Interface | IPixelFilter Interface