Class OcrPhotoResult.TextRegion

Text region struct

Inheritance
System.Object
OcrPhotoResult.TextRegion
Implements
System.IEquatable<OcrPhotoResult.TextRegion>
Namespace: IronOcr
Assembly: IronOcr.dll
Syntax
public sealed class TextRegion : ValueType

A recognized patch of text in a photo, together with where it sits and how confident the read was, is captured by OcrPhotoResult.TextRegion. It is the value you work through when a OcrPhotoResult reports text by region rather than as a single block, which is the natural shape for photographed signs, labels, and screens where text appears in scattered areas.

You receive these regions from a photo read rather than constructing them yourself, though the constructors exist if you need to model one. Each region exposes TextInRegion for the recognized text, Region for the bounding Rectangle on the source image, and RegionConf for the confidence of that region. PageNumber identifies the page or frame the region came from when the input had more than one.

Because it is a value type, comparisons go through Equals and GetHashCode, and the static Empty field gives a default region for an absent or unset value. Read TextInRegion and Region together when you want both the content and its placement, for example to draw a box around each detected area.

The read from photo how-to covers reading text from photographs, and the read photo example shows working with the photo result.

Constructors

TextRegion(String, Rectangle, Single)

Declaration
public TextRegion(string textByRegion, Rectangle regionRect, float confidence)
Parameters
Type Name Description
System.String textByRegion
IronSoftware.Drawing.Rectangle regionRect
System.Single confidence

TextRegion(String, Rectangle, Single, Int32)

Declaration
public TextRegion(string textByRegion, Rectangle regionRect, float confidence, int frameNumber)
Parameters
Type Name Description
System.String textByRegion
IronSoftware.Drawing.Rectangle regionRect
System.Single confidence
System.Int32 frameNumber

Fields

Empty

Declaration
public static readonly OcrPhotoResult.TextRegion Empty
Field Value
Type Description
OcrPhotoResult.TextRegion

Properties

PageNumber

Declaration
public int PageNumber { get; }
Property Value
Type Description
System.Int32

Region

Declaration
public Rectangle Region { get; }
Property Value
Type Description
IronSoftware.Drawing.Rectangle

RegionConf

Declaration
public float RegionConf { get; }
Property Value
Type Description
System.Single

TextInRegion

Declaration
public string TextInRegion { get; }
Property Value
Type Description
System.String

Methods

Equals(OcrPhotoResult.TextRegion)

Declaration
public bool Equals(OcrPhotoResult.TextRegion others)
Parameters
Type Name Description
OcrPhotoResult.TextRegion others
Returns
Type Description
System.Boolean

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

Implements

System.IEquatable<>