API Reference

xpunwrap.algos_available() dict[str, Callable[[...], Any]][source]

Return all available phase unwrapping algorithms.

Returns:

  • Mapping from algorithm name to callable, in the order

  • algo_ls_poisson, algo_ls_poisson_pg, algo_ls_weighted,

  • algo_skimage_unwrap.

Algorithms

algorithms.algo_ls_poisson

Batched 2D phase unwrapping using a least-squares Poisson solver.

algorithms.algo_ls_poisson_pg

Least-squares unwrapping with periodic gradient enforcement.

algorithms.algo_ls_weighted

Weighted least-squares unwrapping with border masking.

algorithms.algo_skimage_unwrap

2D phase unwrapping using scikit-image's CPU implementation.