FACEIT Documentation and User Guide

Getting Started

• Introduction
• Instalation
  • Prerequisites
  • Step 1: Clone the Repository
  • Step 2: Navigate to the Project Directory
  • Step 3: Create a Virtual Environment (Using Python 3.9)
  • Step 4: Activate the Virtual Environment
  • Step 5: Install FaceIt
  • Running FaceIt
• Inputs
  • Input Overview
  • Important Note
• Outputs
  • Outputs Overview
  • .npz file (compressed data archive)
  • .nwb file (Neurodata Without Borders)
  • Visualization images (.png)
  • Access to data
  • Tips & Requirements
• How to Use FaceIt GUI
  • Open Data to Process
  • Analyse Pupil
  • Analyse whisker pad
  • Process data
  • Data visualization in the GUI
  • Post processing
  • Saving data

How the Pipeline Works: Methods

• Face Motion Computation
  • Motion Energy Computation Method Details
  • Grooming Detection
  • Grooming Detection Method Details
• Pupil Processing
  • Overview
  • API Surface
  • Light and Intensity Adjustment
  • Image Binarization
  • Light Reflection Handling
  • Clustering
  • Ellipse Fitting
  • User-Erased Pixels
  • Big Eye Movements (Saccade-like Events)
  • Blink Detection
  • Diagnostics and Returns
  • Recommendations