Last modified: December 2020

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


AHELP for CIAO 4.13 Sherpa v1

image_setregion

Context: visualization

Synopsis

Set the region to display in the image viewer.

Syntax

image_setregion(reg, coord='')

reg - str
coord - str, optional

Examples

Example 1

Add a circle, in the physical coordinate system, to the data from the default data set:

>>> image_data()
>>> image_setregion('circle(4234.53,3245.29,46.74)', 'physical')

Example 2

Copy the region from the current frame, create a new frame displaying the residuals from data set 'img', and then display the region on it:

>>> r = image_getregion()
>>> image_resid('img', newframe=True)
>>> image_setregion(r)

PARAMETERS

The parameters for this function are:

Parameter Definition
reg The region to display.
coord The coordinate system to use.

Bugs

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

See Also

confidence
set_conf_opt, set_covar_opt, set_proj_opt
data
load_image, pack_image, set_areascal, set_arf, set_backscal, set_bkg, set_coord, set_counts, set_data, set_dep, set_exposure, set_grouping, set_quality, set_rmf, set_staterror, set_syserror, unpack_image
filtering
set_filter
methods
set_iter_method, set_iter_method_opt, set_method, set_method_opt
modeling
get_par, get_xsabund, get_xscosmo, get_xsxsect, get_xsxset, image_model, image_model_component, image_source, image_source_component, set_bkg_model, set_bkg_source, set_full_model, set_model, set_par, set_pileup_model, set_source, set_xsabund, set_xscosmo, set_xsxsect, set_xsxset
psfs
image_kernel
statistics
set_prior, set_sampler, set_sampler_opt, set_stat
utilities
set_analysis, set_default_id
visualization
contour, contour_data, contour_model, contour_ratio, contour_resid, image_close, image_data, image_deleteframes, image_fit, image_getregion, image_open, image_ratio, image_resid, image_xpaget, image_xpaset