API reference#

The full public API is re-exported from the top-level package, so everything documented here is reachable as skyplothelper.<name> (conventionally sph.<name>). The reference is grouped by subsystem; each page lists its public functions and classes with auto-generated signatures from the source.

Frames & figures

make_wcs_frame, figure builders, the projection registry, and project.

Frames & figures
Coordinates & math

Frame conversions, sexagesimal helpers, angular distances, wrapping utilities.

Coordinates & math
FITS headers

Header coordinate grids, pixel/sky conversions, beam parameters, diagnostics.

FITS headers
Ticks & labels

RA/Dec tick formatters, offset ticks, VLBI hybrid labels, curved lon ticks.

Ticks & labels
Overlays

Planes, survey footprints, constellations, beams, rulers, reticles, annotations.

Overlays
Images

Clip / stretch / normalize, quicklook figures, reprojection.

Images
HEALPix

Binning, plotting across frames, queries, smoothing, and resolution changes.

HEALPix
Geometry & regions

Geodesic circles, bands, polygons, Tissot indicatrices, and CompoundRegion.

Geometry & regions
Globes & planets

Orthographic globes, Earth-feature overlays, nightshade, inset axes.

Globes & planets
Cone frames

Cosmological cone / pie-wedge plots, twin radial axes, bowtie frames.

Cone frames
Science modules

Mutual sky visibility (co-visibility) and vector spherical harmonics.

Science modules
Legends

MultiLegend and the per-channel blocks: color, shape, size, fill, and more.

Legends
Utilities

Styling, grids, catalog plots, the cartopy backend, queries, and constants.

Utilities
Interactive (plotly)

The plotly export backend, overlays, and the Dash FITS viewer.

Interactive (plotly)