LCBestShotConfiguration

Objective-C

@interface LCBestShotConfiguration : NSObject

/// Default configuration instance.
+ (instancetype)defaultConfig;

/// Configuration object of the best shot estimation.
@property (nonatomic, strong) LCEstimationThreshold *estimationThreshold;

/// Distance between face detection and frame edges.
@property (nonatomic, assign) NSInteger borderDistance;

/// Minimum detection size in pixels.
@property (nonatomic, assign) NSInteger minDetSize;

/// Liveness type.
@property (nonatomic, assign) LivenessType livenessType;

/// The amount of shots between the face detections. The smaller the number is, the more likely that TrackEngine will detect a new face as soon as it appears in the frame. The higher the number is, the higher the overall performance. Used to balance the performance and face detection frequency. Accepted values vary from 0 to 30, 7 by default.
@property (nonatomic, assign) NSUInteger detectorStep;

/// If a face wasn’t detected in the supposed area, TrackEngine waits this amount of shots before it will finish a track. Values vary from 0 to 50, 36 by default.
@property (nonatomic, assign) NSUInteger skipFrames;

/// Minimal amount of face detections for a track to be considered as a real face. 5 by default.
@property (nonatomic, assign) NSUInteger minimalTrackLength;

/// The amount of the best shots which is necessary to conduct Liveness procedure. 3 by default.
@property (nonatomic, assign) NSUInteger numberOfBestShots;

/// Minimal time interval between the best shots. Value in seconds. 0.5 by default.
/// @see numberOfBestShots
@property (nonatomic, assign) NSTimeInterval bestShotInterval;

/// Maximum possible difference between the best collected shots. 0.01 by default.
@property (nonatomic, assign) double similarityThreshold;

/// Liveness quality threshold.
/// If the liveness quality is less than the established value, the liveness is considered not passed. 0 by default.
/// @note Quality value is a probability of "appropriate image". The parameter describes the integral value of image, facial and environmental characteristics.
@property (nonatomic, assign) CGFloat livenessQuality;

/// Check eyes condition. If true then best shots with closed eyes will be skipped
@property (nonatomic, assign) BOOL checkEyes;

@end

Swift

class LCBestShotConfiguration : NSObject

Undocumented

  • Default configuration instance.

    Declaration

    Objective-C

    + (instancetype)defaultConfig;

    Swift

    class func defaultConfig() -> Self!

  • Configuration object of the best shot estimation.

    Declaration

    Objective-C

    @property (nonatomic, strong) LCEstimationThreshold *estimationThreshold;

    Swift

    var estimationThreshold: LCEstimationThreshold! { get set }

  • Distance between face detection and frame edges.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger borderDistance;

    Swift

    var borderDistance: Int { get set }

  • Minimum detection size in pixels.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger minDetSize;

    Swift

    var minDetSize: Int { get set }

  • Liveness type.

    Declaration

    Objective-C

    @property (nonatomic) LivenessType livenessType;

    Swift

    var livenessType: LivenessType { get set }

  • The amount of shots between the face detections. The smaller the number is, the more likely that TrackEngine will detect a new face as soon as it appears in the frame. The higher the number is, the higher the overall performance. Used to balance the performance and face detection frequency. Accepted values vary from 0 to 30, 7 by default.

    Declaration

    Objective-C

    @property (nonatomic) NSUInteger detectorStep;

    Swift

    var detectorStep: UInt { get set }

  • If a face wasn’t detected in the supposed area, TrackEngine waits this amount of shots before it will finish a track. Values vary from 0 to 50, 36 by default.

    Declaration

    Objective-C

    @property (nonatomic) NSUInteger skipFrames;

    Swift

    var skipFrames: UInt { get set }

  • Minimal amount of face detections for a track to be considered as a real face. 5 by default.

    Declaration

    Objective-C

    @property (nonatomic) NSUInteger minimalTrackLength;

    Swift

    var minimalTrackLength: UInt { get set }

  • The amount of the best shots which is necessary to conduct Liveness procedure. 3 by default.

    Declaration

    Objective-C

    @property (nonatomic) NSUInteger numberOfBestShots;

    Swift

    var numberOfBestShots: UInt { get set }

  • Minimal time interval between the best shots. Value in seconds. 0.5 by default.

    See

    numberOfBestShots

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval bestShotInterval;

    Swift

    var bestShotInterval: TimeInterval { get set }

  • Maximum possible difference between the best collected shots. 0.01 by default.

    Declaration

    Objective-C

    @property (nonatomic) double similarityThreshold;

    Swift

    var similarityThreshold: Double { get set }

  • Liveness quality threshold. If the liveness quality is less than the established value, the liveness is considered not passed. 0 by default.

    Note

    Quality value is a probability of “appropriate image”. The parameter describes the integral value of image, facial and environmental characteristics.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat livenessQuality;

    Swift

    var livenessQuality: CGFloat { get set }

  • Check eyes condition. If true then best shots with closed eyes will be skipped

    Declaration

    Objective-C

    @property (nonatomic) BOOL checkEyes;

    Swift

    var checkEyes: Bool { get set }