 | PixOptions Class |
Class encapsulates OCR processing options for source images.
Inheritance HierarchyNamespace: Opait.Ocr.Api
Assembly: Opait.Ocr (in Opait.Ocr.dll) Version: 1.3.3.0
SyntaxC#
public class PixOptions
The PixOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PixOptions |
Initializes a new instance of PixOptions with default values.
|
| PixOptions(XElement) |
Initializes a new instance of PixOptions class from an XML element.
|
Properties| Name | Description | |
|---|---|---|
 | BinarizationMethod |
Gets or sets the method used for conversion to a binary image.
|
| BinaryResolution |
Gets or sets the preferred resolution in dots per inch (DPI) when converting
to binary images.
|
| BinaryThreshold |
Gets or sets a fixed threshold for binarization.
|
| BlankPageThreshold |
Gets or sets the percentile threshold used in detecting blank pages x 100.
|
| BottomMargin |
Gets or sets the bottom margin of a page in inches x 100.
|
| ConvertToBinary |
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.
|
| Deskew |
Gets or sets a flag to deskew image before OCR.
|
| Despeckle |
Gets or sets a flag to whether remove speckes from the image.
|
| FixInvertedText |
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.
|
| Invert |
Gets or sets a flag to invert the entire image.
|
| LeftMargin |
Gets or sets the left margin of a page in inches x 100.
|
| LineDilation |
Gets or sets the dilation of lines before they are removed.
|
| MaxNoiseSize |
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.
|
| MaxNoiseWidth |
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.
|
| MinInvertedLength |
Gets or sets the minimum size of inverted blocks.
|
| MinInvertedWidth |
Gets or sets the minimum width of inverted blocks.
|
| MinLineLength |
Gets or sets the minimum line size used during line removal.
|
| RemoveGridLines |
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.
|
| RightMargin |
Gets or sets the right margin of a page in inches x 100.
|
| TileColumns |
Gets or sets the number of tile columns.
|
| TileRows |
Gets or sets the number of tile rows.
|
| TopMargin |
Gets or sets the top margin of a page in inches x 100.
|
| UseMargins |
Gets or sets a flag to indicate whether margins should be ignored whenm detecting blank pages.
|
| UseTiles |
Gets or sets a flag to indicate whether the image should be tiled
for blank page recognition.
|
| VerticalDeskew |
Gets or sets a flag to indicate whether deskew correction should also be applied vertically.
|
Methods| Name | Description | |
|---|---|---|
| Reset |
Resets all options to their default values.
|
| ToXml |
Saves the current instance as an XML element.
|
Fields| Name | Description | |
|---|---|---|
  | DefLineDilation |
The default line dialtion for thin line removal.
|
| DefMaxNoiseSize |
Default maximum speckle size for despeckling.
|
| DefMaxNoiseWidth |
Default maximum line width ehen removing thin lines.
|
| DefMinInvertedLength |
Default minimum inverted block length when detecting inverted regions.
|
| DefMinInvertedWidth |
Default minimum inverted block width when detecting inverted regions.
|
| DefMinLineLength |
The default maximum length for thin line removal.
|
| DefResolution |
Default resolutions in dots-per-inche for binarized images.
|
| DefThreshold |
The default gray threshold for binarization.
|
| MaxThreshold |
The maximum gray threshold for binarization.
|
| MinThreshold |
The minimum gray threshold for binarization.
|
| Resolutions |
Array of supported resolutions in dots-per-inche for binarized images.
|
See Also