RemoveBorder(BorderRemovalOptions) Method

Locates border pixels and will replace them with the specified pad color and/or remove the pixels from the image. Optionally, it can also deskew the image based on the angle of the detected border.

Syntax

[DebuggerNonUserCode()]
[DebuggerStepThrough()]
public BorderRemovalResults RemoveBorder( 
   BorderRemovalOptions options
)

[DebuggerNonUserCode()]
[DebuggerStepThrough()]
public: BorderRemovalResults* RemoveBorder( 
   BorderRemovalOptions* options
)

[DebuggerNonUserCode()]
[DebuggerStepThrough()]
public:
BorderRemovalResults^ RemoveBorder( 
   BorderRemovalOptions^ options
)

'Declaration
 
<DebuggerNonUserCodeAttribute()>
<DebuggerStepThroughAttribute()>
Public Overloads Function RemoveBorder( _
   ByVal options As BorderRemovalOptions _
) As BorderRemovalResults

'Usage
 
Dim instance As ScanFix
Dim options As BorderRemovalOptions
Dim value As BorderRemovalResults
 
value = instance.RemoveBorder(options)

Parameters

options: An object containing parameters that control the enhancement process.

Return Value

A BorderRemovalResults object containing information about the results of the border removal process.

Exceptions

Exception	Description
System.ArgumentNullException	Thrown when required argument value is null.
System.ArgumentOutOfRangeException	Thrown when argument is out of range.
System.ComponentModel.InvalidEnumArgumentException	Thrown when argument enum value is invalid.
ScanFixUnsupportedImageException	Thrown when image type is unsupported.
ScanFixException	Thrown when operation failed.

Remarks

Note: Use this function if you wish to modify the parameters controlling the enhancement.

When to use border removal and what results to expect:

Border removal attempts to find "border-like" characteristics of an image. On images that it finds no suitable borders, or multiple suitable borders, a low confidence will likely to be returned. Border removal in most cases tolerates white specks in the border and black specks in the page unless the specks account for a susbstantial portion, say more than 25%, of all the pixels in a large area. Thick black or white streaks on images may cause reduced accuracy for border removal, as they resemble nice, straight edges. Irregular borders, such as the ones with white areas in the border, may cause some portions of the border to be left on the image.

Reference

ScanFix Class
ScanFix Members
Overload List