wassname/scikit-image
1
0
Fork 0
mirror of https://github.com/wassname/scikit-image.git synced 2026-06-30 02:39:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

unwrap: Add docstring example.

Browse Source
This commit is contained in:
Jostein Bø Fløystad
2013-07-15 18:33:26 +02:00
parent 27c13a1193
commit b2ac1a5872
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skimage/exposure/unwrap.py
+9
View File
@@ -29,6 +29,15 @@ def unwrap_phase(image, wrap_around=False):
Unwrapped image of the same shape as the input. If the input ``image``
was a masked array, the mask will be preserved.
Examples
--------
>>> c0, c1 = np.ogrid[-1:1:128j, -1:1:128j]
>>> image = 12 * np.pi * np.exp(-(c0**2 + c1**2))
>>> image_wrapped = np.angle(np.exp(1j * image))
>>> image_unwrapped = unwrap_phase(image_wrapped)
>>> np.std(image_unwrapped - image) < 1e-6 # A constant offset is normal
True
References
----------
.. [1] Miguel Arevallilo Herraez, David R. Burton, Michael J. Lalor,