wcsaxes_heliographic_overlay#
- sunpy.visualization.wcsaxes_compat.wcsaxes_heliographic_overlay(axes, grid_spacing: Unit("deg") = <Quantity 10. deg>, annotate=True, obstime=None, rsun=None, observer=None, system='stonyhurst', **kwargs)[source]#
Create a heliographic overlay using
WCSAxes
.Will draw a grid and label the top axes.
- Parameters:
axes (
WCSAxes
) – TheWCSAxes
object to create the overlay on.grid_spacing (
Quantity
) – Spacing for longitude and latitude grid in degrees.annotate (
bool
) – PassingFalse
disables the axes labels and the ticks on the top and right axes.obstime (
Time
) – Theobstime
to use for the grid coordinate frame.rsun (
Quantity
) – Thersun
to use for the grid coordinate frame.observer (
SkyCoord
) – Theobserver
to use for the grid coordinate frame. Only used for Carrington coordinates.system (str) – Coordinate system for the grid. Must be ‘stonyhurst’ or ‘carrington’. If ‘carrington’, the
observer
keyword argument must be specified.kwargs – Additional keyword arguments are passed to
astropy.visualization.wcsaxes.CoordinateHelper.grid()
.
- Returns:
WCSAxes
– The overlay object.
Notes
Keywords are passed to
grid
.