ignore2d_image
- sherpa.astro.ui.ignore2d_image(ids: IdType | Sequence[IdType] | None = None) None
Exclude pixels using the region defined in the image viewer.
Exclude points that lie within the region defined in the image viewer.
Changed in version 4.15.0: The change in the filter is now reported for the dataset.
- Parameters:
ids (int, str, None, or sequence of int or str, optional) – The data set, or sets, to ignore. If
None
(the default) then the default identifier is used, as returned byget_default_id
.
See also
ignore2d
Exclude a spatial region from an image.
notice2d
Include a spatial region of an image.
notice2d_image
Include pixels using the region defined in the image viewer.
set_coord
Set the coordinate system to use for image analysis.
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 ignore points from the default data set.
>>> ignore2d_image()
Ignore points in the data set labelled “2”.
>>> ignore2d_image(2)
Ignore points in data sets “src” and “bg”.
>>> ignore2d_image(["src", "bg"])