Accusoft.ScanFixXpressSdk Namespace > ScanFix Class > RegisterImage Method : RegisterImage(ImageRegistrationOptions) Method |
'Declaration <DebuggerStepThroughAttribute()> <DebuggerNonUserCodeAttribute()> 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)
[DebuggerStepThrough()] [DebuggerNonUserCode()] public ImageRegistrationResults RegisterImage( ImageRegistrationOptions options )
[DebuggerStepThrough()] [DebuggerNonUserCode()] public: ImageRegistrationResults* RegisterImage( ImageRegistrationOptions* options )
[DebuggerStepThrough()] [DebuggerNonUserCode()] public: ImageRegistrationResults^ RegisterImage( ImageRegistrationOptions^ options )
Exception | Description |
---|---|
System.ArgumentNullException | Thrown when required argument value is null. |
System.ArgumentOutOfRangeException | Thrown when argument is out of range. |
ScanFixUnsupportedImageException | Thrown when image type is unsupported. |
ScanFixException | Thrown when operation failed. |
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.