Type alias DocumentDetectionStatus

DocumentDetectionStatus: "NOT_ACQUIRED" | "OK" | "OK_BUT_TOO_SMALL" | "OK_BUT_BAD_ANGLES" | "OK_BUT_BAD_ASPECT_RATIO" | "OK_BUT_ORIENTATION_MISMATCH" | "OK_BUT_OFF_CENTER" | "OK_BUT_TOO_DARK" | "ERROR_NOTHING_DETECTED" | "ERROR_TOO_DARK" | "ERROR_TOO_NOISY"

Status of the document detection.

  • NOT_ACQUIRED: Detection has not yet happened.
  • OK: An acceptable document was detected.
  • OK_BUT_TOO_SMALL: A document was detected, but it is too small.
  • OK_BUT_BAD_ANGLES: A polygon was detected, but it has too much perspective distortion.
  • OK_BUT_BAD_ASPECT_RATIO: A document was detected, but its aspect ratio is not acceptable.
  • OK_BUT_ORIENTATION_MISMATCH: A document was detected, but its orientation does not match the input image orientation.
  • OK_BUT_OFF_CENTER: A document was detected, but its center is too far away from the input image center.
  • OK_BUT_TOO_DARK: A document was detected, but it is too dark.
  • ERROR_NOTHING_DETECTED: No document was detected.
  • ERROR_TOO_DARK: No document was detected, likely because the input image is too dark.
  • ERROR_TOO_NOISY: No document was detected, likely because the input image is too noisy or has a complex background.

Generated using TypeDoc