imshow_pupil_phase¶
-
hcipy.plotting.imshow_pupil_phase(pupil_phase, grid=None, phase_limits=None, vmin=None, vmax=None, cmap=None, colorbar=True, colorbar_orientation='vertical', title=None, crosshairs=False, remove_piston=False, ax=None, **kwargs)¶ Display a pupil phase pattern in a nice, consistent format.
- Parameters
- pupil_phaseField or Wavefront
The pupil that we want to display. If it is a wavefront or complex, the phase will be used as the phase, and the amplitude will be applied as mask.
- gridGrid or None
If we want to redefine the grid of the pupil.
- phase_limitsscalar
The minimum and maximum of the pupil phase. If it is not given, and vmin and vmax are not given either, it will be estimated from the data. If the range is sufficiently close to 2 pi, the range will be extended to 2 pi. The vmin and vmax, unless overridden, will be set to -phase_limits and phase_limits, so the phase will be centered around zero.
- vminscalar, optional
The minimum of the colorbar.
- vmaxscalar, optional
The maximum of the colorbar.
- cmapmatplotlib.cm.Colormap instance
The colormap to use. If default, it will be taken from the configuration file.
- colorbarboolean
Whether to draw a colorbar on the image. Default: True.
- colorbar_orientation[‘horizontal’, ‘vertical’]
How the colorbar should be oriented.
- titlestring, optional
Give the image a title. If this is not given, no title will be displayed.
- crosshairsboolean
Whether to draw crosshairs at the image center. Default: False.
- remove_pistonboolean
Whether to remove piston from the phase. Default: False.
- axmatplotlib axes
The axes which to draw on. If it is not given, the current axes will be used.
- kwargsdictionary
Any keyword arguments will be sent to imshow_field().