SwiftMaskDetection 0.1.1

SwiftMaskDetection 0.1.1

×

Maintained by Keith Ito.

SwiftMaskDetection 0.1.1

  • By
  • Keith Ito

SwiftMaskDetection

CI Status Version License Platform

SwiftMaskDetection is a face mask detection library written in Swift.

It ports AIZOO's FaceMaskDetection model to CoreML and provides a Swift interface to it for easy use in iOS apps.

The model was converted to CoreML with the convert.py script. It runs at over 30fps on recent iPhones and iPads. For more information on the model and training data, please see https://github.com/AIZOOTech/FaceMaskDetection.

Usage

Images

To recognize an image:

import SwiftMaskDetection

let detector = MaskDetector()
let image = UIImage(named: "my_photo")!
if let results = try? detector.detectMasks(cgImage: image.cgImage!) {
  // Do something with the results.
}

The image must be 260x260 pixels. detectMasks supports CGImage, CIImage, and CVPixelBuffer inputs and returns an array of Results, one for each detected face:

public struct Result {
  /// The status of the detection (.mask or .noMask)
  public let status: Status

  /// The bounding box of the face in normalized coordinates (the top-left corner of the image
  /// is [0, 0], and the bottom-right corner is [1, 1]).
  public let bound: CGRect

  /// Value between 0 and 1 representing the confidence in the result
  public let confidence: Float
}

Video

MaskDetectionVideoHelper may come in handy for running on live video. First, create the helper:

let helper = MaskDetectionVideoHelper(maskDetector: MaskDetector())

Then call detectInFrame on each video frame:

if let results = try? detector.detectInFrame(cmSampleBuffer) {
  // Do something with the results.
}

You don't need to resize the image to 260x260; the helper does that for you. See the example app's ViewController for a complete example.

Requirements

  • iOS 13 or later

Example

To run the example project, clone the repo, and run pod install from the Example directory.

Installation

SwiftMaskDetection is available through CocoaPods. To install it, add the following line to your Podfile:

pod 'SwiftMaskDetection'

License

SwiftMaskDetection is available under the MIT license. See the LICENSE file for more info.

The face mask detection model is (c) 2020 AIZOOTech and is also available under the MIT License.