readme: # OpenFace 2.2.0: a facial behavior analysis toolkit
  
  [![Build Status](https://travis-ci.org/TadasBaltrusaitis/OpenFace.svg?branch=master)](https://travis-ci.org/TadasBaltrusaitis/OpenFace)
  [![Build status](https://ci.appveyor.com/api/projects/status/8msiklxfbhlnsmxp/branch/master?svg=true)](https://ci.appveyor.com/project/TadasBaltrusaitis/openface/branch/master)
  
  Over the past few years, there has been an increased interest in automatic facial behavior analysis
  and understanding. We present OpenFace – a tool intended for computer vision and machine learning
  researchers, affective computing community and people interested in building interactive
  applications based on facial behavior analysis. OpenFace is the ﬁrst toolkit capable of facial
  landmark detection, head pose estimation, facial action unit recognition, and eye-gaze estimation
  with available source code for both running and training the models. The computer vision algorithms
  which represent the core of OpenFace demonstrate state-of-the-art results in all of the above
  mentioned tasks. Furthermore, our tool is capable of real-time performance and is able to run from a
  simple webcam without any specialist hardware.
  
  ![Multicomp logo](https://github.com/TadasBaltrusaitis/OpenFace/blob/master/imgs/muticomp_logo_black.png)
  
  OpenFace was originally developed by Tadas Baltrušaitis in collaboration with CMU MultiComp Lab led by Prof. Louis-Philippe Morency. Some of the original algorithms were created while at Rainbow Group, Cambridge University. The OpenFace library is still actively developed at the CMU MultiComp Lab in collaboration with Tadas Baltršaitis. Special thanks to researcher who helped developing, implementing and testing the algorithms present in OpenFace: Amir Zadeh and Yao Chong Lim on work on the CE-CLM model and Erroll Wood for the gaze estimation work.
  
  ## WIKI
  
  **For instructions of how to install/compile/use the project please see [WIKI](https://github.com/TadasBaltrusaitis/OpenFace/wiki)**
  
  ## Functionality
  
  The system is capable of performing a number of facial analysis tasks:
  
  * Facial Landmark Detection
  
  ![Sample facial landmark detection image](https://github.com/TadasBaltrusaitis/OpenFace/blob/master/imgs/multi_face_img.png)
  
  * Facial Landmark and head pose tracking (links to YouTube videos)
  
  <a href="https://www.youtube.com/watch?v=V7rV0uy7heQ" target="_blank"><img src="http://img.youtube.com/vi/V7rV0uy7heQ/0.jpg" alt="Multiple Face Tracking" width="240" height="180" border="10" /></a>
  <a href="https://www.youtube.com/watch?v=vYOa8Pif5lY" target="_blank"><img src="http://img.youtube.com/vi/vYOa8Pif5lY/0.jpg" alt="Multiple Face Tracking" width="240" height="180" border="10" /></a>
  
  * Facial Action Unit Recognition
  
  <img src="https://github.com/TadasBaltrusaitis/OpenFace/blob/master/imgs/au_sample.png" height="280" width="600" >
  
  * Gaze tracking (image of it in action)
  
  <img src="https://github.com/TadasBaltrusaitis/OpenFace/blob/master/imgs/gaze_ex.png" height="182" width="600" >
  
  * Facial Feature Extraction (aligned faces and HOG features)
  
  ![Sample aligned face and HOG image](https://github.com/TadasBaltrusaitis/OpenFace/blob/master/imgs/appearance.png)
  
  ## Citation
  
  If you use any of the resources provided on this page in any of your publications we ask you to cite the following work and the work for a relevant submodule you used.
  
  #### Overall system
  
  **OpenFace 2.0: Facial Behavior Analysis Toolkit**
  Tadas Baltrušaitis, Amir Zadeh, Yao Chong Lim, and Louis-Philippe Morency,
  _IEEE International Conference on Automatic Face and Gesture Recognition_, 2018
  
  #### Facial landmark detection and tracking
  
  **Convolutional experts constrained local model for facial landmark detection**
  A. Zadeh, T. Baltrušaitis, and Louis-Philippe Morency.
  _Computer Vision and Pattern Recognition Workshops_, 2017
  
  **Constrained Local Neural Fields for robust facial landmark detection in the wild**
  Tadas Baltrušaitis, Peter Robinson, and Louis-Philippe Morency.
  in IEEE Int. _Conference on Computer Vision Workshops, 300 Faces in-the-Wild Challenge_, 2013.
  
  #### Eye gaze tracking
  
  **Rendering of Eyes for Eye-Shape Registration and Gaze Estimation**
  Erroll Wood, Tadas Baltrušaitis, Xucong Zhang, Yusuke Sugano, Peter Robinson, and Andreas Bulling
  in _IEEE International Conference on Computer Vision (ICCV)_, 2015
  
  #### Facial Action Unit detection
  
  **Cross-dataset learning and person-specific normalisation for automatic Action Unit detection**
  Tadas Baltrušaitis, Marwa Mahmoud, and Peter Robinson
  in _Facial Expression Recognition and Analysis Challenge_,
  _IEEE International Conference on Automatic Face and Gesture Recognition_, 2015
  
  # Commercial license
  
  For inquiries about the commercial licensing of the OpenFace toolkit please visit https://cmu.flintbox.com/#technologies/5c5e7fee-6a24-467b-bb5f-eb2f72119e59
  
  # Final remarks
  
  I did my best to make sure that the code runs out of the box but there are always issues and I would be grateful for your understand