Package io.scanbot.sdk.medicalcertificate

Class MedicalCertificateScanningResult

java.lang.Object
io.scanbot.sdk.medicalcertificate.MedicalCertificateScanningResult
All Implemented Interfaces:
AutoCloseable
public class MedicalCertificateScanningResult extends Object implements AutoCloseable
The result of the medical certificate scanning.

  • Constructor Details

    • MedicalCertificateScanningResult

      public MedicalCertificateScanningResult(boolean scanningSuccessful, MedicalCertificatePatientInfoBox patientInfoBox, List<MedicalCertificateCheckBox> checkBoxes, List<MedicalCertificateDateRecord> dates, MedicalCertificateFormType formType, int clockwiseRotations, ImageRef croppedImage, double scaleX, double scaleY, DocumentDetectionResult documentDetectionResult)
      Constructs MedicalCertificateScanningResult with the given params.
      Parameters:
      scanningSuccessful - True if scanning was successful. Default is `false`.
      patientInfoBox - Patient info box.
      checkBoxes - Found checkboxes.
      dates - Found dates.
      formType - Form type. Default is `UNKNOWN`.
      clockwiseRotations - The number of 90-degree clockwise rotations that were applied to the original image. The same number of counter-clockwise rotations are necessary to make the image upright again. Default is `0`.
      croppedImage - The cropped image used for recognition.
      scaleX - The scale factor used to scale the image to the recognition size. Default is `1.0`.
      scaleY - The scale factor used to scale the image to the recognition size. Default is `1.0`.
      documentDetectionResult - Result of the document detection in the input image. Is available only if the shouldCropDocument parameter is set to true.

    • MedicalCertificateScanningResult

      public MedicalCertificateScanningResult(MedicalCertificatePatientInfoBox patientInfoBox, List<MedicalCertificateCheckBox> checkBoxes, List<MedicalCertificateDateRecord> dates, DocumentDetectionResult documentDetectionResult)
      Constructs MedicalCertificateScanningResult with default parameters.
      Parameters:
      patientInfoBox - Patient info box.
      checkBoxes - Found checkboxes.
      dates - Found dates.
      documentDetectionResult - Result of the document detection in the input image. Is available only if the shouldCropDocument parameter is set to true.

  • Method Details

    • getScanningSuccessful

      public boolean getScanningSuccessful()
      Getter for scanningSuccessful field. See constructor documentation for more information about the field.
      Returns:
      scanningSuccessful

    • getPatientInfoBox

      public MedicalCertificatePatientInfoBox getPatientInfoBox()
      Getter for patientInfoBox field. See constructor documentation for more information about the field.
      Returns:
      patientInfoBox

    • getCheckBoxes

      public List<MedicalCertificateCheckBox> getCheckBoxes()
      Getter for checkBoxes field. See constructor documentation for more information about the field.
      Returns:
      checkBoxes

    • getDates

      public List<MedicalCertificateDateRecord> getDates()
      Getter for dates field. See constructor documentation for more information about the field.
      Returns:
      dates

    • getFormType

      public MedicalCertificateFormType getFormType()
      Getter for formType field. See constructor documentation for more information about the field.
      Returns:
      formType

    • getClockwiseRotations

      public int getClockwiseRotations()
      Getter for clockwiseRotations field. See constructor documentation for more information about the field.
      Returns:
      clockwiseRotations

    • getCroppedImage

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

    • getScaleX

      public double getScaleX()
      Getter for scaleX field. See constructor documentation for more information about the field.
      Returns:
      scaleX

    • getScaleY

      public double getScaleY()
      Getter for scaleY field. See constructor documentation for more information about the field.
      Returns:
      scaleY

    • getDocumentDetectionResult

      public DocumentDetectionResult getDocumentDetectionResult()
      Getter for documentDetectionResult field. See constructor documentation for more information about the field.
      Returns:
      documentDetectionResult

    • close

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