multicolorfits.overlays.apply_overlays

multicolorfits.overlays.apply_overlays(ax, header=None, *, compass=False, beam=False, scale_bar=False, compass_loc='lower left', beam_loc='lower left', beam_style='crosshair', scale_bar_asec=0.0, scale_bar_loc=4, warn_missing=True, **kwargs)

Apply selected skyplothelper overlays to an existing axes.

Returns a list of overlay artists / handles created. When skyplothelper is not installed and warn_missing is True, emits a UserWarning and returns an empty list.

Parameters:

• ax (Any)

• header (Any | None)

• compass (bool)

• beam (bool)

• scale_bar (bool)

• compass_loc (str)

• beam_loc (str)

• beam_style (str)

• scale_bar_asec (float)

• scale_bar_loc (int)

• warn_missing (bool)

• kwargs (Any)

Return type:

List[Any]