Skip to main content

trx_rs/
lib.rs

1//! # trx-rs
2//!
3//! Rust library for reading and writing TRX tractography files.
4//!
5//! TRX is a file format for storing brain tractography streamlines as
6//! memory-mapped binary arrays, either as plain directories or ZIP archives.
7
8pub mod any_trx_file;
9pub mod dtype;
10pub mod error;
11pub mod fit;
12pub mod formats;
13pub mod header;
14pub mod io;
15pub mod legacy_io;
16pub mod mmap_backing;
17pub mod ops;
18pub mod reference;
19pub mod stream;
20pub mod tractogram;
21pub mod transform;
22pub mod trx_file;
23pub mod typed_view;
24pub mod vertex;
25// Re-exports for convenience
26pub use any_trx_file::{AnyTrxFile, PositionsRef};
27pub use dtype::{DType, TrxScalar};
28pub use error::{Result, TrxError};
29pub use formats::{
30    convert, detect_format, inspect_vtk_declared_space, read_tractogram, vtk_import_warnings,
31    write_tractogram, ConversionOptions, Format, VtkCoordinateMode, VtkCoordinateSpace,
32};
33pub use header::Header;
34pub use mmap_backing::MmapBacking;
35pub use ops::{
36    build_streamline_aabbs, build_streamline_aabbs_from_slices, concatenate_any_trx, copy_metadata,
37    copy_metadata_any_trx, difference, difference_indices, intersection, intersection_indices,
38    merge_trx_shards, query_aabb, query_aabb_cached, remove_duplicates,
39    remove_duplicates_tractogram, retain_representative_indices,
40    retain_tractogram_representative_indices, streamline_union, subset_streamlines,
41    ConcatenateOptions, CopyMetadataOptions, DuplicateRemovalMode, DuplicateRemovalParams,
42    StreamlineAabb,
43};
44pub use reference::header_from_reference;
45pub use stream::TrxStream;
46pub use tractogram::Tractogram;
47pub use transform::{apply_transform, apply_transform_in_place};
48pub use trx_file::{DataArray, DataArrayInfo, TrxFile};
49pub use typed_view::TypedView2D;
50pub use vertex::Position3;
51
52pub use fit::{
53    fit_catmull_rom_indices, sample_catmull_rom, sample_catmull_rom_into, simplify_streamline,
54    simplify_tractogram, FittedMarker, SimplifyOptions, SimplifyStats, FITTED_MARKER_KEY,
55};