Skip to content

TrueMap Data (TMD)

TrueMap Data is a small binary format for height maps from TrueMap v6 and GelSight-class instruments. This project provides a Python library and two CLIs: tmd-process (maps, mesh, sequences, defects, tribology dashboard, and related workflows) and tmd-wear (bearing curve, wear volume series, roughness track, and other wear-oriented helpers). Both install from the same truemapdata package. Use them for loading .tmd files, visualizing surfaces, exporting texture-style maps, generating meshes (STL, OBJ, PLY, glTF, USD), and bundling maps onto template OBJ/MTL assets with physically motivated tiling.

Who it is for: tribology and metrology workflows, graphics pipelines that need displacement or normal maps from measured topography, and developers building tools on top of NumPy-friendly height arrays.

Apply-on-mesh uses physical tiling: template OBJ bounds (default meters) are converted with OBJ_UNITS_TO_MM=1000 and combined with TMD mm_per_pixel to derive atlas and tile sizes. Details live in the CLI reference and Exporting data.

Where to go next

graph LR
    Install[Installation] --> Start[Getting started]
    Start --> TMDfiles[Working with TMD files]
    Start --> Viz[Visualization]
    TMDfiles --> Export[Exporting data]
    Viz --> Export
    TMDfiles --> Tribo[Tribology metrics]
    Tribo --> WearSeq[Sequential wear analysis]
    Start --> CLI[CLI reference]
flowchart LR
    subgraph inputs [Inputs]
        TMDfile[".tmd file"]
    end
    subgraph lib [Library and CLI]
        Loader["TMD.load / tmd-process"]
    end
    subgraph outputs [Outputs]
        Maps["Maps PNG etc."]
        Mesh["Meshes STL OBJ glTF USD"]
        Bundle["OBJ MTL bundle"]
    end
    TMDfile --> Loader
    Loader --> Maps
    Loader --> Mesh
    Loader --> Bundle

User guide

Reference

Developers

License

MIT License