Class ImageFilterCollection

A collection of image filters for image pre-processing.

Inheritance
System.Object
ImageFilterCollection
Namespace: IronBarCode
Assembly: IronBarCode.dll
Syntax
public class ImageFilterCollection : List<IImageFilter>

ImageFilterCollection holds the ordered pipeline of image-correction filters IronBarcode applies to a barcode image before it tries to decode. It is a list of IImageFilter instances, and the order matters: the reader runs the filters from first to last, so a developer arranges them the way the image needs, for example a threshold to binarize, then a sharpen to crisp the edges. This is the object that connects the individual filters to a read.

Build a collection, populate it with filter instances, and assign it to the ImageFilters property of a BarcodeReaderOptions, then pass those options to BarcodeReader.Read. Because the collection derives from List<IImageFilter>, the usual list operations apply for adding, reordering, or removing steps. The CacheAtEachIteration property controls whether the intermediate image is cached after each filter runs, which helps when tuning a pipeline and inspecting the effect of each step. The boolean constructor sets that behavior at creation; the parameterless constructor uses the default.

using IronBarCode;

var options = new BarcodeReaderOptions
{
    ImageFilters = new ImageFilterCollection { new ContrastFilter(2.0f), new SharpenFilter() }
};
var results = BarcodeReader.Read("blurry.png", options);

The image correction how-to shows a populated collection on a sample image, and the imperfect barcode example reads a low-quality barcode through a pipeline.

Constructors

ImageFilterCollection()

Initializes a new instance of the ImageFilterCollection class.

Declaration
public ImageFilterCollection()

ImageFilterCollection(Boolean)

Initializes a new instance of the ImageFilterCollection class with a CacheAtEachIteration toggle.

Declaration
public ImageFilterCollection(bool cacheAtEachIteration)
Parameters
Type Name Description
System.Boolean cacheAtEachIteration

Properties

CacheAtEachIteration

Cache the image with the filters applied in each iteration of the filter applying. Default = true.

Declaration
public bool CacheAtEachIteration { get; set; }
Property Value
Type Description
System.Boolean