platawiec / unwrap.jl

Phase unwrapping in native Julia

Unwrap

Notice

This functionality has been moved into the DSP.jl package. Please see the DSP.jl documentation for changes to the function signature.

Introduction

This is a pure Julia implementation for 1D, 2D, 3D and arbitrary-D phase unwrapping code based on:

• (2D) M. A. Herráez, D. R. Burton, M. J. Lalor, and M. A. Gdeisat, "Fast two-dimensional phase-unwrapping algorithm based on sorting by reliability following a noncontinuous path", Applied Optics, Vol. 41, Issue 35, pp. 7437-7444 (2002) <http://dx.doi.org/10.1364/AO.41.007437>_,
• (3D) H. Abdul-Rahman, M. Gdeisat, D. Burton, M. Lalor, "Fast three-dimensional phase-unwrapping algorithm based on sorting by reliability following a non-continuous path", Proc. SPIE 5856, Optical Measurement Systems for Industrial Inspection IV, 32 (2005) <http://dx.doi.ogr/doi:10.1117/12.611415>_.

More information about the code can be found on GERI homepage:

Installation

Run Pkg.clone("https://github.com/platawiec/Unwrap.jl").

Usage

The interface consists of a single function, unwrap:

using Unwrap
unwrapped_array = unwrap(wrapped_array)

where wrapped_array is an AbstractArray. There is also an in-place version, unwrap!(A) which mutates A. The returned array will have the same precision as A (i.e. BigFloat, Float32, etc. work). Type ?unwrap for more.

1D, 2D, and 3D unwrapping are all supported, as well as arbitrary dimensions, for whatever reason.

See Also

The package DSP.jl provides the one-dimensional version of unwrap! and unwrap. This package will live and be maintained in the JuliaDSP ecosystem.

Acknowledgments

Outside of the cited papers, interface and inspiration also taken from python's phase-unwrap: https://github.com/geggo/phase-unwrap

unwrap.jl's Issues

mention DSP.jl

might want to mention in your README there is similar functionality (for 1D) in https://github.com/JuliaDSP/DSP.jl/blob/8570a71120e67e7790a968e9ab4c8ee3696ae784/src/util.jl#L54-L66

better yet, maybe combine forces and make a PR there? or move this package into the Julia DSP org so it's easier to find?

3D Phase unwrapping

Implement the 3D phase unwrapping code (see README)

Links to GERI homepage are not working

The README contains links that are not valid anymore