image_data

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

Display a data set in the image viewer.

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.

See also

get_data_image

Return the data used by image_data.

image_close

Close the image viewer.

image_fit

Display the data, model, and residuals for a data set in the image viewer.

image_open

Open the image viewer.

image_source

Display the model for a data set in the image viewer.

Notes

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

Examples

Display the data in default data set.

>>> image_data()

Display 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_data(2, newframe=True)

Display data sets ‘i1’ and ‘i2’ side by side:

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