Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keithito/swiftmaskdetection
CoreML face mask detector for iOS apps
https://github.com/keithito/swiftmaskdetection
computer-vision coreml covid-19 ios iphone machine-learning mask-detector swift
Last synced: about 2 months ago
JSON representation
CoreML face mask detector for iOS apps
- Host: GitHub
- URL: https://github.com/keithito/swiftmaskdetection
- Owner: keithito
- License: mit
- Created: 2020-08-10T22:33:20.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-29T20:34:43.000Z (about 3 years ago)
- Last Synced: 2024-10-13T22:33:29.681Z (3 months ago)
- Topics: computer-vision, coreml, covid-19, ios, iphone, machine-learning, mask-detector, swift
- Language: Swift
- Homepage:
- Size: 3.58 MB
- Stars: 20
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SwiftMaskDetection
[](https://cocoapods.org/pods/SwiftMaskDetection)
[](https://cocoapods.org/pods/SwiftMaskDetection)
[](https://cocoapods.org/pods/SwiftMaskDetection)
SwiftMaskDetection is a face mask detection library with a Swift interface.
It is a port of [AIZOO's FaceMaskDetection model](https://github.com/AIZOOTech/FaceMaskDetection) to
CoreML. The model 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 (AIZOO did all the hard work).
## Demo
To run the demo:
1. Make sure you have [Xcode](https://developer.apple.com/support/xcode/) and [CocoaPods](https://cocoapods.org/).
2. Clone this repo and open the example project:
```
git clone https://github.com/keithito/SwiftMaskDetection.git
cd SwiftMaskDetection/Example
pod install
open SwiftMaskDetection.xcworkspace
```
3. Run the project from XCode on a device (it needs the camera)
* If you see an error that signing needs a development team, open the "SwiftMaskDetection" project, click on
the "Signing & Capabilities" tab, and select an option from the "Team" menu.
## Installation
SwiftMaskDetection is available through [CocoaPods](https://cocoapods.org). To install it, add the following
line to your Podfile:
```ruby
pod 'SwiftMaskDetection'
```
If you don't use CocoaPods, you can simply copy the files in [SwiftMaskDetection/Classes](https://github.com/keithito/SwiftMaskDetection/tree/master/SwiftMaskDetection/Classes) into your Xcode project.
## Usage
### Images
To recognize an image:
```swift
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:
```swift
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:
```swift
let helper = MaskDetectionVideoHelper(maskDetector: MaskDetector())
```
Then call `detectInFrame` on each video frame:
```swift
if let results = try? helper.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](./Example/SwiftMaskDetection/ViewController.swift) for a complete example.
## Requirements
* iOS 13 or later
## 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](https://github.com/AIZOOTech/FaceMaskDetection/blob/6068769c7a6/LICENSE).