Welcome to XRPrimer’s documentation!

Installation

• Installation (CPP)
  • Requirements
  • Compilation
  • Test
  • How to link in C++ projects
• Installation (Python)
  • Requirements
  • Prepare environment
  • Install XRPrimer (python)

Data Structure

• Camera
  • Pinhole
  • Fisheye
• Image
  • Attributes
  • Create an Image
  • From Image to OpenCV
  • From OpenCV to Image
• Pose
  • Attributes
  • Construct a Pose
  • Set Pose to identity
  • Scale a Pose
  • Inverse a Pose

Operations

• Triangulator
  • Prepare camera parameters
  • Build a triangulator
  • Set cameras of a triangulator
  • Triangulate points from 2D to 3D
  • Get reprojection error
  • Camera selection
  • Get a conjugated projector
• Projector
  • Prepare camera parameters
  • Build a projector
  • Set cameras of a projector
  • Project points from 3D to 2D
  • Camera selection

Transform

• Camera convention
  • Intrinsic convention
  • Extrinsic convention

Tools

• Calibrate Multiple Cameras

Unit tests

• Running Tests
  • Data Preparation
  • Environment Preparation
  • Running tests through pytest

Notes

• Frequently Asked Questions
  • Installation
• Changelog
  • v0.6.0 (01/09/2022/)

License

• LICENSE

C++ API

• C++ documentation

Python API

• xrprimer.data_structure
• xrprimer.calibration
• xrprimer.ops
• xrprimer.transform
• xrprimer.utils

Indices and tables

• Index

• Search Page