Enum OrientationSupport 

pub enum OrientationSupport {
    Arbitrary,
    NotApplicable,
    AxialOnly,
}

Whether an algorithm is valid when B0 does not lie along the voxel +z axis.

The dipole relationship is direction-dependent, and the FFT that implements it lives in the voxel grid, so an oblique acquisition has to be handled deliberately. There are three cases, and the difference matters because getting it wrong is silent — the reconstruction completes and the numbers are simply wrong.

Variants

Arbitrary

The B0 direction is an explicit parameter — the dipole kernel is built from it — so the method reconstructs correctly on the grid the data was acquired on, whatever its orientation. See crate::geometry::b0_direction_from_affine.

NotApplicable

The method never uses B0. The SMV-family background removals rest on the spherical mean value property of harmonic fields, which is rotation-invariant.

AxialOnly

Assumes B0 along +z and offers no way to say otherwise. Deep-learning methods learned the dipole relationship from axially-acquired training data, so there is no direction to rotate; oblique data must be resampled to a cardinal grid first (crate::geometry::resample_complex_to_axial).

Unrolled networks with a physics data-consistency term (LPCNN, MoDL-QSM, NeXtQSM) build that term from the true direction, so they are partly corrected — but their learned prior is still axial, so they belong here.

Implementations

impl OrientationSupport

pub fn requires_axial(&self) -> bool

Whether oblique data must be resampled before this method can be trusted.

Trait Implementations

impl Clone for OrientationSupport

fn clone(&self) -> OrientationSupport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OrientationSupport

impl Debug for OrientationSupport

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

Formats the value using the given formatter.

impl Eq for OrientationSupport

impl PartialEq for OrientationSupport

fn eq(&self, other: &OrientationSupport) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OrientationSupport