get_data_image

sherpa.astro.ui.get_data_image(id: IdType | None = None)

Return the data used by image_data.

Parameters:

id (int, str, or None, optional) – The data set. If not given then the default identifier is used, as returned by get_default_id.

Returns:

data_img – The y attribute contains the ratio values as a 2D NumPy array.

Return type:

a sherpa.image.DataImage instance

Raises:

• sherpa.utils.err.DataErr – If the data set is not 2D.

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

See also

contour_data

Contour the values of an image data set.

image_data

Display a data set in the image viewer.

Examples

Return the image data for the default data set:

>>> dinfo = get_data_image()
>>> dinfo.y.shape
(150, 175)