skimage 0.17.2

ParametersRaisesReturnsBackRef
unwrap_phase(image, wrap_around=False, seed=None)

From an image wrapped to lie in the interval [-pi, pi), recover the original, unwrapped image.

Parameters

image : 1D, 2D or 3D ndarray of floats, optionally a masked array

The values should be in the range [-pi, pi). If a masked array is provided, the masked entries will not be changed, and their values will not be used to guide the unwrapping of neighboring, unmasked values. Masked 1D arrays are not allowed, and will raise a :None:None:`ValueError`.

wrap_around : bool or sequence of bool, optional

When an element of the sequence is :None:None:`True`, the unwrapping process will regard the edges along the corresponding axis of the image to be connected and use this connectivity to guide the phase unwrapping process. If only a single boolean is given, it will apply to all axes. Wrap around is not supported for 1D arrays.

seed : int, optional

Unwrapping 2D or 3D images uses random initialization. This sets the seed of the PRNG to achieve deterministic behavior.

Raises

ValueError

If called with a masked 1D array or called with a 1D array and wrap_around=True .

Returns

image_unwrapped : array_like, double

Unwrapped image of the same shape as the input. If the input :None:None:`image` was a masked array, the mask will be preserved.

Recover the original from a wrapped phase image.

Examples

This example is valid syntax, but we were not able to check execution
>>> 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
See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

skimage.restoration.unwrap.unwrap_phase

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /skimage/restoration/unwrap.py#10
type: <class 'function'>
Commit: