Skip to main content

2D and 3D phase unwrapping

Project description

This is a Python wrapper for 2D and 3D phase unwrapping code based on:

More information about the code can be found on GERI homepage: 2D, 3D. The general principle and applications are the same as those for a 1D unwrap available in numpy.


The package is based on cffi and requires it for installation:

$ pip install cffi
$ pip install unwrap

The interface consists of a single function:

>>> from unwrap import unwrap
>>> unwrapped_array = unwrap(
...    wrapped_array,
...    wrap_around_axis_0=False,
...    wrap_around_axis_1=False,
...    wrap_around_axis_2=False)

It takes a 2- or 3-dimensional numpy array of floats, wrapped_array, and returns an array with the same shape with the values changed by integer multiples of 2 pi such that the whole array has the least amount of jumps.

wrapped_array can be a masked array, in this case masked entries are ignored during the phase unwrapping process. This is useful if the wrapped phase data has holes or contains invalid entries.

If the optional arguments wrap_around_axis_0 etc. are set to True, then phase unwrapping takes place also across the boundaries of the specified axis, i.e., the first and last pixel along this axis are assumed to be neighbours.

Internally the wrapped array is converted to a C-contiguous array of np.float32, therefor the unwrapped array also has this data type.

Usage examples can be found in test/


The original C code by the authors mentioned above has been slightly modified by Gregor Thalhammer for using it as a library. Bogdan Opanchuk changed the Python wrapper to use cffi instead of Cython and improved packaging.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
unwrap-0.1.1-cp27-none-macosx_10_6_intel.whl (58.5 kB) Copy SHA256 hash SHA256 Wheel 2.7
unwrap-0.1.1-cp27-none-win_amd64.whl (39.1 kB) Copy SHA256 hash SHA256 Wheel 2.7
unwrap-0.1.1.tar.gz (18.5 kB) Copy SHA256 hash SHA256 Source None
unwrap-0.1.1.win32-py2.7.exe (234.7 kB) Copy SHA256 hash SHA256 Windows Installer 2.7 (264.3 kB) Copy SHA256 hash SHA256 Windows Installer 2.7

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page