Click or drag to resize

PixOptions Class

Class encapsulates OCR processing options for source images.
Inheritance Hierarchy
SystemObject
  Opait.Ocr.ApiPixOptions

Namespace:  Opait.Ocr.Api
Assembly:  Opait.Ocr (in Opait.Ocr.dll) Version: 1.3.3.0
Syntax
C#
public class PixOptions

The PixOptions type exposes the following members.

Constructors
  NameDescription
Public methodPixOptions
Initializes a new instance of PixOptions with default values.
Public methodPixOptions(XElement)
Initializes a new instance of PixOptions class from an XML element.
Top
Properties
  NameDescription
Public propertyBinarizationMethod
Gets or sets the method used for conversion to a binary image.
Public propertyBinaryResolution
Gets or sets the preferred resolution in dots per inch (DPI) when converting to binary images.
Public propertyBinaryThreshold
Gets or sets a fixed threshold for binarization.
Public propertyBlankPageThreshold
Gets or sets the percentile threshold used in detecting blank pages x 100.
Public propertyBottomMargin
Gets or sets the bottom margin of a page in inches x 100.
Public propertyConvertToBinary
Gets a value to indicate whether the image will be converted to binary before passing to OCR. Options like non-default thresholds, Despeckle or FixInvertedText will cause forced conversion to binary.
Public propertyDeskew
Gets or sets a flag to deskew image before OCR.
Public propertyDespeckle
Gets or sets a flag to whether remove speckes from the image.
Public propertyFixInvertedText
Gets or sets a flag to search for horizontal headers with inverted text (e.g. white on black as a table header), and if large rectangles detected, inverts only those rectangles. This vastly improves OCR in these cases.
Public propertyInvert
Gets or sets a flag to invert the entire image.
Public propertyLeftMargin
Gets or sets the left margin of a page in inches x 100.
Public propertyLineDilation
Gets or sets the dilation of lines before they are removed.
Public propertyMaxNoiseSize
Gets or sets the maximum size of speckle that can be removed.
Remarks
For a noise speckle to be removed, both its width and height must be less than this limit.
Public propertyMaxNoiseWidth
Gets or sets the maximum width when removing thin lines.
Remarks
For a thin line to be removed, only its width must be less than this limit. The length of the line is not restricted. Thin lines are often left behind after removing slanted grid lines.
Public propertyMinInvertedLength
Gets or sets the minimum size of inverted blocks.
Public propertyMinInvertedWidth
Gets or sets the minimum width of inverted blocks.
Public propertyMinLineLength
Gets or sets the minimum line size used during line removal.
Public propertyRemoveGridLines
Gets or sets a flag to indicate whether to detect and remove horizontal and vertical lines of certain minimum lengths. No attempt is made to fill the holes left if these lines intersect text.
Public propertyRightMargin
Gets or sets the right margin of a page in inches x 100.
Public propertyTileColumns
Gets or sets the number of tile columns.
Public propertyTileRows
Gets or sets the number of tile rows.
Public propertyTopMargin
Gets or sets the top margin of a page in inches x 100.
Public propertyUseMargins
Gets or sets a flag to indicate whether margins should be ignored whenm detecting blank pages.
Public propertyUseTiles
Gets or sets a flag to indicate whether the image should be tiled for blank page recognition.
Public propertyVerticalDeskew
Gets or sets a flag to indicate whether deskew correction should also be applied vertically.
Top
Methods
  NameDescription
Public methodReset
Resets all options to their default values.
Public methodToXml
Saves the current instance as an XML element.
Top
Fields
  NameDescription
Public fieldStatic memberDefLineDilation
The default line dialtion for thin line removal.
Public fieldStatic memberDefMaxNoiseSize
Default maximum speckle size for despeckling.
Public fieldStatic memberDefMaxNoiseWidth
Default maximum line width ehen removing thin lines.
Public fieldStatic memberDefMinInvertedLength
Default minimum inverted block length when detecting inverted regions.
Public fieldStatic memberDefMinInvertedWidth
Default minimum inverted block width when detecting inverted regions.
Public fieldStatic memberDefMinLineLength
The default maximum length for thin line removal.
Public fieldStatic memberDefResolution
Default resolutions in dots-per-inche for binarized images.
Public fieldStatic memberDefThreshold
The default gray threshold for binarization.
Public fieldStatic memberMaxThreshold
The maximum gray threshold for binarization.
Public fieldStatic memberMinThreshold
The minimum gray threshold for binarization.
Public fieldStatic memberResolutions
Array of supported resolutions in dots-per-inche for binarized images.
Top
See Also