Class BinaryThresholdFilter

A filter to binarize an image.

Inheritance
System.Object
BinaryThresholdFilter
Implements
Namespace: IronBarCode
Assembly: IronBarCode.dll
Syntax
public class BinaryThresholdFilter : Object, IImageFilter

Constructors

BinaryThresholdFilter()

Initializes a new instance of the BinaryThresholdFilter class.

Declaration
public BinaryThresholdFilter()

BinaryThresholdFilter(BinarizationMethod)

Initializes a new instance of the BinaryThresholdFilter class with the specified threshold and binarization method to use.

Declaration
public BinaryThresholdFilter(BinarizationMethod binarizationMethod)
Parameters
Type Name Description
BinarizationMethod binarizationMethod

Binarization method to use.

BinaryThresholdFilter(Color, Color, Single)

Initializes a new instance of the BinaryThresholdFilter class with the specified upper and lower colors, and threshold.

Declaration
public BinaryThresholdFilter(Color upper, Color lower, float threshold)
Parameters
Type Name Description
IronSoftware.Drawing.Color upper

The color to use for pixels that are above the threshold.
IronSoftware.Drawing.Color lower

The color to use for pixels that are below the threshold.
System.Single threshold

Threshold limit (0.0-1.0) to consider for binarization.

BinaryThresholdFilter(Color, Color, Single, BinarizationMethod)

Initializes a new instance of the BinaryThresholdFilter class with the specified upper and lower colors, threshold, and binarization method.

Declaration
public BinaryThresholdFilter(Color upper, Color lower, float threshold, BinarizationMethod binarizationMethod)
Parameters
Type Name Description
IronSoftware.Drawing.Color upper

The color to use for pixels that are above the threshold.
IronSoftware.Drawing.Color lower

The color to use for pixels that are below the threshold.
System.Single threshold

Threshold limit (0.0-1.0) to consider for binarization.
BinarizationMethod binarizationMethod

Binarization method to use.

BinaryThresholdFilter(Color, Color, Single, Rectangle)

Initializes a new instance of the BinaryThresholdFilter class with the specified Upper, Lower, Threshold and Rectangle.

Declaration
public BinaryThresholdFilter(Color upper, Color lower, float threshold, Rectangle rectangle)
Parameters
Type Name Description
IronSoftware.Drawing.Color upper

The color to use for pixels that are above the threshold.
IronSoftware.Drawing.Color lower

The color to use for pixels that are below the threshold.
System.Single threshold

Threshold limit (0.0-1.0) to consider for binarization.
IronSoftware.Drawing.Rectangle rectangle

Rectangle region to apply the filter on.

BinaryThresholdFilter(Color, Color, Single, Rectangle, BinarizationMethod)

Initializes a new instance of the BinaryThresholdFilter class with the specified upper and lower colors, threshold, rectangle, and binarization method.

Declaration
public BinaryThresholdFilter(Color upper, Color lower, float threshold, Rectangle rectangle, BinarizationMethod binarizationMethod)
Parameters
Type Name Description
IronSoftware.Drawing.Color upper

The color to use for pixels that are above the threshold.
IronSoftware.Drawing.Color lower

The color to use for pixels that are below the threshold.
System.Single threshold

Threshold limit (0.0-1.0) to consider for binarization.
IronSoftware.Drawing.Rectangle rectangle

Rectangle region to apply the filter on.
BinarizationMethod binarizationMethod

Binarization method to use.

BinaryThresholdFilter(Single)

Initializes a new instance of the BinaryThresholdFilter class with the specified threshold.

Declaration
public BinaryThresholdFilter(float threshold)
Parameters
Type Name Description
System.Single threshold

Threshold to apply for binarization. Must be between [0.0-1.0].

BinaryThresholdFilter(Single, BinarizationMethod)

Initializes a new instance of the BinaryThresholdFilter class with the specified threshold and binarization.

Declaration
public BinaryThresholdFilter(float threshold, BinarizationMethod binarizationMethod)
Parameters
Type Name Description
System.Single threshold

Threshold to apply for binarization. Must be between [0.0-1.0].
BinarizationMethod binarizationMethod

Binarization method to use.

Properties

BinarizationMethod

Binarization method to use. Default = Otsu's Method.

Declaration
public BinarizationMethod BinarizationMethod { get; set; }
Property Value
Type Description
BinarizationMethod

Lower

The color to use for pixels that are below the threshold.

Declaration
public Color Lower { get; set; }
Property Value
Type Description
IronSoftware.Drawing.Color

Rectangle

Rectangle region to apply the filter on.

Declaration
public Rectangle Rectangle { get; set; }
Property Value
Type Description
IronSoftware.Drawing.Rectangle

Threshold

The threshold to apply binarization of the image. Must be between [0.0-1.0]. Default = 0.4. With Otsu's method, this value is not used.

Declaration
public float Threshold { get; set; }
Property Value
Type Description
System.Single

Upper

The color to use for pixels that are above the threshold.

Declaration
public Color Upper { get; set; }
Property Value
Type Description
IronSoftware.Drawing.Color

Implements