XMM-Newton SAS Home Page
XMM-Newton Science Analysis System


convregion (convregion-0.12.2) [22.0.0-9173c7d25-20250127]

Description Home Page Errors Home Index

Meta Index / Home Page

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).
ParameterMand Type Default Constraints
modenoint1$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
 
inregionnostring  
mode=1,2 only, input FITS/ASCII file name
 
outregionnostring  
mode=1,2 only, output FITS/ASCII file name
 
imagefileyesstring  
Filename image in sky coordinates – used to extract observation position angle.
 
ranoreal none
mode=3 only RA input
 
decnoreal none
mode=3 only Dec input
 
shapenostringCIRCLEnone
mode=3 only region shape input, CIRCLE|ELLIPSE
 
radiusnoreal none
mode=3 only, shape=CIRCLE radius for circular region input
 
semimajornoreal none
mode=3 only, shape=ELLIPSE semimajor axis (in arc minutes) for elliptical region input
 
semiminornoreal none
mode=3 only, shape=ELLIPSE semiminor axis (in arc minutes) for elliptical region input
 
rotanglenoreal none
mode=3 only, shape=ELLIPSE rotation angle (in degrees) for elliptical region input
 
ParameterMand Type Default Constraints


Description Home Page Errors Home Index
XMM-Newton SOC -- 2025-01-27