cross_bones.plotting¶

Some basic plotting procedures used throughout cross_bones

Functions¶

`plot_astrometric_offsets`(→ matplotlib.pyplot.axes)	Plot the relative astrometry between two catalogues
`plot_beam_locations`(→ matplotlib.pyplot.axes)	Plot the rough centre of the catalogues, and optionally present a pair of catalogues
`plot_offset_grid_space`(→ None)	Plot the offset surface of a match
`plot_offsets_in_field`(→ None)	Create a figure of each of the `OffsetGridSpace` where

cross_bones.plotting.plot_astrometric_offsets(catalogue_1: cross_bones.catalogue.Catalogue, catalogue_2: cross_bones.catalogue.Catalogue, ax: matplotlib.pyplot.axes | None = None) → matplotlib.pyplot.axes¶

Plot the relative astrometry between two catalogues

Parameters:

catalogue_1 (Catalogue) – The first catalogue
catalogue_2 (Catalogue) – The second catalogue
ax (plt.axes | None, optional) – Where to plot. If None it is created on a new Figure. Defaults to None.

Returns:

The axes where drawing occurred

Return type:

plt.axes

cross_bones.plotting.plot_beam_locations(catalogues: cross_bones.catalogue.Catalogues, catalogue_1: cross_bones.catalogue.Catalogue | None = None, catalogue_2: cross_bones.catalogue.Catalogue | None = None, ax: matplotlib.pyplot.axes | None = None) → matplotlib.pyplot.axes¶

Plot the rough centre of the catalogues, and optionally present a pair of catalogues

Parameters:

catalogues (Catalogues) – Collection of catalogues to plot
catalogue_1 (Catalogue | None, optional) – The first catalogue of a pair. Defaults to None.
catalogue_2 (Catalogue | None, optional) – The second catalogue of a pair. Defaults to None.
ax (plt.axes | None, optional) – An axes object to plot onto. If None, it will be created. Defaults to None.

Returns:

The axes object that was plotted to

Return type:

plt.axes

cross_bones.plotting.plot_offset_grid_space(fname: str | pathlib.Path, offset_grid_space: cross_bones.matching.OffsetGridSpace, window: tuple[float, float, float, float, float]) → None¶

Plot the offset surface of a match

Parameters:

fname (str | Path) – The output file name to write
offset_grid_space (OffsetGridSpace) – The constructed offset surface
window (tuple[float, float, float, float, float]) – Details on the extent of the surface (min and max)

cross_bones.plotting.plot_offsets_in_field(offset_results: list[cross_bones.matching.OffsetGridSpace | None], windows: list[tuple[float, float, float, float, float]], fname: str | pathlib.Path) → None¶

Create a figure of each of the OffsetGridSpace where each surface is its own panel

Parameters:

offset_results (list[OffsetGridSpace]) – The characterised surfaces to plot
fname (str | Path) – The output file name