Skip to content

Getting started

from tmd import TMD

data = TMD.load("path/to/file.tmd")
height_map = data.height_map
metadata = data.metadata

TMD.load (or constructing TMD("path.tmd")) returns an object whose height_map is a 2D float32 array shaped (height, width) and whose metadata holds dimensions, physical lengths, offsets, and version fields parsed from the file. For byte layout and version differences, see Working with TMD files.

sequenceDiagram
    participant Caller
    participant TMD as TMD
    Caller->>TMD: TMD.load path to file
    TMD->>TMD: read and decode binary via TMDProcessor and TMDUtils
    TMD-->>Caller: height_map ndarray and metadata dict

Use path/to/file.tmd with a real file from TrueMap or GelSight. The library does not include sample .tmd binaries in the git tree.

For CLI examples after pip install truemapdata (or pip install -e . from a clone):

tmd-process --help
tmd-process visualize examples

From a repository checkout you can also run python tmd_cli.py with the same subcommands if you prefer not to use the installed entry point.

Wear- and tribology-oriented helpers use the separate tmd-wear entry point; see Working with TMD files — Wear-oriented CLI, the Sequential wear analysis guide (alignment, volume series, slip axis, scratch evolution), and the CLI reference.

A consolidated tmd-process command reference is in CLI reference.