XMM-Newton Science Analysis System


convregion (convregion-0.12.2) [xmmsas_20230412_1735-21.0.0]

Parameters

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

NOTE: depending on the MODE selected, the task will not work if some optional parameters are not given. E.g.s., for mode=3, if an RA/Dec are not given, an error will occur; for mode=1 or 2 if an input FITS or ASCII region file is not given, an error will occur, BUT, if an RA/Dec are given, along with the FITS/ASCII file, they will be ignored with a warning (because the RA/Dec are extracted from the input file).

Parameter	Mand	Type	Default	Constraints
mode	no	int	1	$1<=mode<3$
convregion operational mode: mode=1 – region fits files are both input and output mode=2 – ASCII files with region parameters are both input and output mode=3 – command line input of individual region parameters and screen output
inregion	no	string
mode=1,2 only, input FITS/ASCII file name
outregion	no	string
mode=1,2 only, output FITS/ASCII file name
imagefile	yes	string
Filename image in sky coordinates – used to extract observation position angle.
ra	no	real		none
mode=3 only RA input
dec	no	real		none
mode=3 only Dec input
shape	no	string	CIRCLE	none
mode=3 only region shape input, CIRCLE|ELLIPSE
radius	no	real		none
mode=3 only, shape=CIRCLE radius for circular region input
semimajor	no	real		none
mode=3 only, shape=ELLIPSE semimajor axis (in arc minutes) for elliptical region input
semiminor	no	real		none
mode=3 only, shape=ELLIPSE semiminor axis (in arc minutes) for elliptical region input
rotangle	no	real		none
mode=3 only, shape=ELLIPSE rotation angle (in degrees) for elliptical region input
Parameter	Mand	Type	Default	Constraints