add_region

ginga.util.ap_region.add_region(canvas, r, tag=None, redraw=True)[source]

Convenience function to plot an astropy-regions object on a Ginga canvas.

Parameters:
canvasDrawingCanvas

The Ginga canvas on which the region should be plotted.

rsubclass of PixelRegion

The region object to be plotted

tagstr or None (optional, default: None)

Caller can optionally pass a specific tag for the canvas object

redrawbool (optional, default: True)

True if the viewers of the canvas should be updated immediately