XMM-Newton Science Analysis System


srcdisplay (srcdisplay-1.19) [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
boxlistset	yes	data-set	boxlist.ds	none
Name of dataset containing source list, output from eboxdetect.
withimageset	no	boolean	true	true$\vert$false
If set to true a new image data set is given in parameter imagset.
imageset	no	data-set	image.ds	none
The image on which the positions of detected sources are displayed. For withimageset=false no new image data set shall be displayed but the sources in boxlistset will be marked on the image in the currently active Ds9 session.
sourceradius	no	float	0.01	0.0001 $\leq$ sourceradius$\leq$ 2
The radius of the displayed circles for each source, in degrees.
useposerr	no	boolean	false	none
If true, then the circle radius is taken as the error on the position in the sourcelist.
poserrcol	no	string	"RADEC_ERR"	none
The name of a column in the source list which gives the position error in arcseconds. The column must be of type REAL*32.
syserr	no	float	0.0
A systematic error to be aded in quadrature to the positional error when useposerr=true is set.
includesources	no	boolean	true	none
If true, then the DS9 region descriptor generated for each source is such that it INCLUDES the area bounded by the circle; otherwise it includes everything BUT this area.
uselabel	no	boolean	false	none
If true, a number is displayed alongside the source position, corresponding to the row number of that source in the input source list.
withregionfile	no	boolean	true	none
If true, then a file of name regionfile is written out, containing a list of DS9-type regions for each source, corresponding to the displayed circles.
regionfile	no	file-name	regionfile.txt	none
The name of the region file.
overlay	no	boolean	false	true$\vert$false
If set to false any previously existing source region markers on the active image will be deleted before the new ones are displayed. overlay=true suppresses this so any existing source markers will be left unmodified. This is useful for e.g., comparing the results of two independent source detection runs on the same image.
srccolor	no	string	white	black $\vert$white $\vert$red $\vert$green $\vert$blue $\vert$cyan $\vert$magenta $\vert$yellow
The color of the source markers - useful in conjunction with the overlay parameter to control the display of two or more source lists on the same image.
Parameter	Mand	Type	Default	Constraints