display_psf_difference

poppy.display_psf_difference(hdulist_or_filename1=None, hdulist_or_filename2=None, ext1=0, ext2=0, vmin=None, vmax=0.0001, title=None, imagecrop=None, adjust_for_oversampling=False, crosshairs=False, cmap=None, colorbar=True, colorbar_orientation='vertical', ax=None, return_ax=False, normalize=False, normalize_to_second=False)[source]

Display nicely the difference of two PSFs from given files

The two files may be FITS files on disk or FITS HDUList objects in memory. The two must have the same shape and size.

Parameters:

hdulist_or_filename1, hdulist_or_filename2fits.HDUlist or string: FITS files containing images to difference
ext1, ext2int: FITS extension. default = 0
vmin, vmaxfloat: Image intensity scaling min and max.
titlestring, optional: Title for plot.
imagecropfloat: Size of region to display (default is whole image).
adjust_for_oversamplingbool: Rescale to conserve surface brightness for oversampled PSFs? (Making this True conserves surface brightness but not total flux.) Default is False, to conserve total flux.
crosshairsbool: Plot crosshairs over array center?
cmapmatplotlib.cm.Colormap instance or None: Colormap to use. If not given, use standard gray colormap.
colorbarbool: Draw a colorbar on the image?
colorbar_orientation‘vertical’ (default) or ‘horizontal’: How should the colorbar be oriented? (Note: Updating a plot and changing the colorbar orientation is not supported. When replotting in the same axes, use the same colorbar orientation.)
print_bool: Print RMS difference value for the images? (Default: False)
axmatplotlib.Axes instance: Axes to display into.
return_axbool: Return the axes to the caller for later use? (Default: False) When True, this function returns a matplotlib.Axes instance, or a tuple of (ax, cb) where the second is the colorbar Axes.
normalizebool: Display (difference image)/(mean image) instead of just the difference image. Mutually exclusive to normalize_to_second. (Default: False)
normalize_to_secondbool: Display (difference image)/(second image) instead of just the difference image. Mutually exclusive to normalize. (Default: False)