ScanFix Xpress v9.0 for .NET - Updated
RegisterImage(ImageRegistrationOptions) Method




Accusoft.ScanFixXpressSdk Namespace > ScanFix Class > RegisterImage Method : RegisterImage(ImageRegistrationOptions) Method
An object containing parameters that control the enhancement process.
Automatically positions text horizontally and vertically in the current image, providing a consistent left and top margin for documents. Use this function if you wish to modify the parameters controlling the enhancement.
Syntax
'Declaration
 
Public Overloads Function RegisterImage( _
   ByVal options As ImageRegistrationOptions _
) As ImageRegistrationResults
'Usage
 
Dim instance As ScanFix
Dim options As ImageRegistrationOptions
Dim value As ImageRegistrationResults
 
value = instance.RegisterImage(options)

Parameters

options
An object containing parameters that control the enhancement process.

Return Value

A ImageRegistrationResults object containing information about the results of the image registration process.
Exceptions
ExceptionDescription
Thrown when required argument value is null.
Thrown when argument is out of range.
Thrown when image type is unsupported.
Thrown when operation failed.
Remarks

Registration is helpful for Document Imaging and Forms Processing applications where accurate positioning is critical, since it makes OCR zoning of text fields in forms much more reliable.

For horizontal registration, the leftmost edge of the text is located, and positioned a fixed distance from the left edge of the image. For vertical registration, the topmost edge of the text is located, and positioned a fixed distance from the top edge of the image.

Note: When Registration adds pixels to the image, the added pixels are always white.

With this overloaded method, you can activate and set the parameters for Horizontal and Vertical Registration separately. For most operations where you require a consistent left margin, you should activate Horizontal Registration. In many cases, you can leave Vertical Registration deactivated. For applications where precise text location is important, both Horizontal and Vertical Registration should be activated.

Note: When using RegisterImage, we recommend that you first Deskew the image, unless you know the original is perfectly straight.

See Also

Reference

ScanFix Class
ScanFix Members
Overload List

Is this page helpful?
Yes No
Thanks for your feedback.