https://github.com/yoonit-labs/ios-yoonit-facefy
The face detection's module for iOS with a lot of awesome features
https://github.com/yoonit-labs/ios-yoonit-facefy
computer-vision face-analysis face-detection face-movement face-undertanding hacktoberfest head-movement ios-facefy ios-lib-face mlkit-ios pods-face-detection undertanding-face-ios yoonit-ios-facefy
Last synced: about 1 year ago
JSON representation
The face detection's module for iOS with a lot of awesome features
- Host: GitHub
- URL: https://github.com/yoonit-labs/ios-yoonit-facefy
- Owner: Yoonit-Labs
- License: mit
- Created: 2021-01-28T17:44:11.000Z (over 5 years ago)
- Default Branch: development
- Last Pushed: 2021-10-30T20:17:19.000Z (over 4 years ago)
- Last Synced: 2025-03-29T07:22:43.805Z (about 1 year ago)
- Topics: computer-vision, face-analysis, face-detection, face-movement, face-undertanding, hacktoberfest, head-movement, ios-facefy, ios-lib-face, mlkit-ios, pods-face-detection, undertanding-face-ios, yoonit-ios-facefy
- Language: Swift
- Homepage:
- Size: 19.8 MB
- Stars: 33
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
iOS Yoonit Facefy
## Table of Contents
* [Installation](#installation)
* [Usage](#usage)
* [API](#api)
* [Methods](#methods)
* [FaceDetected](#facedetected)
* [Head Movements](#head-movements)
* [To contribute and make it better](#to-contribute-and-make-it-better)
## Install
Add the following line to your `Podfile` file:
```
pod 'YoonitFacefy'
```
And run in the root of your project:
```
pod install
```
## Usage
This is a basic usage to the `FacefyYoonit`.
Feel free to use the demo.
```swift
import YoonitFacefy
...
let image = UIImage(contentsOfFile: "image path")
let facefy: Facefy = Facefy()
self.facefy.detect(image!) { faceDetected in
if let faceDetected: FaceDetected = faceDetected {
if let leftEyeOpenProbability = faceDetected.leftEyeOpenProbability {
print(String(format: "%.2f", leftEyeOpenProbability))
}
if let rightEyeOpenProbability = faceDetected.rightEyeOpenProbability {
print(String(format: "%.2f", rightEyeOpenProbability))
}
if let smilingProbability = faceDetected.smilingProbability {
print(String(format: "%.2f", faceDetected.smilingProbability))
}
if let hasHeadEulerAngleX = faceDetected.hasHeadEulerAngleX {
print(String(format: "%.2f", hasHeadEulerAngleX))
}
if let hasHeadEulerAngleY = faceDetected.hasHeadEulerAngleY {
print(String(format: "%.2f", hasHeadEulerAngleY))
}
if let hasHeadEulerAngleZ = faceDetected.hasHeadEulerAngleZ {
print(String(format: "%.2f", hasHeadEulerAngleZ))
}
if let cgImage = image?.cgImage {
// Crop the face image from the camera frame.
let faceImage = UIImage(
cgImage: cgImage.cropping(to: faceDetected.boundingBox)!
).withHorizontallyFlippedOrientation()
}
}
} onError: { message in
print(message)
}
```
## API
### Methods
| Function | Parameters | Return Type | Description |
| - | - | - | - |
| detect | `image: UIImage, onSuccess: @escaping (FaceDetected?) -> Void, onError: @escaping (String) -> Void` | void | Detect a face from image and return the result in the [`FaceDetected`](#facedetected) as a closure. |
### FaceDetected
| Attribute | Type | Description |
| - | - | - |
| boundingBox | `CGRect` | The face bounding box related to the image input. |
| leftEyeOpenProbability | `Float?` | The left eye open probability. |
| rightEyeOpenProbability | `Float?` | The right eye open probability. |
| smilingProbability | `Float?` | The smiling probability. |
| headEulerAngleX | `Float?` | The angle in degrees that indicate the vertical head direction. See [Head Movements](#headmovements). |
| headEulerAngleY | `Float?` | The angle in degrees that indicate the horizontal head direction. See [Head Movements](#headmovements). |
| headEulerAngleZ | `Float?` | The angle in degrees that indicate the tilt head direction. See [Head Movements](#headmovements). |
| contours | `[CGPoint]` | List of points that represents the shape of the detected face. |
#### Head Movements
Here we explaining the above gif and how reached the "results". Each "movement" (vertical, horizontal and tilt) is a state, based in the angle in degrees that indicate head direction;
| Head Direction | Attribute | _v_ < -36° | -36° < _v_ < -12° | -12° < _v_ < 12° | 12° < _v_ < 36° | 36° < _v_ |
| - | - | - | - | - | - | - |
| Vertical | `headEulerAngleX` | Super Down | Down | Frontal | Up | Super Up |
| Horizontal | `headEulerAngleY` | Super Left | Left | Frontal | Right | Super Right |
| Tilt | `headEulerAngleZ` | Super Right | Right | Frontal | Left | Super Left |
## To contribute and make it better
Clone the repo, change what you want and send PR. For commit messages we use Conventional Commits.
Contributions are always welcome!
---
Code with ❤ by the [**Yoonit**](https://yoonit.dev/) Team
