notice2d

Context: py.sherpa

Synopsis

Apply an include filter to all 2D datasets

Syntax

notice2d( [val] )

The notice2d command specifies the region of 2D data to be included in the analysis. The filter is applied to all available dataset ids; to operate on specific ids, use the notice2d_id command ("ahelp notice2d_id").

val - a filter defined by CIAO region syntax or a region filename (including path); default=None

The filter must be defined in the same coordinate system as the "coord" field of the data structure, which is returned by the get_coord command ("ahelp get_coord"). For information on the CIAO region filtering syntax, refer to "ahelp dmregions".

If the region definition on the Sherpa command line contains an arcsec or arcmin symbol, it must be escaped: \" or \' . The symbols do not need to be escaped if they are in a region file.

If no filter is supplied, all data points in all datasets are included. Noticing the entire set is a method of clearing any filters that have been applied.

One-dimensional Data Filtering

To apply an include filter to 1D data, use the notice command ("ahelp notice") or the notice_id command ("ahelp notice_id").

Example 1

sherpa> notice2d()

When the command is called without any filter, all data points in all sets are included.

Example 2

sherpa> notice2d("circle(275,275,50)")

A circular region defined in logical (image) coordinates is used to filter the data.

Example 3

sherpa> notice2d("box(3900.5,4120,189,188,0)+circle(4069,4250,20)")

Filter the data with a complex region (a rectangular plus a circle) in physical coordinates.

Example 4

sherpa> notice2d("/data/src.reg")

Filter the data with the region stored in /data/src.reg. In this case, it is a circular region defined in WCS decimal coordinates:

sherpa> !cat /data/src.reg
# Region file format: DS9 version 4.0
# Filename:
fk5
circle(278.38973,-10.569072,51.998083")

Example 5

sherpa> notice2d("circle(18:33:33.468,-10:34:08.66,42.6351\")")
sherpa> notice2d("wcs.reg")

These commands are two equivalent ways of filtering the data with a region defined in WCS sexagesimal coordinates. The region file contains:

sherpa> !cat ~/src_wcs.reg
circle(18:33:33.468,-10:34:08.66,42.6351")

Note that the arcsec symbol must be escaped on the Sherpa command line (\"), but does not need to be escaped when the region is given in a file.

Bugs

See the bugs pages on the Sherpa website for an up-to-date listing of known bugs.