Welcome to Ocean Perception’s pipeline

This is a toolchain for AUV dive processing, camera calibration and image correction. Three main tools are used to get from the raw data to geolocalised and colour-corrected images for a particular dataset: auv_nav, auv_cal and correct_images.

User’s Guide

Contents:

• How to install
  • Running the code
• Dataset structure
  • Testing dataset
• File format definitions
  • mission.yaml file format definition
  • vehicle.yaml file format definition
  • Compatibility with auv_nav
• auv_nav
  • Usage
  • Parse (auv_nav parse)
  • Process (auv_nav process)
  • Convert (auv_nav convert)
  • Inputs and outputs of auv_nav
  • Examples
  • Folder Structure
  • Example of Required YAML Configuration Files
  • Example Dataset for testing
• correct_images
  • correct_images parse usage:
  • correct_images process usage:
  • correct_images correct usage:
  • correct_images rescale usage :
  • Output folder structures
  • Example of required correct_images.yaml File
• auv_cal
  • Usage
  • Image conversion
  • Set up folder for results and configuration file
  • Run auv_cal
• Examples
  • YAML Configuration Files
  • Dataset for testing
• Docker and Singularity
  • 1. Build the Singularity image.
  • 2. Run the SIF image.
  • FAQ

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

• API
  • auv_nav
  • auv_cal
  • correct_images
  • Useful Functions and Classes

Indices and tables

• Index

• Module Index

• Search Page