TRX-cpp Documentation

A C++17 library for reading, writing, and memory-mapping the TRX tractography format.

Getting Started

• Introduction
• Quick Start
• Building

User Guide

• API Layers
• Reading TRX Files
• Writing TRX Files
• Streaming Writes
• Spatial Queries
• NIfTI Header Support

Integration Guide

• Integration Guide
  • MRtrix3
  • DSI Studio
  • nibrary / dmriTrekker
  • MITK Diffusion
  • SlicerDMRI
  • ITK-SNAP

Performance

• Benchmarks
  • Data
  • TRX size vs streamline count
  • Translate + stream write throughput
  • Spatial slab query latency
  • Running the benchmarks

Contributing

• Linting and Style Checks
  • Prerequisites
  • clang-format (bulk formatting)
  • check_syntax (style rules)
  • clang-tidy

API Reference

• API Reference
  • Class Hierarchy
  • File Hierarchy
  • Full API