sources

Contents

sources#

scarlet2.plot.sources(scene, observation=None, norm=None, channel_map=None, show_model=True, show_observed=False, show_rendered=False, show_spectrum=True, model_mask=None, add_labels=False, add_boxes=False, fig_kwargs=None, title_kwargs=None, label_kwargs=None, box_kwargs=None)[source]#

Plot all sources in scene

Creates one figure, with each source in scene occupying one row. Depending on the chosen options, multiple panels per source will be created.

Parameters:

  • scene (Scene) – The scene object containing the sources and their models

  • observation (Observation, optional) – The observation to render the sources for, or to show the data of. Only needed when show_observed or show_rendered is True.

  • 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)

  • show_model (bool, optional) – Whether to show the internal model of each source

  • show_observed (bool, optional) – Whether to show the observations in the same region as the source

  • show_rendered (bool, optional) – Whether to show the model of each source rendered into the frame of observation

  • show_spectrum (bool, optional) – Whether to show the spectrum of each source

  • model_mask (array, optional) – A mask to apply to the model. If not given, no mask is applied

  • add_labels (bool, optional) – Whether each source is labeled with its numerical index in the source list

  • add_boxes (bool, optional) – Whether to plot the bounding box of each source

  • 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.plot of the source centers. Defaults to {“color”: “w”, “marker”: “x”, “mew”: 1, “ms”: 10}

  • box_kwargs (dict, optional) – Additional arguments for mpl.Polygon. Defaults to {“facecolor”: “none”, “edgecolor”: “w”, “lw”: 0.5}

Return type:

mpl.Figure

Contents