notice2d_image

sherpa.astro.ui.notice2d_image(ids=None)

Include pixels using the region defined in the image viewer.

Include points that lie within the region defined in the image viewer.

Parameters:ids (int or str, or sequence of int or str, optional) – The data set, or sets, to use. If None (the default) then the default identifier is used, as returned by get_default_id.

See also

ignore2d()

Exclude a spatial region from an image.

ignore2d_image()

Exclude pixels using the region defined in the image viewer.

notice2d()

Include a spatial region of an image.

Notes

The region definition is converted into the coordinate system relevant to the data set before it is applied.

Examples

Use the region in the image viewer to include points from the default data set.

>>> notice2d_image()

Include points in the data set labelled “2”.

>>> notice2d_image(2)

Include points in data sets “src” and “bg”.

>>> notice2d_image(["src", "bg"])