Synopsis
Exclude a spatial region from a data set.
Syntax
ignore2d_id(ids, val=None) ids - int or str, or array of int or str val - str, optional
Description
Select a spatial region to exclude in the fit. The filter is applied to the given data set, or sets.
Examples
Example 1
Ignore the pixels within the rectangle from data set 1:
>>> ignore2d_id(1, 'rect(10,10,20,290)')
Example 2
Ignore the spatial region in the file `srcs.reg` :
>>> ignore2d_id(1, 'srcs.reg')
or
>>> ignore2d_id(1, 'region(srcs.reg)')
PARAMETERS
The parameters for this function are:
| Parameter | Definition |
|---|---|
| ids | The data set, or sets, to use. |
| val | 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. |
Notes
The region syntax is described in the `notice2d` function.
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
- data
- group, group_adapt, group_adapt_snr, group_bins, group_counts, group_snr, group_width
- filtering
- get_filter, ignore, ignore2d, ignore_bad, ignore_id, notice, notice2d, notice2d_id, notice_id, show_filter