phase_retrieval#
- DPCSignal2D.phase_retrieval(method='kottler', mirroring=False, mirror_flip=False)[source]#
Retrieve the phase from two orthogonal phase gradients.
- Parameters:
method (‘kottler’, ‘arnison’ or ‘frankot’, optional) – the formula to use, kottler [1] , arnison [2] and frankot [3] are available. The default is ‘kottler’.
mirroring (bool, optional) – whether to mirror the phase gradients before Fourier transformed. Attempt to reduce boundary effect. The default is False.
mirror_flip (bool, optional) – only active when ‘mirroring’ is True. Flip the direction of the derivatives which results in negation during signal mirroring. The default is False. If the retrieved phase is not sensible after mirroring, set this to True may resolve it.
- Raises:
ValueError – If the method is not implemented
- Returns:
signal – the phase retrieved.
- Return type:
HyperSpy 2D signal
References
Examples
>>> s = pxm.data.dummy_data.get_square_dpc_signal() >>> s_phase = s.phase_retrieval() >>> s_phase.plot()