ReconstructedWave¶

class shampoo.ReconstructedWave(reconstructed_wave)[source] [edit on github]¶

Container for reconstructed waves and their intensity and phase arrays.

Attributes Summary

`intensity`	Reconstructed intensity (`ndarray`, real)
`phase`	Reconstructed, unwrapped phase (`ndarray`, real)
`reconstructed_wave`	Reconstructed wave (`ndarray`, complex)

Methods Summary

plot([phase, intensity, all, cmap]) Plot the reconstructed phase and/or intensity images.

Attributes Documentation

phase¶

Reconstructed, unwrapped phase (ndarray, real)

Phase unwrapping comes from unwrap_phase.

Methods Documentation

plot(phase=False, intensity=False, all=False, cmap=<matplotlib.colors.LinearSegmentedColormap object>)[source] [edit on github]¶

Plot the reconstructed phase and/or intensity images.

Parameters:

phase : bool

Toggle unwrapped phase plot. Default is False.

intensity : bool

Toggle intensity plot. Default is False.

all : bool

Toggle unwrapped phase plot and . Default is False.

cmap : Colormap

Matplotlib colormap for phase and intensity plots.

Returns

——-

fig : Figure

Matplotlib figure object

Matplotlib axis object