Class OcrInputPage
A full page (one image) within an OcrInput object.
Namespace: IronOcr
Assembly: IronOcr.dll
Syntax
public class OcrInputPage : ObjectProperties
ContentArea
Crop area of this page. If not null, text will only be read from within the ContentArea rectangle.
Declaration
public Rectangle ContentArea { get; set; }Property Value
| Type | Description |
|---|---|
| IronSoftware.Drawing.Rectangle |
Height
Height in Pixels
Declaration
public int Height { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
HorizontalDPI
Resolution in DPI on X axis
Declaration
public int HorizontalDPI { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Index
Zero based page number
Declaration
public int Index { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
VerticalDPI
Resolution in DPI on Y axis
Declaration
public int VerticalDPI { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Width
Width in Pixels
Declaration
public int Width { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Methods
DrawRectanglesOnPage(Rectangle[], Color)
Draw many Rectangles on a OcrInputPage.
Declaration
public AnyBitmap DrawRectanglesOnPage(Rectangle[] CropRects, Color rectangleColor)Parameters
| Type | Name | Description |
|---|---|---|
| IronSoftware.Drawing.Rectangle[] | CropRects | Crop Rectangle |
| IronSoftware.Drawing.Color | rectangleColor | Color for pen of rectangle border |
Returns
| Type | Description |
|---|---|
| IronSoftware.Drawing.AnyBitmap | Bitmap |
FindMultipleTextRegions(Double, Int32, Boolean, Boolean)
Use computer vision to detect areas which contain text elements and divide the page into separate images based on text regions.
Declaration
public List<OcrInputPage> FindMultipleTextRegions(double Scale = 0, int DilationAmount = -1, bool Binarize = true, bool Invert = false)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | Scale | (Only used during text region detection) Resolution scale factor. Image width and height will be multiplied by this value. |
| System.Int32 | DilationAmount | (Only used during text region detection) Dilation amount, in pixels. Text areas width and height will be increased by this value. |
| System.Boolean | Binarize | (Only used during text region detection) True to convert the image to black and white, False otherwise |
| System.Boolean | Invert | (Only used during text region detection) True to invert image colors when binarizing, False otherwise |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<OcrInputPage> | List of rectangles which contain text elements |
Remarks
Useful for generating several OCR results from a single image/page
FindTextRegion(Double, Int32, Boolean, Boolean)
Use computer vision to detect regions which contain text elements and instruct Tesseract to only search for text within the area in which text was detected.
Declaration
public Rectangle FindTextRegion(double Scale = 0, int DilationAmount = -1, bool Binarize = true, bool Invert = false)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | Scale | (Only used during text region detection) Resolution scale factor. Image width and height will be multiplied by this value. |
| System.Int32 | DilationAmount | (Only used during text region detection) Dilation amount, in pixels. Text areas width and height will be increased by this value. |
| System.Boolean | Binarize | (Only used during text region detection) True to convert the image to black and white, False otherwise |
| System.Boolean | Invert | (Only used during text region detection) True to invert image colors when binarizing, False otherwise |
Returns
| Type | Description |
|---|---|
| IronSoftware.Drawing.Rectangle | Rectangle which contains text elements |
GetCropRectangleImage()
Draw a Rectangle on a OcrInputPage.
Declaration
public AnyBitmap GetCropRectangleImage()Returns
| Type | Description |
|---|---|
| IronSoftware.Drawing.AnyBitmap | Bitmap |
GetTextRegions(Double, Int32, Boolean, Boolean)
Use computer vision to detect areas which contain text elements and return a list of rectangles.
Declaration
public List<Rectangle> GetTextRegions(double Scale = 0, int DilationAmount = -1, bool Binarize = true, bool Invert = false)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | Scale | (Only used during text region detection) Resolution scale factor. Image width and height will be multiplied by this value. |
| System.Int32 | DilationAmount | (Only used during text region detection) Dilation amount, in pixels. Text areas width and height will be increased by this value. |
| System.Boolean | Binarize | (Only used during text region detection) True to convert the image to black and white, False otherwise |
| System.Boolean | Invert | (Only used during text region detection) True to invert image colors when binarizing, False otherwise |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<IronSoftware.Drawing.Rectangle> | List of rectangles which contain text elements |
Remarks
Useful for generating several OCR results from a single image/page
SaveAsImage(String)
Saves this page as a Bitmap file to a specified path.
A file path.Declaration
public void SaveAsImage(string Path)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Path |
SaveAsImage(String, AnyBitmap.ImageFormat)
Saves this page as an image file of specified format.
A file path. The desired image file format.Declaration
public void SaveAsImage(string Path, AnyBitmap.ImageFormat Format)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | Path | |
| IronSoftware.Drawing.AnyBitmap.ImageFormat | Format |
ToBitmap()
Outputs this page as a IronSoftware.Drawing.AnyBitmap
Declaration
public AnyBitmap ToBitmap()Returns
| Type | Description |
|---|---|
| IronSoftware.Drawing.AnyBitmap | A native bitmap image. |