Struct TrxFile 

pub struct TrxFile<P: TrxScalar> { /* private fields */ }

Core TRX container, generic over the position scalar type P.

Owns all memory-mapped (or heap-allocated) backings. Typed views borrow from self — no explicit lifetime annotations needed.

Field ordering

_tempdir must be declared AFTER mmap fields so it is dropped last, keeping the temp directory alive while mmaps reference files within it.

Implementations

impl<P: TrxScalar> TrxFile<P>

pub fn empty(header: Header) -> Self

Create an empty TrxFile with the given header.

pub fn header(&self) -> &Header

pub fn with_updated_header(self, header: Header) -> Self

Return a new TrxFile with the header replaced. All data arrays and positions are shared by reference-counted backing (owned copies).

pub fn positions(&self) -> &[[P; 3]]

Positions as a flat slice of [P; 3] arrays.

pub fn positions_2d(&self) -> TypedView2D<'_, P>

Positions as a TypedView2D with 3 columns.

pub fn positions_bytes(&self) -> &[u8]

Raw position bytes for direct GPU buffer upload.

pub fn nb_vertices(&self) -> usize

Number of vertices (points) across all streamlines.

pub fn offsets(&self) -> &[u32]

Offsets as a slice of u32. Length is nb_streamlines + 1. The i-th streamline spans positions[offsets[i]..offsets[i+1]].

pub fn offsets_vec(&self) -> Vec<u32>

pub fn nb_streamlines(&self) -> usize

Number of streamlines.

pub fn streamline(&self, i: usize) -> &[[P; 3]]

Get the i-th streamline as a slice of [P; 3] points.

pub fn streamlines(&self) -> StreamlineIter<'_, P>

Iterate over all streamlines.

pub fn streamline_lengths(&self) -> Vec<usize>

Length (number of points) of each streamline.

pub fn dps<T: Pod>(&self, name: &str) -> Result<TypedView2D<'_, T>>

Get a DPS (data-per-streamline) array cast to type T.

pub fn dpv<T: Pod>(&self, name: &str) -> Result<TypedView2D<'_, T>>

Get a DPV (data-per-vertex) array cast to type T.

pub fn group(&self, name: &str) -> Result<&[u32]>

Get group member indices (always u32).

pub fn dpg<T: Pod>(&self, group: &str, name: &str) -> Result<TypedView2D<'_, T>>

Get a DPG (data-per-group) array cast to type T.

pub fn dps_names(&self) -> Vec<&str>

List DPS field names.

pub fn dpv_names(&self) -> Vec<&str>

List DPV field names.

pub fn group_names(&self) -> Vec<&str>

List group names.

pub fn dpg_group_names(&self) -> Vec<&str>

List DPG group names.

pub fn iter_dps(&self) -> impl Iterator<Item = (&str, DataArrayInfo)> + '_

pub fn iter_dpv(&self) -> impl Iterator<Item = (&str, DataArrayInfo)> + '_

pub fn iter_groups(&self) -> impl Iterator<Item = (&str, &[u32])> + '_

Iterate over groups, yielding (name, &[u32]) pairs.

Safety note

This performs a raw byte reinterpretation via cast_slice::<u32>(). If the on-disk group dtype is not uint32 (e.g. int64), the returned slice will contain mangled values. Prefer [group_entries_owned] which handles dtype conversion correctly.

pub fn dpg_entries(&self, group: &str) -> Result<Vec<(String, DataArrayInfo)>>

pub fn dps_info(&self, name: &str) -> Result<DataArrayInfo>

pub fn dps_array(&self, name: &str) -> Result<&DataArray>

pub fn dpv_info(&self, name: &str) -> Result<DataArrayInfo>

pub fn dpv_array(&self, name: &str) -> Result<&DataArray>

pub fn group_info(&self, name: &str) -> Result<DataArrayInfo>

pub fn group_array(&self, name: &str) -> Result<&DataArray>

pub fn dpg_info(&self, group: &str, name: &str) -> Result<DataArrayInfo>

pub fn dpg_array(&self, group: &str, name: &str) -> Result<&DataArray>

pub fn scalar_dps_f32(&self, name: &str) -> Result<Vec<f32>>

pub fn scalar_dpv_f32(&self, name: &str) -> Result<Vec<f32>>

pub fn group_entries_owned(&self) -> Vec<(String, Vec<u32>)>

pub fn load(path: &Path) -> Result<Self>

Load a TRX file from a directory or .trx zip archive.

pub fn save_to_directory(&self, path: &Path) -> Result<()>

Save to a directory. The offsets.* array is written as uint32 if every offset fits in u32, otherwise as uint64.

pub fn save_to_zip(&self, path: &Path) -> Result<()>

Save to a .trx zip archive. All entries are Stored (no compression): DEFLATE rarely pays off on float-heavy tractography data. The offsets.* array width is auto-picked (uint32 if it fits, else uint64).

pub fn save_to_zip_deflate_groups(&self, path: &Path) -> Result<()>

Save to a .trx zip archive, applying DEFLATE only to groups/ entries. Everything else is Stored.

pub fn save_to_zip_stored(&self, path: &Path) -> Result<()>

Deprecated alias for [save_to_zip] — kept for backward compatibility.

pub fn save(&self, path: &Path) -> Result<()>

Save — auto-detects format from extension (.trx = zip, otherwise directory).

pub fn is_file_backed(&self) -> bool

Trait Implementations

impl<P: TrxScalar> Debug for TrxFile<P>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<P: TrxScalar> From<&TrxFile<P>> for Tractogram

fn from(value: &TrxFile<P>) -> Self

Converts to this type from the input type.