uvex_transients.utils.plotting.plot_healpix_map#

uvex_transients.utils.plotting.plot_healpix_map(values: NDArray, *, nside: int | None = None, order: str | None = None, title: str | None = None, cbar_label: str | None = None, cmap: str | Colormap | None = None, fig: Figure | None = None, ax: Axes | None = None, fig_size: tuple = (10, 5.5), s: float = 4) → tuple[Figure, Axes][source]#

Aitoff-projected scatter of a full-sky HEALPix map, log-color-scaled.

Non-positive and non-finite pixels are dropped rather than plotted, since every diagnostic this is meant for (a ~uvex_transients.surveys.base.SurveySchedule per-pixel count, separation, or duration) is strictly positive, and the color scale is always logarithmic.

Parameters:

  • values (array-like) – Per-pixel values, ordered to match a HEALPix map at nside/order (i.e. length 12 * nside**2).

  • nside (int, str, optional) – HEALPix resolution/ordering for values; see ~uvex_transients.utils.resolve_healpix_resolution for the shared default.

  • order (int, str, optional) – HEALPix resolution/ordering for values; see ~uvex_transients.utils.resolve_healpix_resolution for the shared default.

  • title (str, optional) – Axes title.

  • cbar_label (str, optional) – Colorbar label.

  • cmap (str or matplotlib.colors.Colormap, optional) – Defaults to get_default_cmap.

  • fig (matplotlib.figure.Figure, matplotlib.axes.Axes, optional) – Existing figure/axes to draw onto, via resolve_fig_axes; ax, if given, must already carry an "aitoff" projection.

  • ax (matplotlib.figure.Figure, matplotlib.axes.Axes, optional) – Existing figure/axes to draw onto, via resolve_fig_axes; ax, if given, must already carry an "aitoff" projection.

  • fig_size (tuple, optional) – Passed to resolve_fig_axes when creating a new figure.

  • s (float, optional) – Marker size, forwarded to ~matplotlib.axes.Axes.scatter.

Returns: