Package io.scanbot.sdk.documentscanner
Class DocumentScanningResult
- java.lang.Object
-
- io.scanbot.sdk.documentscanner.DocumentScanningResult
-
- All Implemented Interfaces:
java.lang.AutoCloseable
public class DocumentScanningResult extends java.lang.Object implements java.lang.AutoCloseableResult of the document detection followed by cropping of the found document.
-
-
Constructor Summary
Constructors Constructor Description DocumentScanningResult(DocumentDetectionResult detectionResult)Constructs DocumentScanningResult with default parameters.DocumentScanningResult(DocumentDetectionResult detectionResult, ImageRef croppedImage)Constructs DocumentScanningResult with the given params.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Closes native resources (images) held by the object.ImageRefgetCroppedImage()Getter for croppedImage field.DocumentDetectionResultgetDetectionResult()Getter for detectionResult field.
-
-
-
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:
closein interfacejava.lang.AutoCloseable
-
-