Skip to main content

A fiducial marker system powered by OpenCV - Supports ArUco and April

Project description

Zoloto

Documentation Status Tests Status PyPI PyPI - Python Version PyPI - Wheel PyPI - Status PyPI - License

A fiducial marker system powered by OpenCV - Supports ArUco and April

Documentation

Installation

pip install zoloto

OpenCV

OpenCV should be installed manually, ideally through your system package manager. This makes it easier to customize your OpenCV installation for your system, or use the optimal settings for your OS / hardware. Note that you may need to install opencv-contrib as well as opencv.

If you'd rather have one installed automatically, install the extra opencv:

pip install zoloto[opencv]

Note that this version lacks hardware acceleration. See the README for more details.

For storage-constrained environments, there's also opencv-contrib-python-headless, which should be installed manually.

Examples

from pathlib import Path

from zoloto import MarkerType
from zoloto.cameras import ImageFileCamera


with ImageFileCamera(Path("my-image.png"), marker_type=MarkerType.ARUCO_6X6) as camera:
    camera.save_frame("my-annotated-image.png", annotate=True)
    print("I saved an image with {} markers in.".format(len(camera.get_visible_markers())))

More examples

Zoloto ships with a CLI (aptly named zoloto), which contains some helpful utils for working with Zoloto and fiducial markers.

Development setup

./scripts/setup.sh will create a virtual environment, and install all the required development dependencies into it.

Note that this will not install a version of OpenCV for you. For that, run ./scripts/setup.sh opencv.

There are some additional useful scripts to assist:

  • ./scripts/test.sh: Run the unit tests and linters
  • ./scripts/fix.sh: Automatically fix issues from black and isort
  • ./scripts/benchmark.sh: Run benchmarks (these can take a couple minutes depending on your hardware)

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

zoloto-0.9.0.tar.gz (20.8 kB view details)

Uploaded Source

Built Distribution

zoloto-0.9.0-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

Details for the file zoloto-0.9.0.tar.gz.

File metadata

  • Download URL: zoloto-0.9.0.tar.gz
  • Upload date:
  • Size: 20.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for zoloto-0.9.0.tar.gz
Algorithm Hash digest
SHA256 39151c13afac718bcd60a858348994d0ba5b73ba9cab367f886be0f1bd4a443f
MD5 0f372adfe06368584d903d7f5b1ba083
BLAKE2b-256 ab1edface24111e6a64f772c20b6fef489602b40f904101139dd00108de851d1

See more details on using hashes here.

File details

Details for the file zoloto-0.9.0-py3-none-any.whl.

File metadata

  • Download URL: zoloto-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 24.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for zoloto-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b8d75efd529a8f2179db4216c45631c2a75ca764cb0a0bea48eaab7c4bdf4725
MD5 e28fc21499b96b643dc514d6fd492893
BLAKE2b-256 ce6770972b30a02ac8935e697cf39ab427b1a2770efdcd44a37a55ad866db46f

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