ptypy.utils.plot_utils.rmphaseramp#

ptypy.utils.plot_utils.rmphaseramp(a, weight=None, return_phaseramp=False)#

Attempts to remove the phase ramp in a two-dimensional complex array a.

Parameters:
  • a (ndarray) – Input image as complex 2D-array.

  • weight (ndarray, str, optional) – Pass weighting array or use 'abs' for a modulus-weighted phaseramp and Non for no weights.

  • return_phaseramp (bool, optional) – Use True to get also the phaseramp array p.

Returns:

  • out (ndarray) – Modified 2D-array, out=a*p

  • p (ndarray, optional) – Phaseramp if return_phaseramp = True, otherwise omitted

Examples

>>> b = rmphaseramp(image)
>>> b, p = rmphaseramp(image , return_phaseramp=True)