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


badpixfind (badpixfind-1.41) [xmmsas_20211130_0941-20.0.0]

Parameters

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

(note: Default settings are reasonable for MOS analysis, and very conservative for pn analysis [see comments for discussion])
ParameterMand Type Default Constraints
eventsetyesstring  
input events file (either single-chip event file from epframes or emevents, or merged, calibrated multi-chip event file)
 
searchbadpixnologicalYY/N
search for bad pixels?
 
withsearchbadcolumnnologicalNY/N
search for bad total columns?
 
userflagbadpixnologicalNY/N
user-flag specific (sets of) bad pixels?
 
thresholdlabelnostringratepeak/counts/rate
Thresholds (all) choice - thresholds refer to percentage of PEAK value in the dataset, to count RATE or to pure COUNTS
 
ccdnointeger11-12
chip on which to search bad pixels if task is run on multi-chip event list
 
lothreshnoreal0.0$\geq0$ ($\leq100$ for thresholdlabel=peak)
Low threshold value for dead pixel search (searchbadpix=Y)
 
hithreshnoreal0.005$\geq0$ ($\leq100$ for thresholdlabel=peak)
High threshold value for hot pixel search (searchbadpix=Y)
 
loenergythreshnoreal0.00.0-30.0)
Low energy (in keV) bound for searching
 
hienergythreshnoreal30.00.0-30.0)
High energy (in keV) bound for searching
 
cellsizenointeger21-10
Cell size for PSF comparison (total width: 1 + 2$\times$cellsize )
 
narrowerthanpsfnoreal3.0$\geq0$
PSF-pixel(s) compactness comparison - 1, equal to PSF, $>$1, more compact, and hence likely, not a source
 
backgroundratenoreal0.00001 
Background rate (ct/s/pix) - if negative, mean over entire field assumed
 
threshabovebackgroundnologicalNY/N
determine whether hithresh and hicolthresh refer to values above the background rate (Y) or as total values (N)
 
columnsearchlabelnostringmedianmedian/total
withsearchbadcolumn=Y thresholds choice - locolthresh& hicolthresh refer to TOTAL column value or MEDIAN column value
 
locolthreshnoreal0.0$\geq0$ ($\leq100$ for thresholdlabel=peak)
Low threshold value for dead column search (withsearchbadcolumn=Y)
 
hicolthreshnoreal0.0015$\geq0$ ($\leq100$ for thresholdlabel=peak)
High threshold value for hot column search (withsearchbadcolumn=Y)
 
flickertimestepsnointeger1$\geq1$ ($\leq \sim$ 15 [see comments])
Number of timesteps to search for flickering pixels
 
flickerksthreshnoreal0.550-1
K-S threshold for low count flickering pixels
 
flickerchisqthreshnoreal15.0$\geq0$
Reduced Chi-sq threshold for high count flickering pixels
 
rawxlistnointeger list 1-600
List of user-flagged RAWX values (userflagbadpix=Y)
 
rawylistnointeger list 1-600
List of user-flagged RAWY values (userflagbadpix=Y)
 
typelistnointeger list 1-5
List of user-flagged TYPE values (userflagbadpix=Y)
 
yextentlistnointeger list 1-600
List of user-flagged YEXTENT values (userflagbadpix=Y) [Note: these four `lists' must contain equal number of entries]
 
badpixsetnostringbadpixfind.fits 
output file from badpixfind containing set of bad pixels (input to badpix
 
withbadpixmapnologicalNY/N
Create bad pixel image map?
 
withfovmasknologicalNY/N
Mask out regions outside of the field of view (FOV) in map?
 
mappixcellsizenointeger1$\geq0$, $\leq 10$
Bad cell surrounding bad pixel in map (total width: 1 + 2 $\times$ mappixcellsize )
 
badpixmapnostringbadpixmap.fits 
Bad pixel image map file name
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30