Skip to main content

unwrap_bestpath

Function unwrap_bestpath 

Source
pub fn unwrap_bestpath(
    phase: &[f64],
    mask: &[u8],
    params: &BestPathParams,
    grid: &Grid,
) -> Vec<f64>
Expand description

Unwrap a 3D phase volume with the best-path (3D-SRNCP) algorithm.

§Arguments

  • phase — wrapped phase in radians, nx * ny * nz, expected in [-π, π]
  • mask — binary mask, non-zero to process
  • params — see BestPathParams
  • grid — volume dimensions (voxel sizes are unused: the reliability is defined on the voxel lattice, not in physical space)

§Returns

Unwrapped phase, same length as phase. Voxels outside the mask are returned unchanged.

Each connected in-mask component is unwrapped independently and carries its own arbitrary multiple of 2π; there is no information linking components across a gap in the mask.