Synopsis
Exclude pixels using the region defined in the image viewer.
Syntax
ignore2d_image(ids=None)
Description
Exclude points that lie within the region defined in the image viewer.
Examples
Example 1
Use the region in the image viewer to ignore points from the default data set.
>>> ignore2d_image()
Example 2
Ignore points in the data set labelled "2".
>>> ignore2d_image(2)
Example 3
Ignore points in data sets "src" and "bg".
>>> ignore2d_image(["src", "bg"])
PARAMETERS
The parameter for this function is:
| Parameter | Type information | Definition |
|---|---|---|
| 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 by `get_default_id` . |
Notes
The region definition is converted into the coordinate system relevant to the data set before it is applied.
Changes in CIAO
Changed in CIAO 4.15
The change in the filter is now reported for the dataset.
Bugs
See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.
See Also
- filtering
- ignore2d, notice2d, notice2d_image