image_source

sherpa.astro.ui.image_source(id: IdType | None = None, newframe: bool = False, tile: bool = False) → None

Display the source expression for a data set in the image viewer.

This function evaluates and displays the model expression for a data set, without any instrument response.

The image viewer is automatically started if it is not already open.

Parameters:

idint, str, or None, optional: The data set. If not given then the default identifier is used, as returned by get_default_id.
newframebool, optional: Create a new frame for the data? If False, the default, then the data will be displayed in the current frame.
tilebool, optional: Should the frames be tiles? If False, the default, then only a single frame is displayed.

Raises:

sherpa.utils.err.IdentifierErr: If the data set does not exist or a source expression has not been set.

See also

get_source_image: Return the data used by image_source.
image_close: Close the image viewer.
image_fit: Display the data, model, and residuals for a data set in the image viewer.
image_model: Display the model for a data set in the image viewer.
image_model_component: Display a component of the model in the image viewer.
image_open: Open the image viewer.
image_source_component: Display a component of the source expression in the image viewer.

Notes

Image visualization is optional, and provided by the DS9 application.

Examples

Display the source model for the default data set.

>>> image_source()

Display the source model for data set 2 in a new frame so that the data in the current frame is not destroyed. The new data will be displayed in a single frame (i.e. the only data shown by the viewer).

>>> image_source(2, newframe=True)

Display the source models for data sets ‘i1’ and ‘i2’ side by side:

>>> image_source('i1')
>>> image_source('i2', newframe=True, tile=True)