Last modified: December 2023

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


AHELP for CIAO 4.16 Sherpa

image_xpaset

Context: visualization

Synopsis

Return the result of an XPA call to the image viewer.

Syntax

image_xpaset(arg, data=None)

arg - str
data - optional

Description

Send a command to the image viewer.


Examples

Example 1

Change the zoom setting of the active frame:

>>> image_xpaset('zoom 4')

Example 2

Overlay the coordinate grid on the current frame:

>>> image_xpaset('grid yes')

Example 3

Add the region file 'src.reg' to the display:

>>> image_xpaset('regions src.reg')

Example 4

Create a png version of the image being displayed:

>>> image_xpaset('saveimage png /tmp/img.png')

PARAMETERS

The parameters for this function are:

Parameter Definition
arg A command to send to the image viewer via XPA.
data The data for the command.

Notes

The XPA access point of the ds9 image viewer lets commands and queries to be sent to the viewer.


Bugs

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

See Also

data
load_image, pack_image, unpack_image
modeling
image_model, image_model_component, image_source, image_source_component
psfs
image_kernel
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_setregion, image_xpaget