Chandra X-Ray Observatory
	(CXC)
Skip to the navigation links
Last modified: December 2013

URL: http://cxc.harvard.edu/sherpa/ahelp/ignore2d.html
Jump to: Description · Examples · Bugs · See Also


AHELP for CIAO 4.6 Sherpa v1

ignore2d

Context: filtering

Synopsis

Apply an exclude region filter to all 2-D data sets

Syntax

ignore2d( [val] )

Description

Specifies a region mask to be excluded from all available 2-D data sets in a Sherpa session, using CIAO region syntax or a region file.

  • val - a filter defined by CIAO region syntax or a FITS or ASCII 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".

Example 1

sherpa> ignore2d()

The function ignore2d can be called with no arguments, in which case the filter will ignore all data points on the grid for all available 2-D data set ID(s).

Example 2

sherpa> ignore2d("circle(25,25,5)")
sherpa> ignore2d("circle(4300,3710,15)")
sherpa> ignore2d("circle(259.18823,67.14189,0.01)")

Supplying a region string in CIAO region syntax, such as "circle(x_center, y_center, radius)" in physical coordinates, will apply the region filter to all available 2-D data set ID(s).

Example 3

sherpa> !cat filter.reg
circle(4070,3940,6)
sherpa> ignore2d("filter.reg")

The ASCII region file filter.reg is used to filter all 2-D data sets. In this case we exclude all pixels within the circle centered at 4070,3940 and with a radius of 6.

Bugs

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

See Also

data
group
filtering
get_filter, ignore, ignore2d_id, ignore_bad, ignore_id, notice, notice2d, notice2d_id, notice_id, show_filter

Last modified: December 2013
Smithsonian Institute Smithsonian Institute

The Chandra X-Ray Center (CXC) is operated for NASA by the Smithsonian Astrophysical Observatory. 60 Garden Street, Cambridge, MA 02138 USA.   Email:   cxcweb@head.cfa.harvard.edu Smithsonian Institution, Copyright © 1998-2014. All rights reserved.