get_data_contour

sherpa.astro.ui.get_data_contour(id: IdType | None = None, recalc: bool = True, copy: bool = True) → sherpa.plot.DataContour

Return the data used by contour_data.

Changed in version 4.19.0: The contour object is now copied by default. To get the previous behaviour set the copy attribute to False.

Parameters:

idint, str, or None, optional

The data set. If not given then the default identifier is used, as returned by get_default_id.

recalcbool, optional

If False then the results from the last call to contour_data (or get_data_contour) are returned, otherwise the data is re-generated.

copybool, optional

Is the contour object copied before being returned? If so then the contour attributes will not be changed by multiple calls to this routine.

Returns:

resid_dataa sherpa.plot.DataContour instance

The y attribute contains the residual values and the x0 and x1 arrays contain the corresponding coordinate values, as one-dimensional arrays.

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

get_data_image

Return the data used by image_data.

contour_data

Contour the values of an image data set.

image_data

Display a data set in the image viewer.

Examples

Return the data for the default data set:

>>> dinfo = get_data_contour()