ignore2d

sherpa.astro.ui.ignore2d(val=None)

Exclude a spatial region from all data sets.

Select a spatial region to exclude in the fit. The filter is applied to all data sets.

Parameters: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

notice2d()

Include a spatial region from all data sets.

notice2d_id()

Include a spatial region of a data set.

notice2d_image()

Select the region to include from the image viewer.

ignore2d_id()

Exclude a spatial region from a data set.

ignore2d_image()

Select the region to exclude from the image viewer.

Notes

The region syntax is described in the notice2d function.

Examples

Exclude points that fall within the two regions:

>>> ignore2d('ellipse(200,300,40,30,-34)')
>>> ignore2d('box(40,100,30,40)')

Use a region file called ‘reg.fits’, by using either:

>>> ignore2d('reg.fits')

or

>>> ignore2d('region(reg.fits)')

Exclude all points.

>>> ignore2d()