CaptureAnalysis

@objc
open class CaptureAnalysis : NSObject

Used to provided details about captured image and whether certain aspects of the capture meet minimum thresholds for ID verification processing.

Discussion: Confidence scores should not be considered, a 0.40 (or 40% confidence) could be acceptable in certain situations, however higher values will indicate better results.

It’s also generally suggested to use the overall DSResult.confidence score for checking whether an image needs to be recaptured while using this class to determine what actions a user may need to take to correct a bad capture.

  • How confident the capture engine is that the distance to the ID is good. That value ranges from 0.0 to 1.0, 0 meaning the worst possible usability, 1.0 meaning the distance is believed to be prefect.

    Declaration

    Swift

    @objc
open internal(set) var distanceConfidence: Double { get }

  • How confident the capture engine is that the image is in focus. That value ranges from 0.0 to 1.0, 0 meaning the worst possible usability, 1.0 meaning the best possible focsed image. Discussion: This value should not be considered to be binary, a 0.40 could be an image with good focus, however higher values will indicate better focus.

    Declaration

    Swift

    @objc
open internal(set) var focus: Double { get }

  • Indicates that a face was detected in the image or not

    Declaration

    Swift

    @objc
open internal(set) var faceDetected: Bool { get }

  • The DPI of the image when it was takend before scaled to the target DPI. This can be useful if you want to see if the image was scaled up or down to meet the DSOptions.targetDPI setting

    Declaration

    Swift

    @objc
open internal(set) var capturedDPI: Int { get }