Welcome to FoxMask’s documentation

You will find on theses pages information related to the installation and usage of FoxMask. It is intended to be read by users as well as developers.

• Source code on GitHub

Getting Started

• Installation
  • Standalone installation on Linux
  • Installation through a virtual machine
• Usage
  • Running the code on your own set
  • Configuration
  • Image analysis pipeline
• Contribution
  • Report issues
  • Contribute to the documentation
  • Contribute to the code
• FoxMask module
  • Gathering folders to analyze
  • Creating results folders
  • Getting images information
  • Analyzing images
• Cli module