ArcGIS Pro 3.8 API Reference Guide
ArcGIS.Core.OCR Namespace / OCRPage Class
Members Example

In This Topic
    OCRPage Class
    In This Topic
    Respresents a page within a document image. Used within the components of an OCRTSVOutput instance.
    Object Model
    OCRPage ClassOCRBoundingBox Class
    Syntax
    public sealed class OCRPage 
    Public NotInheritable Class OCRPage 
    Remarks
    The TSV output hierarchy is as follows: - OCRPage -> OCRBlock -> OCRParagraph -> OCRLine -> OCRWord.

    That is, an OCRPage contains a set of OCRBlocks and a set of OCRPages are in the OCRTSVOutput.

    Example
    Extract TSV output from a document
    {
      string docFileName = "c:\\MyData\\MyDocument.bmp";
    
      var ocrOptions = new OCROptions(docFileName);
      ocrOptions.OutputType = OCROutputType.TSV;
    
      // set a specific page if necessary
      // (if not set, then all pages are scanned)
      // ocrOptions.Page = pageIdx;
    
      // set the resolution if necessary
      // ocrOptions.Resolution = 400;
    
      var output = await OCRManager.Instance.ExtractFromDocumentAsync(ocrOptions);
      if (output is OCRTSVOutput ocr_tsvOutput)
      {
        // process the tsv output
        foreach (var page in ocr_tsvOutput.Pages)
        {
          foreach (var block in page.Blocks)
          {
            foreach (var para in block.Paragraphs)
            {
              foreach (var line in para.Lines)
              {
                foreach (var word in line.Words)
                {
                  var content = word.Content;
                  var confidence = word.Confidence;
    
                  // process content according to confidence
                }
              }
            }
          }
        }
      }
    }
    Get text from TSVOutput (simple)
    {
      string text = "";
    
      var flowDocument = new FlowDocument();
    
      foreach (var page in tsvOutput.Pages)
      {
        List<Paragraph> pageParagraphs = new();
    
        foreach (var block in page.Blocks)
        {
          foreach (var paragraph in block.Paragraphs)
          {
            foreach (var line in paragraph.Lines)
            {
              string lineWords = string.Join(" ", line.Words.Select(w => w.Content));
              pageParagraphs.Add(new Paragraph(new Span(new Run(lineWords))));
            }
          }
        }
    
        flowDocument.Blocks.AddRange(pageParagraphs);
        flowDocument.Blocks.Add(new Paragraph(new Span(new Run(Environment.NewLine))));
      }
    
      var startPointer = flowDocument?.ContentStart;
      var endPointer = flowDocument?.ContentEnd;
    
      if (startPointer != null && endPointer != null)
      {
        text = new TextRange(startPointer, endPointer).Text;
      }
    }
    Inheritance Hierarchy

    System.Object
       ArcGIS.Core.OCR.OCRPage

    Requirements

    Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

    ArcGIS Pro version: 3.8 or higher.
    See Also