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


omgrism (omgrism-1.29) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
setyesstring  
OM image file with grism spectra aligned with respect to the columns of the image (output from omgprep).
 
sourcelistsetyesstring  
Source list (output from OMDETECT)
 
outsetyesstring  
Output spectra file
 
regionfilenostring  
Name of the ASCII (input) region file
 
spectraregionfilenostring  
Name of the ASCII (output) spectra region file
 
outspectralistsetnostring  
Output file containing the extracted spectra list (in a brief form)
 
extractfieldspectranologicalfalse 
If set to true switches the task into the mode for extraction of all available spectra in the field
 
spectrumhalfwidthnoreal-8. -20 to 20
Halfwidth of the spectrum extraction region; expressed in pixel, if negative, or in FWHWs, if positive
 
bkgoffsetleftnoreal0.-20 to 20
Offset of the left background extraction region (from the left edge of the spectrum extraction region); in pixels, if negative, or in FWHWs otherwise.
 
bkgwidthleftnoreal-8.-40 to 40
Width of the left background extraction region; in pixels, if negative, or in FWHWs otherwise.
 
bkgoffsetrightnoreal0.-20 to 20
Offset for the right background extraction region (from the right edge of the spectrum extraction region); in pixels, if negative, and in FWHWs otherwise.
 
bkgwidthrightnoreal-8.-40 to 40
Width of the right background extraction region; in pixels, if negative, or in FWHWs otherwise.
 
spectrumsmoothlengthnointeger $\geq 0$
Length of the smoothing window for smoothing the output spectra (if smoothing is desirable); the parameter set to 0 or 1 implies no smoothing.
 
extractionmodenointeger extractionmode $\geq 0$
Switch between different extraction modes. The value 0 corresponds to the normal extraction (summation of counts in the cross-dispersion direction); 1 corresponds to the Optimal Extraction (Horne's algorithm); 2 corresponds to the one-dimensional spline smoothing (in the cross-dispersion direction); 3 corresponds to the one-dimensional Gaussian fit (in the cross-dispersion direction).
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30