Last modified: December 2020

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/notice2d_image.html
Jump to: Description · Examples · PARAMETERS · Notes · Bugs · See Also


AHELP for CIAO 4.13 Sherpa v1

notice2d_image

Context: filtering

Synopsis

Include pixels using the region defined in the image viewer.

Syntax

notice2d_image(ids=None)

ids - int or str, or sequence of int or str, optional

Description

Include points that lie within the region defined in the image viewer.


Examples

Example 1

Use the region in the image viewer to include points from the default data set.

>>> notice2d_image()

Example 2

Include points in the data set labelled "2".

>>> notice2d_image(2)

Example 3

Include points in data sets "src" and "bg".

>>> notice2d_image(["src", "bg"])

PARAMETERS

The parameter for this function is:

Parameter Definition
ids The data set, or sets, to use. If none (the default) then the default identifier is used, as returned by `get_default_id` .

Notes

The region definition is converted into the coordinate system relevant to the data set before it is applied.


Bugs

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

See Also

filtering
ignore2d, ignore2d_image, notice2d