Class ScanResult.Scan

  • All Implemented Interfaces:
    java.io.Serializable
    Enclosing class:
    ScanResult

    public static class ScanResult.Scan
    extends java.lang.Object
    implements java.io.Serializable
    A single page that was scanned during the scan flow.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.io.File enhancedImageFile
      The image after the processing operations (perspective correction, filter…).
      ScanResult.OcrResult ocrResult
      Result of text recognition for this captured image.
      java.io.File originalImageFile
      The original image that was captured by the camera.
    • Constructor Summary

      Constructors 
      Constructor Description
      Scan​(java.io.File originalImageFile, java.io.File enhancedImageFile, ScanResult.OcrResult ocrResult)  
    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • originalImageFile

        public final java.io.File originalImageFile
        The original image that was captured by the camera.
      • enhancedImageFile

        public final java.io.File enhancedImageFile
        The image after the processing operations (perspective correction, filter…).
      • ocrResult

        @Nullable
        public final ScanResult.OcrResult ocrResult
        Result of text recognition for this captured image. Null if text recognition did not run or if it failed. Check logs for more details about text recognition failures.
    • Constructor Detail

      • Scan

        public Scan​(java.io.File originalImageFile,
                    java.io.File enhancedImageFile,
                    @Nullable
                    ScanResult.OcrResult ocrResult)