get_compass_info#

jdaviz.configs.imviz.wcs_utils.get_compass_info(image_wcs, image_shape, r_fac=0.4)[source]#

Calculate WCS compass parameters. North (N) is up and East (E) is left.

Parameters:
image_wcsobj

WCS that is compatible with APE 14.

image_shapetuple of int

Shape of the image in the form of (ny, nx).

r_facfloat

Scale factor for compass arrow length.

Returns:
x, yfloat

Pixel positions for the center of the compass.

xn, ynfloat

Pixel positions for N of the compass.

xe, yefloat

Pixel positions for E of the compass.

degn, degefloat

Rotation angles for N and E, in degrees, for the compass, respectively.

xflipbool

Should display flip on X?