Class OcrPhotoResult

Result from or

Give an access to: Text, Confidence, and TextRegions.

Inheritance
System.Object
AdvancedOcrResultBase
OcrPhotoResult
Implements
IronSoftware.Abstractions.Ocr.IOcrResult
Inherited Members
Namespace: IronOcr
Assembly: IronOcr.dll
Syntax
public class OcrPhotoResult : AdvancedOcrResultBase

Reading text out of a photo in C#, a snapshot of a sign, a label, or a receipt rather than a clean scan, produces an OcrPhotoResult. It is the result type tuned for camera images, where text appears in scattered regions across the frame instead of neat document lines, and it returns from the photo-reading path on IronTesseract. It extends AdvancedOcrResultBase, so it shares the advanced-scan result shape while specializing in the spatial layout a photo demands.

The members center on those regions. TextRegions is a List<OcrPhotoResult.TextRegion>, each entry a block of text found somewhere in the image, which is the property that distinguishes a photo read from a flat document read. Text gives the combined recognized text and Confidence reports overall certainty, both overriding the base members. SaveAsTextFile writes the recognized text straight to a file when a quick dump is all a workflow needs. Iterate TextRegions when position matters, and fall back to Text for the plain string.

The read photo how-to walks through reading a camera image, and the photo reading example shows the regions in code.

Properties

Confidence

OCR statistical accuracy confidence as an average of every character.

1 = 100%, 0 = 0%.

Declaration
public override double Confidence { get; }
Property Value
Type Description
System.Double
Overrides

Text

All Ocr texts from OcrInput.

Declaration
public override string Text { get; }
Property Value
Type Description
System.String
Overrides

TextRegions

Ocr text and its location on the OcrInput.

Declaration
public List<OcrPhotoResult.TextRegion> TextRegions { get; }
Property Value
Type Description
System.Collections.Generic.List<OcrPhotoResult.TextRegion>

Methods

SaveAsTextFile(String)

Exports a .txt version of OcrPhotoResult. This is a plain text file.

Declaration
public void SaveAsTextFile(string Path)
Parameters
Type Name Description
System.String Path

The file path the text file will be saved to.

Implements

IronSoftware.Abstractions.Ocr.IOcrResult

Inherited members

SaveAsSearchablePdfBytes(Boolean, String, String)
SaveAsSearchablePdfStream(Boolean, String, String)
SaveAsSearchablePdf(String, Boolean, String, String)
Words
Characters