ignore2d_id¶
-
sherpa.astro.ui.
ignore2d_id
(ids, val=None)¶ Exclude a spatial region from a data set.
Select a spatial region to exclude in the fit. The filter is applied to the given data set, or sets.
Parameters: - ids (int or str, or array of int or str) – The data set, or sets, to use.
- val (str, optional) – A region specification as a string or the name of a file
containing a region filter. The coordinates system of the
filter is taken from the coordinate setting of the data
sets (set_coord). If
None
, then all points are included.
See also
ignore2d()
- Exclude a spatial region from all data sets.
ignore2d_image()
- Select the region to exclude from the image viewer.
notice2d()
- Include a spatial region of all data sets.
notice2d_id()
- Include a spatial region from a data set.
notice2d_image()
- Select the region to include from the image viewer.
Notes
The region syntax is described in the notice2d function.
Examples
Ignore the pixels within the rectangle from data set 1:
>>> ignore2d_id(1, 'rect(10,10,20,290)')
Ignore the spatial region in the file srcs.reg:
>>> ignore2d_id(1, 'srcs.reg')
or
>>> ignore2d_id(1, 'region(srcs.reg)')