Accusoft.FormFixSdk Namespace > RegistrationProcessor Class : RegisterToImage Method |
'Declaration Public Function RegisterToImage( _ ByVal imageToRegister As FormImage, _ ByVal modelImage As FormImage _ ) As RegistrationResult
'Usage Dim instance As RegistrationProcessor Dim imageToRegister As FormImage Dim modelImage As FormImage Dim value As RegistrationResult value = instance.RegisterToImage(imageToRegister, modelImage)
public RegistrationResult RegisterToImage( FormImage imageToRegister, FormImage modelImage )
public: RegistrationResult* RegisterToImage( FormImage* imageToRegister, FormImage* modelImage )
public: RegistrationResult^ RegisterToImage( FormImage^ imageToRegister, FormImage^ modelImage )
This method compares two images and attempts to register them using special registration marks.
Each of the four marks must be shaped like an "L", with the corner of the mark pointing toward the corner of the image. The straight parts of the mark must be parallel to the edges of the image. Each of the straight parts of the mark should be between 1/6 and 1/2 inch long and up to 1/12 inch thick. The marks must be less than two inches from the corner of each image.
If your images (either modelImage or imageToRegister) could be skewed, you should use Accusoft's ScanFix or ImagXpress component to deskew them prior to using this function.
This method will not throw an exception if it is unable to register the images. Instead, it will set RegistrationResult.State to RegistrationState.Failure.
By default, this method will not modify the imageToRegister argument.
If the AutoAlign property is set to true and if the registration process is successful, as indicated by the RegistrationResult.State, then this method will align the imageToRegister with the modelImage. Otherwise, the imageToRegister will not be modified.