draw_compass_mpl#

jdaviz.configs.imviz.wcs_utils.draw_compass_mpl(image, orig_shape=None, wcs=None, show=True, zoom_limits=None, **kwargs)[source]#

Visualize the compass using Matplotlib.

Parameters:

imagendarray: 2D Numpy array (can be resampled).
orig_shapetuple of int or None: The original (non-resampled) array shape in (ny, nx), if different.
wcsobj or None: Associated original image WCS that is compatible with APE 14. If None given, compass is not drawn.
showbool: Display the plot.
zoom_limitsndarray or None: If not None, also draw a rectangle to represent the current zoom limits in the form of list of (x, y) representing the four corners of the zoom box.
kwargsdict: Keywords for matplotlib.pyplot.imshow.

Returns: