Image

class sherpa.image.Image[source] [edit on github]

Bases: NoNewAttributesAfterInit

Base class for sending image data to an external viewer.

Methods Summary

close()

Stop the image viewer.

delete_frames()

Delete all the frames open in the image viewer.

get_region(coord)

Return the region defined in the image viewer.

image(array[, shape, newframe, tile])

open()

Start the image viewer.

set_region(reg, coord)

Set the region to display in the image viewer.

set_wcs(keys)

xpaget(arg)

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

xpaset(arg[, data])

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

Methods Documentation

static close()[source] [edit on github]

Stop the image viewer.

static delete_frames()[source] [edit on github]

Delete all the frames open in the image viewer.

static get_region(coord)[source] [edit on github]

Return the region defined in the image viewer.

Parameters:

coord (str) – The name of the coordinate system (the empty string means to use the current system).

Returns:

region – The region, or regions, or the empty string.

Return type:

str

image(array, shape=None, newframe=False, tile=False)[source] [edit on github]
static open()[source] [edit on github]

Start the image viewer.

static set_region(reg, coord)[source] [edit on github]

Set the region to display in the image viewer.

Parameters:

  • reg (str) – The region to display.

  • coord (str) – The name of the coordinate system (the empty string means to use the current system).

set_wcs(keys)[source] [edit on github]
static xpaget(arg)[source] [edit on github]

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

static xpaset(arg, data=None)[source] [edit on github]

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

Send a command to the image viewer.

Parameters:

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

  • data (optional) – The data for the command.