image_xpaget

sherpa.astro.ui.image_xpaget(arg)

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

Send a query to the image viewer.

Parameters

arg (str) – A command to send to the image viewer via XPA.

Returns

returnval

Return type

str

Raises
  • sherpa.utils.err.DS9Err – The image viewer is not running.

  • sherpa.utils.err.RuntimeErr – If the command is not recognized.

See also

image_close

Close the image viewer.

image_getregion

Return the region defined in the image viewer.

image_open

Create the image viewer.

image_setregion

Set the region to display in the image viewer.

image_xpaset

Send an XPA command to the image viewer.

Notes

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

Examples

Return the current zoom setting of the active frame:

>>> image_xpaget('zoom')
'1\n'