eVRS command string modules

This topic contains information on eVRS settings and property strings that can be used in the TotalAgility Scan/VRS profile (on the Advanced tab of the extended properties).

Most of the eVRS image processing settings are unavailable by default, but appropriate keywords included in the operations string enable the corresponding settings. In the operations string, a leading "_" character indicates the start of a new keyword or parameter. The trailing "_" character may be followed by a setting value: a string in <> or one or more numeric values.

The following table describes the eVRS strings.

Keyword	eVRS String	Description
DO_HEALTH_ANALYSIS	_DoHealthAnalysis_	Activates scanner health analysis.
DO_HOLE_FILL	_DoHoleFill	Fills punch holes on document edges to match the surrounding page background. Performed for dark backgrounds only.
DO_BLANK_PAGE_DETECTION	_DoBlankPageDetection_	Detects if the page is blank so that it could be deleted by the application. It can ignore punch holes. In Duplex mode, it can ignore bleed-through from the opposite side. If EVRS cannot detect the page boundaries within the input image, it is not possible to detect either the presence or the absence of any content within it.
DO_COLOR_DETECTION	_DoColorDetection_	Limits binarization to only those pages that do not contain any color.
DO_COLOR_DROPOUT	_DoColorDropOut_	Activates detection and removal of the most common foreground color within the page.
DO_SKEW_CORRECTION_PAGE	_DoSkewCorrectionPage_	Deskews to page.
DO_SKEW_CORRECTION_ALT	_DoSkewCorrectionAlt_	Deskews to content.
DO_CROP_CORRECTION	_DoCropCorrection_	Crops to minimize the bounding box around the final position of the page after deskewing.
DO_NO_PAGE_DETECTION	_DoNoPageDetection_	Informs EVRS that the incoming image has been already deskewed and cropped, so no page detection is necessary.
DO_BINARIZATION	_DoBinarization_	Converts the image to binary.
DO_SCALE_IMAGE_TO_DPI	_DoScaleImageToDPI_n	Doubles the resulting image DPI to the DPI specified in the eVRS string when used with enhanced binarization (DO_ENHANCED_BINARIZATION). Here n = Desired DPI of processed image. The bit depth-specific scaling keywords such as DoScaleCGImageToDPI (color or grayscale), DoScaleBWImageToDPI (Black and white) are preferred, as they do not have this doubling effect when combined with enhanced binarization.
DO_ENHANCED_BINARIZATION	_DoEnhancedBinarization_	Combines noise reduction ability of lower resolution images with smoother character contours characteristic of higher resolutions. Useful for the creation of binary images with resolutions above 300 DPI.
DO_GRAY_OUTPUT	_DoGrayOutput_	Converts the image to grayscale.
DO_SCANNER_BKG_FILL	_DoScannerBkgFill_	Fills scanner background touching the border of the final image with the average color of the page. Used mainly to fill missing corners or other rips in the page. Performed for dark backgrounds only.
DO_CONTOUR_CLEANING	_DoContourCleaning_	Adds a little margin to the scanner area filled during SCANNER_BKG_FILL.
DO_90_DEGREE_ROTATION	_Do90DegreeRotation_n	Performs image rotation in 90-degree increments or automatically, based on image content where the value of n can be: 1 = 90 degrees counterclockwise 2 = 180 degrees counterclockwise 3 = 270 degrees counterclockwise 4 = Automatic
DO_ROTATE_NONE	_Do90DegreeRotation_0	Does not rotate the image.
DO_ROTATE_90	_Do90DegreeRotation_1	Rotates the document 90 degrees clockwise.
DO_ROTATE_180	_Do90DegreeRotation_2	Rotates the document 180 degrees clockwise.
DO_ROTATE_270	_Do90DegreeRotation_3	Rotates the document 270 degrees clockwise.
DO_ROTATE_AUTO	_Do90DegreeRotation_4	Automatically rotates the document based on its content.
DO_ROTATE_AUTO_PLUS_90	_Do90DegreeRotation_5	Automatically rotates the document based on its content and then applies a 90-degree clockwise turn.
DO_ROTATE_AUTO_PLUS_180	_Do90DegreeRotation_6	Automatically rotates the document based on its content and then applies a 180-degree clockwise turn.
DO_ROTATE_AUTO_PLUS_270	_Do90DegreeRotation_7	Automatically rotates the document based on its content and then applies a 270-degree clockwise turn.
DO_ROTATE_AUTO_PLUS_LAND_L	_Do90DegreeRotation_8	Automatically rotates the document based on its content and then applies a 90-degree clockwise turn if the document is in portrait.
DO_ROTATE_AUTO_PLUS_LAND_R	_Do90DegreeRotation_9	Automatically rotates the document based on its content and then applies a 270-degree clockwise turn if the document is in portrait.
DO_ZONE_MASKING	_DoZoneMasking_	Specifies the position and specific parameters of the zone of interest to be preserved in the returned image.
DO_EDGE_CLEANUP	_DoEdgeCleanup_	Cuts a small frame around the final image to clean the fringes of the page. You must specify both _DoSkewCorrectionPage_ and _DoCropCorrection_ for _DoEdgeCleanup_ to have any effect.
DO_DESPECK	_DoDespeck_n	Removes speckles on the image to improve image quality. n=4 is the typical despeck size for the sample. The valid range is 1 to 50, with the higher settings removing larger speckles in the output image.
DO_SHARPEN	_DoSharpen_n	Sharpens processed color or gray image, where n: 1= a little, 2= more, 3= most.
DO_FIND_GRAPHIC_LINES	_DoFindGraphicLines_	Finds horizontal and vertical graphic lines in the image.
DO_REMOVE_GRAPHIC_LINES	_DoRemoveGraphicLines_	Finds and removes graphic lines from the processed binary image.
DO_BACKGROUND_SMOOTHING	_DoBackgroundSmoothing_	Smoothen page background for color and grayscale images.
DO_MERGE_FRONT_BACK	_DoMergeFrontBack_	Merges both sides of a page scanned in a duplex into a single image.
FINAL_IMAGE_SMALLER_PIXEL_DIM	_FinalImageSmallerPixelDim_n	Specifies pixel size n of the smaller side of the final image.
FINAL_IMAGE_LARGER_PIXEL_DIM	_FinalImageLargerPixelDim_n	Specifies pixel size n of the larger side of the final image.
FINAL_IMAGE_DPI	_FinalImageDPI_n	Specifies DPI n of the final image.
IMAGING_DEVICE_TYPE	_DeviceType_n	Specifies the image origin, where n: 0= scanner (default) 2= mobile camera When processing the mobile camera images, usually the DPI is not set correctly or is missing from the image metadata. In such cases, eVRS returns an error. To avoid this, add _DeviceType_2 to the eVRS processing string.
PROCESS_MRZ_DOC	_ProcessMrzDoc_	Enables the page detection algorithm specific to documents containing MRZ lines, such as some passports, visas, and identity cards. If MRZ lines are found and recognized as being one of the supported formats, EVRS automatically sets the appropriate output image dimensions to match the MRZ document format that was recognized. In this case, any _DocDimLarge_ or _DocDimSmall_ keywords in the operation string are ignored. If no MRZ lines of a supported format are found, standard page detection is used, along with any _DocDimLarge_ or _DocDimSmall_ keywords that are included in the operation string. The following MRZ document formats are recognized: TD1 size: 2.130" x 3.370" 3 MRZ lines of 30 characters. Top line begins with character A, C, or I. TD2 size: 2.910" x 4.130" 2 MRZ lines of 36 characters. Top line begins with character A, C, or I. TD3 size: 3.460" x 4.920" 2 MRZ lines of 44 characters. Top line begins with character P. MRV-A size: 3.150" × 4.720" 2 MRZ lines of 44 characters. Top line begins with character V. MRV-B size: 2.910" × 4.130" 2 MRZ lines of 36 characters. Top line begins with character V.
DocDimLarge & DocDimSmall	_DocDimLarge_ _DocDimSmall_	Helps provide the document dimensions via the operation string by including _DocDimSmall_ and/or _DocDimLarge_ strings followed by the corresponding dimensions in inches. For example, the dimensions of a standard US driver license can be set as _DocDimSmall_2.125_DocDimLarge_3.375. If only one of them is known, it still works, but if both are known it helps to correct slight discrepancies caused by imprecision of page detection.
LoadInlineSetting	_LoadInlineSetting_	Loads the properties of a processing module via the operation string "_LoadInlineSetting_<PropertyName="XXXX" Value="YY" Comment="ZZZZ"/>" where XXXX, YY, and ZZZZ indicate property name, value, and comment respectively.

To load properties of a processing module, use the operation string "_LoadInlineSetting_<PropertyName="XXXX" Value="YY" Comment="ZZZZ"/>". The strings XXXX, YY, and ZZZZ indicate property name, value, and comments.