Struct Tractogram 

pub struct Tractogram { /* private fields */ }

Neutral in-memory streamline representation used for cross-format conversion.

Positions are stored in world/RASMM-style coordinates as f32 triplets. dps (data-per-streamline) and dpv (data-per-vertex) ride along unchanged through any operation that doesn’t reorder streamlines or vertices — including crate::transform::apply_transform_in_place, which only mutates the positions buffer.

Implementations

impl Tractogram

pub fn new() -> Self

Create an empty tractogram with identity metadata.

pub fn with_header(header: Header) -> Self

Create an empty tractogram with a caller-provided header.

pub fn from_trx<P: TrxScalar>(trx: &TrxFile<P>) -> Self

Build a tractogram by copying streamline geometry from a typed TRX file.

pub fn from_any_trx(trx: &AnyTrxFile) -> Self

Build a tractogram by copying streamline geometry from a dtype-erased TRX file.

pub fn header(&self) -> &Header

pub fn set_spatial_metadata( &mut self, voxel_to_rasmm: [[f64; 4]; 4], dimensions: [u64; 3], )

pub fn set_header(&mut self, header: Header)

pub fn extra(&self) -> &HashMap<String, Value>

pub fn extra_mut(&mut self) -> &mut HashMap<String, Value>

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

pub fn positions_mut(&mut self) -> &mut [[f32; 3]]

Mutable view of the contiguous positions buffer.

Useful for in-place spatial transforms (see crate::transform). Streamline boundaries (offsets) are unaffected by point edits, so callers may mutate the slice freely without invalidating any metadata.

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

pub fn group_names(&self) -> impl Iterator<Item = &str>

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

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

pub fn insert_group(&mut self, name: impl Into<String>, members: Vec<u32>)

pub fn insert_dpg( &mut self, group: impl Into<String>, name: impl Into<String>, data: DataArray, )

pub fn dpg(&self) -> &DataPerGroup

pub fn dps_arrays(&self) -> &HashMap<String, DataArray>

pub fn dpv_arrays(&self) -> &HashMap<String, DataArray>

pub fn dps_names(&self) -> impl Iterator<Item = &str>

pub fn dpv_names(&self) -> impl Iterator<Item = &str>

pub fn insert_dps(&mut self, name: impl Into<String>, data: DataArray)

Insert (or replace) a DPS field. The data array’s row count must equal the current streamline count.

pub fn insert_dpv(&mut self, name: impl Into<String>, data: DataArray)

Insert (or replace) a DPV field. The data array’s row count must equal the current vertex count.

pub fn subset_streamlines(&self, indices: &[usize]) -> Result<Self>

pub fn push_streamline(&mut self, points: &[[f32; 3]]) -> Result<()>

Add a streamline to the tractogram.

pub fn nb_streamlines(&self) -> usize

Number of streamlines.

pub fn nb_vertices(&self) -> usize

Number of vertices.

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

Borrow a single streamline as a position slice.

pub fn streamlines(&self) -> impl Iterator<Item = &[[f32; 3]]>

Iterate over streamlines.

pub fn to_trx(&self, dtype: DType) -> Result<AnyTrxFile>

Materialize a TRX file using the requested positions dtype.

Trait Implementations

impl Clone for Tractogram

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Tractogram

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

Formats the value using the given formatter.

impl Default for Tractogram

fn default() -> Self

Returns the “default value” for a type.

impl From<&AnyTrxFile> for Tractogram

fn from(value: &AnyTrxFile) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.