Struct MotionSeries 

pub struct MotionSeries {
    pub reference: usize,
    pub volumes: Vec<VolumeMotion>,
}

Where every volume of a series was, relative to the reference.

The output grid is the reference volume’s grid throughout: apply* resamples onto it, and VolumeMotion::bdir is expressed in it.

Fields

reference: usize

Index of the reference volume within the series.

volumes: Vec<VolumeMotion>

One entry per input volume, in input order. The reference’s own entry is present and is the identity, so indices line up with the caller’s data and nothing has to be skipped.

Implementations

impl MotionSeries

pub fn len(&self) -> usize

Number of volumes in the series.

pub fn is_empty(&self) -> bool

Whether the series is empty. Never true for a MotionSeries estimate_motion returned, which rejects an empty series.

pub fn dims(&self) -> (usize, usize, usize)

Dimensions of the output grid — the reference volume’s.

pub fn affine(&self) -> [f64; 16]

Voxel→world affine of the output grid — the reference volume’s.

pub fn bdirs(&self) -> Vec<(f64, f64, f64)>

Every volume’s B0 direction in the reference grid’s voxel frame, in input order — ready to hand to a multi-orientation inversion alongside the resampled field maps.

pub fn max_displacement_mm(&self) -> f64

The largest tissue displacement anywhere in the series, in mm — the one number to compare against the voxel size when deciding whether the motion mattered. See VolumeMotion::max_displacement_mm.

pub fn rotation_spread_deg(&self) -> f64

The largest angle between any two volumes’ recovered B0 directions, in degrees.

This, not the rotation relative to the reference, is what decides whether the series can be averaged: it is the spread of dipole-kernel orientations the average would be taken over. Zero for a series that only translated, however far it translated.

pub fn suspect(&self) -> impl Iterator<Item = &VolumeMotion>

The volumes whose estimate looks untrustworthy. See VolumeMotion::suspect.

pub fn apply(&self, t: usize, data: &[f64]) -> Option<Vec<f64>>

Resample volume t’s continuous data (magnitude, an unwrapped field map, χ) onto the reference grid.

Not for wrapped phase. Interpolating wrapped phase directly turns every wrap into a band of wrong values; use Self::apply_complex, which is why it exists.

pub fn apply_complex( &self, t: usize, magnitude: &[f64], phase: &[f64], ) -> Option<(Vec<f64>, Vec<f64>)>

Resample volume t’s magnitude and wrapped phase onto the reference grid together, interpolating mag·e^{iφ} so the wraps survive. Returns (magnitude, phase).

pub fn apply_mask(&self, t: usize, mask: &[u8]) -> Option<Vec<u8>>

Resample volume t’s binary mask or label volume onto the reference grid (nearest neighbour).

pub fn coverage(&self, t: usize) -> Option<Vec<u8>>

Which reference voxels volume t reaches at all.

A rotated volume cannot fill the whole reference grid, and resampling leaves zeros where it does not reach. Those zeros are “no data”, not a zero measurement, and this is what tells them apart.

pub fn common_coverage(&self) -> Option<Vec<u8>>

Reference voxels that every volume of the series reaches.

pub fn average_complex<T: AsRef<[f64]>>( &self, magnitudes: &[T], phases: &[T], ) -> Option<MotionAverage>

Complex-average the series onto the reference grid: resample every volume’s magnitude/phase pair through its recovered transform, then take the complex mean over the volumes that reached each voxel.

The plain complex mean, not a magnitude-weighted one: for repeats with the same noise level that is the maximum-likelihood combination, and weighting by magnitude would bias the result toward whichever volume happened to be brightest.

Read MotionAverage before using this on a series that rotated.

Returns None if the number of magnitude or phase volumes disagrees with the series, or if any volume’s length disagrees with its own grid.

Trait Implementations

impl Clone for MotionSeries

fn clone(&self) -> MotionSeries

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MotionSeries

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

Formats the value using the given formatter.