Class DocumentScanningResult

  • All Implemented Interfaces:
    java.lang.AutoCloseable

    public class DocumentScanningResult
    extends java.lang.Object
    implements java.lang.AutoCloseable
    Result of the document detection followed by cropping of the found document.
    • Constructor Detail

      • DocumentScanningResult

        public DocumentScanningResult​(DocumentDetectionResult detectionResult,
                                      ImageRef croppedImage)
        Constructs DocumentScanningResult with the given params.
        Parameters:
        detectionResult - Result of the document contour detection.
        croppedImage - Cropped document image.
      • DocumentScanningResult

        public DocumentScanningResult​(DocumentDetectionResult detectionResult)
        Constructs DocumentScanningResult with default parameters.
        Parameters:
        detectionResult - Result of the document contour detection.
    • Method Detail

      • getDetectionResult

        public DocumentDetectionResult getDetectionResult()
        Getter for detectionResult field. See constructor documentation for more information about the field.
        Returns:
        detectionResult
      • getCroppedImage

        public ImageRef getCroppedImage()
        Getter for croppedImage field. See constructor documentation for more information about the field.
        Returns:
        croppedImage
      • close

        public void close()
        Closes native resources (images) held by the object.
        Specified by:
        close in interface java.lang.AutoCloseable