image_xpaset

Synopsis

Send data to ds9 using XPA.

Syntax

image_xpaset( arg )

Description

The image_xpaset() function is used to send data to the SAO imager, ds9; it provides a simple, user-friendly interface which is similar to the xpaset command-line tool [http://hea-www.harvard.edu/saord/xpa/programs.html#xpaset] from the XPA package. A call to the function image_xpaset("file foo.fits") would translate to 'xpaset -p ds9 file foo.fits' on the command line.

arg - string value; "arg" in the command-line syntax 'xpaget -p ds9 arg'.

Example

sherpa> image_xpaset("file foo.fits")
sherpa> image_xpaset("frame new")
sherpa> image_xpaset("grid yes")
sherpa> image_xpaset("regions foo.reg")
sherpa> image_xpaset("saveimage jpeg foo.jpg")
sherpa> image_xpaset("wcs replace file foo.wcs")

The image_xpaset function accepts one string argument, using it as the command 'xpaset -p ds9 arg'. For example, to send ds9 an image file to display (foo.fits), one would use "file foo.fits" as the argument. Likewise, "frame new" will replace the current frame displayed in ds9 with a new, blank frame; "regions foo.reg" will load the region "foo.reg" to the display, and so on.

Bugs

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