substrata Documentation

Welcome to the substrata documentation!

substrata is a Python package for 3-D geometry and point-cloud handling, providing utilities for working with point clouds, camera calibration, annotations, and geometric transformations.

Installation

Get started by installing substrata. See Installation for detailed instructions.

Tutorials

If you’re new to substrata or want to quickly orient and scale a point cloud, start here:

• Scaling and orientation with substrata - End-to-end scaling and orientation workflow

• Transferring 3D annotations between different reconstructions of the same pointcloud - Transfer annotations between datasets/projects

• Topographic position index (TPI) and terrain ruggedness index (TRI) - Topographic position index (TPI) and terrain ruggedness index (TRI)

You can also drive common workflows from the terminal; see Command-line usage of substrata.

API Documentation

The complete API reference is available in the API Reference section, which includes documentation for all modules, classes, and functions.

Getting Started

• Installation
• Command-line usage of substrata

Tutorials

• Scaling and orientation with substrata
• Transferring 3D annotations between different reconstructions of the same pointcloud
• Topographic position index (TPI) and terrain ruggedness index (TRI)

API Reference

• API Reference
  • Core Modules
  • Analysis and Processing
  • Visualization
  • Configuration and Utilities
  • Command Line Interface

Indices and tables

• Index

• Module Index

• Search Page