Class OcrImageInput
OCR input based on image data
Implements
Inherited Members
Namespace: IronOcr
Assembly: IronOcr.dll
Syntax
public class OcrImageInput : OcrInputBaseFeeding a single image to a read starts by wrapping it in an OcrImageInput. It is the image-backed input you build from a file, a Stream, a byte[], or an AnyBitmap, then pass to IronTesseract.Read. Use it for one picture, screenshot, or photo, where OcrInput is the choice when a job spans many images or PDF pages.
Each constructor takes the image source plus three optional arguments: a Dpi to declare the source resolution, a ContentArea rectangle to read only part of the image, and a Title to label the input. Because OcrImageInput derives from OcrInputBase, the inherited filter methods, Deskew, Binarize, DeNoise, and Contrast among them, are available on the instance to clean the image before the read, and Dispose releases it afterward. Build the input, apply any filters the source needs, then hand it to Read and read the words off the returned OcrResult.
The input images how-to covers the image sources, and the OCR input example builds one for a read.
using var input = new OcrImageInput("scan.png");
OcrResult result = ironTesseract.Read(input);Constructors
OcrImageInput(AnyBitmap, Nullable<Int32>, Rectangle, String)
Create a new OCR image input from the specified AnyBitmap
Declaration
public OcrImageInput(AnyBitmap Bitmap, Nullable<int> Dpi = null, Rectangle ContentArea = null, string Title = null)Parameters
| Type | Name | Description |
|---|---|---|
| IronSoftware.Drawing.AnyBitmap | Bitmap | Image |
| System.Nullable<System.Int32> | Dpi | Desired DPI |
| IronSoftware.Drawing.Rectangle | ContentArea | Desired crop area |
| System.String | Title | Title |
OcrImageInput(Byte[], Nullable<Int32>, Rectangle, String)
Create a new OCR image input from the specified byte array
Declaration
public OcrImageInput(byte[] Bytes, Nullable<int> Dpi = null, Rectangle ContentArea = null, string Title = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Byte[] | Bytes | Image data |
| System.Nullable<System.Int32> | Dpi | Desired DPI |
| IronSoftware.Drawing.Rectangle | ContentArea | Desired crop area |
| System.String | Title | Title |
OcrImageInput(Stream, Nullable<Int32>, Rectangle, String)
Create a new OCR image input from the specified stream
Declaration
public OcrImageInput(Stream Stream, Nullable<int> Dpi = null, Rectangle ContentArea = null, string Title = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.Stream | Stream | Image data stream |
| System.Nullable<System.Int32> | Dpi | Desired DPI |
| IronSoftware.Drawing.Rectangle | ContentArea | Desired crop area |
| System.String | Title | Title |
OcrImageInput(String, Nullable<Int32>, Rectangle, String)
Create a new OCR image input from the specified path
Declaration
public OcrImageInput(string Path, Nullable<int> Dpi = null, Rectangle ContentArea = null, string Title = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Path | Image file path |
| System.Nullable<System.Int32> | Dpi | Desired DPI |
| IronSoftware.Drawing.Rectangle | ContentArea | Desired crop area |
| System.String | Title | Title |