Welcome to CarnivalMirror’s documentation!

CarnivalMirror is a Python library that can be used to simulate pinhole camera miscalibrations.

Features

  • Pinhole camera model with radial and tangential distortion
  • Image rectification and misrectification
  • Parallel sampling of miscalibration, either uniform in the parameters or approximately uniform in the resulting Average Pixel Position Difference
  • A number of other useful tools

Installation

The recommended installation procedure for CarnivalMirror is via pip:

pip install carnivalmirror

Alternatively, one can clone this repository and run python setup.py install in the main directory.

Get started

For an example of the common use of the package, see the example.py script here: https://github.com/AleksandarPetrov/carnivalmirror .

Indices and tables