imshow_psf
- hcipy.plotting.imshow_psf(psf, grid=None, vmin=1e-08, vmax=0.1, scale='log', cmap=None, title=None, normalization='none', crosshairs=False, mark_centroid=False, colorbar=True, colorbar_orientation='vertical', spatial_resolution=1, ax=None, ticks=None, **kwargs)
Display a PSF in a nice, consistent format.
- Parameters:
- psfField or Wavefront
The point spread function that we want to display.
- gridGrid or None
If we want to redefine the grid of the psf.
- vminscalar
The minimum value on the colorbar.
- vmaxscalar
The maximum value on the colorbar.
- scale[‘linear’, ‘log’, ‘logarithmic’]
The scale of the image.
- cmapmatplotlib.cm.Colormap instance
The colormap to use. If default, it will be taken from the configuration file.
- titlestring, optional
Give the image a title. If this is not given, no title will be displayed.
- normalization[‘peak’, ‘total’, ‘none’] or scalar
The type of normalization to apply. ‘peak’ normalizes by the maximum intensity. ‘total’ normalizes by the total intensity, ‘none’ doesn’t do any normalization. If this is a scalar, the PSF will be divided by this number before displaying it.
- crosshairsboolean
Whether to draw crosshairs at the image center. Default: False.
- mark_centroidboolean
Whether to draw a small crosshair at the centroid of the PSF. The centroid will be computed with TODO Default: False.
- colorbarboolean
Whether to draw a colorbar on the image. Default: True.
- colorbar_orientation[‘horizontal’, ‘vertical’]
How the colorbar should be oriented.
- spatial_resolutionscalar
This will be the size of a unit cell on the axes.
- axmatplotlib axes
The axes which to draw on. If it is not given, the current axes will be used.
- ticksarray_like
The ticks on the added colorbar.
- kwargsdictionary
Any keyword arguments will be sent to imshow_field().
- Returns:
- Image
The created image.