slmsuite.holography.analysis.image_remove_vortices#

image_remove_vortices(phase_image, mask=None, return_vortices_negative=False)[source]#

Find and then remove all the phase vortices in a phase image.

Parameters:

  • phase_image (array_like) – Image to remove vortices upon.

  • mask (array_like OR None) – Removes vortices whose coordinates are inside this mask. The full phase image is changed, even outside the mask.

  • return_vortices_negative (bool) – If False, the original image is modified in-place with vortices removed inside the mask and returned. If True, what would be added to the original image is returned instead.

Returns:

The image or vortices, depending upon return_vortices

Return type:

phase_image