ArcGIS Pro 3.8 API Reference Guide
ArcGIS.Core.OCR Namespace / OCRManager Class / ExtractFromDocumentAsync Method / ExtractFromDocumentAsync(OCROptions) Method
The OCR options. See OCROptions.
Example

In This Topic
    ExtractFromDocumentAsync(OCROptions) Method
    In This Topic
    Extracts information from a document image using the document image, page and output type specified in the ocrOptions. This method must be called on the MCT. Use QueuedTask.Run.
    Syntax
    public Task<OCROutput> ExtractFromDocumentAsync( 
       OCROptions ocrOptions
    )
    Public Overloads Function ExtractFromDocumentAsync( _
       ByVal ocrOptions As OCROptions _
    ) As Task(Of OCROutput)

    Parameters

    ocrOptions
    The OCR options. See OCROptions.

    Return Value

    An OCROutput. The instance type depends upon the OCROptions.OutputType used. It can be null if no data can be extracted from the document.
    Exceptions
    ExceptionDescription
    ocrOptions is null.
    The document image could not be found or has an invalid extension for OCR.
    An error occurred within the OCR engine.
    This method or property must be called within the lambda passed to QueuedTask.Run.
    Remarks
    Optical Character Recognition (OCR) technology is used to extract text from the document image. Text extraction and character recognition will be dependent on the quality and content of the image. There might also be difficulty in extracting text from complex data.
    Example
    Extract text from a document using OCROptions
    {
      string docFileName = "c:\\MyData\\MyDocument.tiff";
    
      var ocrOptions = new OCROptions(docFileName);
      ocrOptions.OutputType = OCROutputType.Text;
    
      // 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);
      var textOutput = output as OCRTextOutput;
    
      var text = textOutput.Text;
    }
    Extract text from a document using a different model
    {
      string docFileName = "c:\\MyData\\MyDocument.jpg";
    
      var ocrOptions = new OCROptions(docFileName);
      ocrOptions.OutputType = OCROutputType.Text;
    
      // 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;
    
      // set the language
      // (de.traineddata should be installed at (arcgis_install_folder)\Resources\OCR)
      // if file cannot be found an exception is thrown
      ocrOptions.Model = "de";
    
      try
      {
        var output = await OCRManager.Instance.ExtractFromDocumentAsync(ocrOptions);
        var textOutput = output as OCRTextOutput;
    
        var text = textOutput.Text;
      }
      catch (ArcGIS.Core.OCR.Exceptions.OCRException ex)
      {
      }
    }
    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
                }
              }
            }
          }
        }
      }
    }
    Requirements

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

    ArcGIS Pro version: 3.8 or higher.
    See Also