XMM-Newton Science Analysis System


imgdisplay (imgdisplay-1.50) [xmmsas_20160201_1833-15.0.0]

Meta Index / Home Page

Parameters

This section documents the parameters recognized by this task (if any).

Parameter	Mand	Type	Default	Constraints
startviewer	no	boolean	true	false$\vert$true
If startviewer is set to true imgdisplay attempts to establish a communication link between itself and an active Ds9/SAOtng process upon invocation. If a Ds9/SAOtng is active already, either started manually or through a previous invocation of imgdisplay with stopviewer=false, its main window must have the titleds9 or ds9-username for imgdisplay to be able to connect to it. username is the value of the environment variable LOGNAME which is usually the user's login name. If no running Ds9/SAOtng could be found imgdisplay spawns one with the window title SAOtng-username such that subsequent task invocations can find and connect to this process. Please note: Ds9/SAOtng are big programs, even on modern workstations is can take up to several seconds before the main window appears on the screen. startviewer=true is a prerequisite that any given additional commands can succeed. If set to ``false'' the task exits immediately -- all following commands are ignored in this case.
withimagefile	no	boolean	false	false$\vert$true
A boolean switch determining whether a new image should be loaded into Ds9/SAOtng. If set to ``true'' the name of the image data set must be given via the parameter imagefile. When a new image is loaded any previously displayed one is lost.
imagefile	no	string		name of existing image data set
The name of the image data set to load into Ds9/SAOtng when withimagefile is set to ``true''.
withregion	no	boolean	false	false$\vert$true
A boolean switch determining whether region specifications should be read from Ds9/SAOtng and stored in the regions parameter. Not applicable to interactive usage.
regions	no	string list
This serves as an output parameter to hold region specifications read from Ds9/SAOtng when requested with. Not applicable to interactive usage. withregion=true.
withregiontable	no	boolean	false	false$\vert$true
A boolean switch determining whether the contents of an CXC-region file should be displayed in the form of markers on top of the currently displayed image. If set to true, the below parameter regiontable must be given the name of the region table.
regiontable	no	string		name of existing CXC-region table
The name of the CXC-region table to be visualized.
flipx	no	boolean	false	false$\vert$true
A boolean switch determining whether the image currently displayed in Ds9/SAOtng should be flipped around the X-axis.
flipy	no	boolean	false	false$\vert$true
A boolean switch determining whether the image currently displayed in Ds9/SAOtng should be flipped around the Y-axis.
viewer	no	string		ENV or name of viewer executable
A string determining which image viewer shall be used: SAOtng or Ds9. viewer can also be assigned the value ENV in which case the environment variable     SAS_IMAGEVIEWER must specify either of the two supported programs. Please note: If viewer is just given the name of the viewer executable it must be reachable via the PATH environment variable. However, viewer may also contain the full path to the executable, e.g. /usr/local/bin/ds9.
stopviewer	no	boolean	false	false$\vert$true
A boolean switch determining whether a running Ds9/SAOtng process should be terminated.
withcommands	no	boolean	false	false$\vert$true
Controlling boolean switch for commands parameter.
commands	no	list of strings		list of valid Ds9/SAOtng commands
If withcommands is set to true the value is supposed to be list of Ds9/SAOtng commands that are to be send to an already spawned image displayer. E.g. withcommands=true commands="zoom to 2" will set the zoom factor in the currently displayed image to 2.
withreceive	no	boolean	false	false$\vert$true
Controlling boolean switch for receive parameter.
receive	no	list of strings
This is an output parameter which is only useful in the context of metatask programming. If withreceive is set to true output from a running Ds9/SAOtng process (resulting from a preceding execution of commands via withcommands/commands) shall be collected in this parameter as a list of strings. The parameter is not accessible as part of imgdisplay's parameter dialog.
Parameter	Mand	Type	Default	Constraints