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


rmfgen (rmfgen-1.55) [xmmsas_20060628_1801-7.0.0]

Using the threshold parameter Home Page Errors Home Index

Meta Index / Home Page

Parameters

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

ParameterMand Type Default Constraints
spectrumsetyesdatasetspectrum.phanone
Name of the counts spectrum file for which the output RMF dataset is associated.
 
rmfsetnodatasetresponsefile.dsnone
Name of output response dataset.
 
thresholdnoreal1e-5$\rm0 <=$ threshold$ <= 1$
Threshold level for grouping. All elements within the matrix below this value are excluded in the formatted output.
 
withenergybinsnobooleanfalsenone
If true use energy grid specified by energymin, energymax, and nenergybins, otherwise, use the grid defined in the CAL.
 
energyminnoreal none
Used if withenergybins$=$ true. Lower energy bound of matrix, in keV.
 
energymaxnoreal15none
Used if withenergybins$=$ true. Upper energy bound of matrix, in keV.
 
nenergybinsnointeger30none
Used if withenergybins$=$ true. The number of bins in the energy grid $=$ number of rows in RMF matrix.
 
formatnochoicevarfixed, var
Format for MATRIX vector column. Set this to 'fixed' to include all matrix elements.
 
detmaptypenochoicepsfdataset flat psf
The origin of the detector map: if set to dataset, then the user must specify the name of that dataset, via detmaparray. If it is set to flat or psf, then the parameters detxbins and detybins define a detector map grid of the same size as the source extraction region. A larger region can be defined by setting withdetbounds true and setting the detxoffset, detyoffset parameters.
 
detmaparraynoarraydetmapfile.ds:none
Name of detector map dataset and optionally array in the DAL compound notation. Only used if detmaptype is set to dataset.
 
withdetboundsnobooleanfalsenone
For psf or flat detector maps. If true then the bounds of the internal detector map are taken from the parameters detxoffset and detyoffset. Otherwise, the bounds are taken from the DSS information in the spectrum dataset.
 
detxoffsetnoreal1200 $\rm0 <= detxoffset <= 30000$
Used if withdetbounds is set true and detmaptype is set to psf or flat. This defines the half-width of the detector map in DET coordinates. For example, if the source x-coordinate is $x$, the x-bounds are [$x-$detxoffset, $x+$detxoffset].
 
detxbinsnointeger160$\rm\geq 1$
Used if detmaptype is set to psf or flat. This is the number of bins along the x-axis of the map.
 
detyoffsetnoreal1200 $\rm0 <= detyoffset <= 30000$
Used if withdetbounds is set true and detmaptype is set to psf or flat. This defines the half-height of the detector map in DET coordinates. For example, if the source y-coordinate is $y$, the y-bounds are [$y-$detyoffset,$y+$detyoffset].
 
detybinsnointeger160$\rm\geq 1$
Used if detmaptype is set to psf or flat. This is the number of bins along the y-axis of the map.
 
ParameterMand Type Default Constraints


Using the threshold parameter Home Page Errors Home Index

XMM-Newton SOC/SSC -- 2006-06-28