Skip to main content

Refractive multi-camera calibration for underwater arrays with Snell's law modeling

Project description

AquaCal

Build Coverage PyPI Python License DOI

Refractive multi-camera calibration for underwater arrays. AquaCal calibrates cameras in air viewing through a flat water surface, using Snell's law to achieve accurate 3D reconstruction in refractive environments.

:construction: Status :construction:

02/17/26: This project is under active and rapid development. The API and internal structure are subject to frequent breaking changes without notice. It is not yet recommended for production use. A stable release is planned by the end of the month. This section will be updated accordingly once that milestone is reached.

Features

  • Snell's law refractive projection — Accurate ray-tracing through air-water interfaces
  • Multi-camera pose graph — BFS-based extrinsic initialization for camera arrays
  • Joint bundle adjustment — Simultaneous optimization of extrinsics, interface distances, and board poses
  • Sparse Jacobian optimization — Scalable to 10+ cameras with column grouping
  • ChArUco board detection — Robust corner detection for calibration targets

Installation

pip install aquacal

Quick Start

  1. Install AquaCal:

    pip install aquacal
    
  2. Generate a configuration file from your calibration videos:

    aquacal init --intrinsic-dir videos/intrinsic/ --extrinsic-dir videos/extrinsic/
    
  3. Run calibration:

    aquacal calibrate config.yaml
    

Results are saved to output/calibration.json with camera intrinsics, extrinsics, interface distances, and diagnostics.

Documentation

Full documentation is available at aquacal.readthedocs.io:

Citation

If you use AquaCal in your research, please cite:

@software{aquacal,
  title = {AquaCal: Refractive Multi-Camera Calibration},
  author = {Lancaster, Tucker},
  year = {2026},
  url = {https://github.com/tlancaster6/AquaCal},
  version = {1.2.0},
  doi = {10.5281/zenodo.18644658}
}

See CITATION.cff for full citation metadata.

Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

License

MIT License. See LICENSE for details.

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

aquacal-1.5.0.tar.gz (112.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aquacal-1.5.0-py3-none-any.whl (130.6 kB view details)

Uploaded Python 3

File details

Details for the file aquacal-1.5.0.tar.gz.

File metadata

  • Download URL: aquacal-1.5.0.tar.gz
  • Upload date:
  • Size: 112.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for aquacal-1.5.0.tar.gz
Algorithm Hash digest
SHA256 bfafbcf5529c48b30b02e845de65c6e764669483a409413c16593f11f6d579ec
MD5 f303e41186b2efe4e05faf257add383e
BLAKE2b-256 6eebcbaff4b5047005e86919c62279b12d8035f7978cafaa6bdd76b794bae678

See more details on using hashes here.

Provenance

The following attestation bundles were made for aquacal-1.5.0.tar.gz:

Publisher: publish.yml on tlancaster6/AquaCal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aquacal-1.5.0-py3-none-any.whl.

File metadata

  • Download URL: aquacal-1.5.0-py3-none-any.whl
  • Upload date:
  • Size: 130.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for aquacal-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 83bb536cbffac0a8948ef7232f8191bc7228969836cd7f59ea2144be394d4534
MD5 4f0775431570e80aaa2f657c4f673acc
BLAKE2b-256 df7faa940cad055be2b5481c125823478377ca6bda2e4cdc206d2c186f2c7b67

See more details on using hashes here.

Provenance

The following attestation bundles were made for aquacal-1.5.0-py3-none-any.whl:

Publisher: publish.yml on tlancaster6/AquaCal

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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