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


arfgen (arfgen-1.102) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
spectrumsetyesdatasetspectrum.dsnone
Name of input spectrum dataset.
 
arfsetnodatasetancillaryfile.dsnone
Name of output ancillary response dataset.
 
withrmfsetnobooleanfalsenone
If set, the ARF energy grid is defined by the RMF dataset specified by rmfset.
 
rmfsetnodatasetresponsefile.dsnone
Name of input response dataset. Used only if withrmfset is set to true.
 
detmaptypenochoiceflatdataset flat psf
The origin of the detector map: if set to dataset, then the user must specify the name of that dataset, and the table name of the map though detmaparray. If it is set to flat or psf, then the parameters detxoffset, detyoffset, detxbins and detybins define the detector map grid. In addition, psfenergy needs also to be set if detmaptype $=$ psf.
 
detmaparraynoarraydetmapfile.ds:none
Name of detector map dataset and array in the DAL compound notation. Only used of 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 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].
 
detyoffsetnoreal1200 $\rm0 <= detyoffset <= 30000$
Used if 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].
 
withdetbinsnobooleanfalsenone
For psf or flat detector maps. If true then the number of bins of the internal detector map are taken from the parameters detxbins and detybins. Otherwise, the number of bins are calculated automatically.
 
detxbinsnointeger5$\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.
 
detybinsnointeger5$\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.
 
psfenergynoreal2.0 $\rm0 \leq psfenergy \leq 30 $
Used if detmaptype is set to psf. This is the energy, in keV, at which the PSF model used to construct the detector map is taken.
 
filterdssnobooleantruenone
If true, the raw detector map and the bad pixel lists are filtered using the DSS information stored in the spectrum dataset. If false, every pixel in the raw detector map is propagated to the filtered map and every bad pixel is used in the area calculation. This is a debugging parameter and should not be set to false under normal conditions.
 
withfilteredsetnobooleanfalsenone
If true, the filtered detector map is written out to a permanent dataset, the name of which is taken from the parameter filteredset.
 
filteredsetnodatasetfilteredpixellist.dsnone
Name of output filtered detector map. Used only if withfilteredset is set to true.
 
withsourceposnobooleanfalsenone
If true, the source position must be specified via the parameters sourcecoords, sourcex, sourcey. Otherwise, the source position is taken from the centre of the source region defined in the data subspace of the input spectrum.
 
sourcecoordsnochoiceeqposeqpos pos tel det
Used if withsourcepos $=$ true. The coordinate system for which the source position, specified by the parameter sourcex and sourcey, is defined. If sourcecoords is set to eqpos, then sourcex, sourcey correspond to RA and DEC respectively in decimal degrees. If sourcecoords $=$ pos, then sourcex, sourcey correspond to POS coordinates. (Note that the POS coordinates are defined relative to a norminal pointing position; this is taken from the global attributes REFXCRVL and REFYCRVL of the spectrum dataset.) If sourcecoords $=$ tel, then sourcex, sourcey correspond to the telescope coordinates theta (arcseconds) and phi (radians). If sourcecoords $=$ det, then sourcex, sourcey are the x and y positions of the source centre, in DET coordinates.
 
sourcexnoreal none
(Used if withsourcepos $=$ true) The x-position of source centre, in terms of the coordinate system specified in sourcecoords.
 
sourceynoreal none
(Used if withsourcepos $=$ true) The y-position of source centre, in terms of the coordinate system specified in sourcecoords.
 
extendedsourcenobooleanfalsenone
Informs arfgen as to whether the source is extended or point-like. This is currently only used for the encircled energy correction.
 
useodfattnobooleanfalsenone
whether the full attitude file should be used from the OAL. If this is set to false then attitude is taken from the mean pointing position in the spectrum header.
 
withbadpixcorrnobooleantruenone
states whether CCD gap and bad pixel corrections are wanted.
 
badpixlocationnodataset"notSpecified"none
The name of the file containing the bad pixel locations. Usually, this will be the event file from which the spectral dataset was constructed.
 
badpixelresolutionnoreal0.5none
This is the resolution that the program uses to calculate the encircled energy correction and to search for pixels which are outside the field-of-view or off the edge of the CCDs. If the extendedsource parameter is set true then this value is defaulted to 2.0 arcseconds. Reducing the number, in this case, to 1.0 arcseconds will improve the accuracy of the calculation at the expense of execution time.
 
badpixmaptypenochoiceflatdataset flat
If set to dataset the task uses the dataset which has been provided in the detmaparray parameter to correct for bad pixels, columns and chip gaps. The dataset should contain the full spatial distribution of the extended source (this is not appropriate for point sources) and should NOT be affected by bad pixels or chip gaps.
 
ignoreoutoffovnobooleanyes 
Whether area outside the field of view should be excluded in the arfgen calculation.
 
modeleffareanobooleantruenone
If true, the effective area data from the CAL is taken into consideration when generating the ARF.
 
modelquantumeffnobooleantruenone
If true, the quantum efficiency data from the CAL is taken into consideration when generating the ARF.
 
modelfiltertransnobooleantruenone
If true, the filter transmission data from the CAL is taken into consideration when generating the ARF.
 
modeleenobooleantruenone
If it is point-like (extendedsource=false), a model of the PSF positioned at a point specified by sourcex and sourcey is generated, and the fraction of the model situated within the region defined by the DSS information is computed. There is currently no encircled energy correction implementation for extended sources.
 
psfmodelnostringELLBETAELLBETA,EXTENDED,HIGH
The point spread function (PSF) model to use when calculating the encircled energy correction.
 
modelootcorrnobooleantruenone
The ARF will be decreased by a mode-dependent percentage if modelootcorr=true and if the pipeline version used to create the spectrum is older than 18 June 2001.
 
applyxcaladjustmentnobooleanfalsenone
Apply an adjustment to the effective areas which artificially makes the fluxes from the EPIC cameras more consistent.
 
eegridfactornointeger50$\rm\ge 1$
Used if modelee is set to true. This is the factor which to oversample the ARF energy grid in order to perform the energy correction efficiently: The larger the factor, the faster the execution time, but the less accurate the correction.
 
setbackscalenobooleanfalsenone
states whether the BACKSCAL value in the input spectrum should be set to the calculated source region area.
 
keeparfsetnobooleantruenone
whether the calculated ARF file should be kept or deleted. This option is included for the benefit of the backscale metatask which sets the BACKSCAL value in the input spectrum.
 
crossregionarfyesbooleanfalsenone
whether across-region ARF should be calculated.
 
crossreg_spectrumsetyesdataset none
Name of spectrum containing the input region.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30