ArcGIS Pro 3.8 API Reference Guide
ArcGIS.Core.OCR Namespace / OCRExtensions Class / ExtractTraverseFromDeedAsync Method / ExtractTraverseFromDeedAsync(OCRManager,String,Int32,SpatialReference) Method
The OCRManager.
The deed image. pdf, tif, tiff, jpg, jpeg, png and bmp extensions are supported.
The page you wish to extract information from. The index is 0-based; meaning that you should pass 0 for the first page; 1 for the second page and so on. Use -1 to extract data from all pages in the deed image.
The spatial reference to use for the traverse objects.
Example

In This Topic
    ExtractTraverseFromDeedAsync(OCRManager,String,Int32,SpatialReference) Method
    In This Topic
    Extracts a set of ArcGIS.Desktop.Editing.COGO.Traverse objects from a specific page of a deed image. This method must be called on the MCT. Use QueuedTask.Run.
    Syntax
    Public Overloads Shared Function ExtractTraverseFromDeedAsync( _
       ByVal OCRManager As OCRManager, _
       ByVal deedFileName As String, _
       ByVal page As Integer, _
       ByVal spatialReference As SpatialReference _
    ) As Task(Of IReadOnlyList(Of Traverse))

    Parameters

    OCRManager
    The OCRManager.
    deedFileName
    The deed image. pdf, tif, tiff, jpg, jpeg, png and bmp extensions are supported.
    page
    The page you wish to extract information from. The index is 0-based; meaning that you should pass 0 for the first page; 1 for the second page and so on. Use -1 to extract data from all pages in the deed image.
    spatialReference
    The spatial reference to use for the traverse objects.

    Return Value

    A IReadOnlyList of Traverse objects. Null cann be returned if no traverse data can be extracted.
    Exceptions
    ExceptionDescription
    deedFileName or spatialReference is null.
    The deed 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
    A typical deed contains multiple courses depicting the boundaries of a parcel or the boundaries of more than one parcel. Boundaries start from a well established point-of-beginning and loop back to the same point-of-beginning. Optical Character Recognition (OCR) technology is used to extract text from the deed image and convert it to numerical values for COGO dimensions for the parcel courses.

    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 legal descriptions.

    This method uses the OCROutputType.TSV output type to obtain information from the deed. Headers and footers (which often interfere with COGO course extraction) and vertical lines are removed when processing the OCR output.

    Use this method to obtain information from a specific page in the deed. Use OCRManager.GetDocumentPageCount to obtain the number of pages in the deed image. If you specify a page that is greater than the page count, then null will be returned. Alternatively you can use ExtractTraverseFromDeedAsync(OCRManager,String,SpatialReference) to obtain information from the entire deed.

    Example
    Extract a traverse from a deed
    {
      string deedFileName = "c:\\MyTraverseFileFolder\\MyTraverseDeed.pdf";
    
      var traverseList = await OCRManager.Instance.ExtractTraverseFromDeedAsync(deedFileName, spatialReference);
    
      // or extract from a specific page
      //int pageIdx = 1;
      //var traverseList = await OCRManager.Instance.ExtractTraverseFromDeedAsync(deedFileName, pageIdx, spatialReference);
    
      foreach (var trav in traverseList)
      {
        // iterate thorugh the courses
        foreach (var course in trav.Courses)
        {
          // ...
        }
      }
    }
    Requirements

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

    ArcGIS Pro version: 3.8 or higher.
    See Also