Skip to main content

Toolchain for AUV dive processing, camera calibration and image correction

Project description

[![oplab_pipeline](https://github.com/ocean-perception/oplab_pipeline/actions/workflows/oplab_pipeline.yml/badge.svg)](https://github.com/ocean-perception/oplab_pipeline/actions/workflows/oplab_pipeline.yml) [![Code Coverage](https://codecov.io/gh/ocean-perception/oplab_pipeline/branch/master/graph/badge.svg?token=PJBfl6qhp5)](https://codecov.io/gh/ocean-perception/oplab_pipeline) [![Documentation Status](https://readthedocs.org/projects/oplab-pipeline/badge/?version=latest)](https://oplab-pipeline.readthedocs.io/en/latest/?badge=latest)

# oplab_pipeline

oplab_pipeline is a python toolchain to process AUV dives from raw data into navigation and imaging products. The software is capable of:

  • Process navigation: fuses AUV or ROV sensor data using state of the art filters and geolocalises recorded imagery.

  • Camera and laser calibration: performs automatic calibration pattern detection to calibrate monocular or stereo cameras. Also calibrates laser sheets with respect to the cameras.

  • Image correction: performs pixel-wise image corrections to enhance colour and contrast in underwater images.

Please review the latest changes in the [CHANGELOG.md](CHANGELOG.md).

## Installation cd into the oplab-pipeline folder and run pip3 install ., resp. if you are using Anaconda run pip install . from the Anaconda Prompt (Anaconda3). This will make the commands auv_nav, auv_cal and correct_images available in the terminal. For more details refer to the documentation.

## Documentation The documentation is hosted in [read the docs](https://oplab-pipeline.readthedocs.io).

## Citation If you use this software, please cite the following article:

> Yamada, T, Prügel‐Bennett, A, Thornton, B. Learning features from georeferenced seafloor imagery with location guided autoencoders. J Field Robotics. 2020; 1– 16. https://doi.org/10.1002/rob.21961

## License Copyright (c) 2020, University of Southampton. All rights reserved.

Licensed under the BSD 3-Clause License. See LICENSE.md file in the project root for full license information.

## Contributing Please document the code using [Numpy Docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html). If you are using VSCode, there is a useful extension that helps named [Python Docstring Generator](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring). Once installed, make sure you select Numpy documentation in the settings.

Run pre-commit install to install [pre-commit](https://pre-commit.com/) into your git hooks. pre-commit will now run on every commit. If you don’t have pre-commit installed, run pip install pre-commit.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oplab_pipeline-0.2.3a0.tar.gz (212.8 kB view details)

Uploaded Source

Built Distribution

oplab_pipeline-0.2.3a0-py3-none-any.whl (281.6 kB view details)

Uploaded Python 3

File details

Details for the file oplab_pipeline-0.2.3a0.tar.gz.

File metadata

  • Download URL: oplab_pipeline-0.2.3a0.tar.gz
  • Upload date:
  • Size: 212.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for oplab_pipeline-0.2.3a0.tar.gz
Algorithm Hash digest
SHA256 a2a59427733fc1827b5de93d89d90c04bd86e6941685a1b801f7e0e574abd048
MD5 07a89460c8ac04a5e0351a20cc42e9ef
BLAKE2b-256 cad737acef592af5c371616bc8ebaa86cc0a61f7cc12d0fb20447aaa657d53d5

See more details on using hashes here.

File details

Details for the file oplab_pipeline-0.2.3a0-py3-none-any.whl.

File metadata

File hashes

Hashes for oplab_pipeline-0.2.3a0-py3-none-any.whl
Algorithm Hash digest
SHA256 1188ce31a8009be3c4ea9cbf01259ee2507d8ff856bc9873bb1f1584a5642758
MD5 a84e3e169bd69d3b0f9828e5895cab87
BLAKE2b-256 367b847779dbc5471f82c17722e96a99496760270a50fd36094af79ab59be9e3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page