observation

Contents

observation#

scarlet2.plot.observation(observation, norm=None, channel_map=None, sky_coords=None, show_psf=False, add_labels=True, split_channels=False, fig_kwargs=None, title_kwargs=None, label_kwargs=None)[source]#

Plot observation

Show entire content of observation, optionally with list of sources given by sky_coords or a PSF image.

Parameters:

  • observation (Observation) – The observation object to plot

  • norm (Norm, optional) – Norm to scale the intensity of observation into RGB 0..256

  • channel_map (array, optional) – Linear mapping from channels to RGB, dimensions (3, channels)

  • sky_coords (list, optional) – 2D coordinates (in pixel coordinates or sky coordinates). If in sky coordinates, the Frame of observation needs to have a valid WCS.

  • show_psf (bool, optional) – Whether to plot a panel with the PSF model of observation centered in the middle

  • add_labels (bool, optional) – Whether to plot a text label with the running number for each of the sources in sky_coords

  • split_channels (bool, optional) – Whether to split the observation into separate channels

  • fig_kwargs (dict, optional) – Additional arguments for mpl.subplots

  • title_kwargs (dict, optional) – Additional arguments for mpl.set_title

  • label_kwargs (dict, optional) – Additional arguments for mpl.text. Default is None and will be set to {“color”: “w”, “ha”: “center”, “va”: “center”}

Return type:

mpl.Figure

Contents