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


epatplot (epatplot-1.13.7) [xmmsas_20060628_1801-7.0.0]

Description 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
setyesdata-setevents.fits 
Name of input EPIC pn or EPIC MOS events file (e.g., of a source or selected region)
 
withbackgroundsetnobooleanNY/N
whether to use background event set for background subtraction
 
backgroundsetnodata-setbkg_events.fits 
Name of background EPIC pn or MOS event file
 
backscalnoreal1.0$>$0.0
background-to-source extraction area ratio; also needs to include exposure ratio if source and background exposures differ
 
withflagnobooleanYY/N
whether to select FLAG==0 internally
 
withoutputmasknobooleanNY/N
whether to create a CCD map with positions FLAG==0 set to 1
 
outmasknamenostring./flag0_map_##.dat 
name of output FLAG=0 map if withoutputmask=Y, the substring ## will internally be replaced with the CCD number currently in use (two digits)
 
devicenostring/VCPS/VCPS
PGPLOT output device (only VCPS implemented yet)
 
outdirnostring./ 
output directory for output file
 
useplotfilenobooleanNN/Y
whether to use plotfile as output file name, otherwise construct name from input data set + `_pat.ps'
 
plotfilenostringevents_pat.ps 
output file name
 
withqdpnobooleanNN/Y
whether to create also QDP output file, construct name from input data set + `_pat.qdp'
 
withusermodenobooleanNN/Y
whether to use the user-defined mode usermode instead of the SUBMODE model for comparison
 
usermodenointeger 0-5
if withusermode=Y then use this mode for model comparison, in cal convention:
0=FF, 1=eFF, 2=LW, 3=SW, 4=TI, 5=BU
 
withuserrawynobooleanNN/Y
whether to use the user-defined mode usermode instead of the SUBMODE model for comparison
 
userrawynoreal190.01-200
if withuserrawy=Y then use this coordinate value for the spatial dependence
 
xaxisadunobooleanNY/N
whether to use ADU (instead of eV) as unit for x-axis
 
sigmanoreal3.00-
sigma to accumulate for 1 bin
 
ccdlimitsnointeger-list1 64 1 200 1 12 
to select certain RAWX RAWY CCDNR range from the PN (only) event file for accumulation of the distributions
 
plotyrangenoreal-list0 0 
to fix the Y range (in log10 values) in the distribution plot for an easier comparison with other observations; if second value is not larger than first value then do an automatic determination of the Y range
 
pileupnumberenergyrangenoreal-list500 2000 
energy range [eV] in which the pile-up diagnostic number is calculated
 
modifyInSetnobooleanYY/N
if N: skip writing of header keywords to increase speed
 
ParameterMand Type Default Constraints


Description Home Page Errors Home Index

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