JEM-X ISSW Common Parameter Names

At the informal SDAST meeting on coding and background handling in Helsinki
on November 1st and 2nd 1999, it was decided that certain input parameters
found in the parameter files of each executable should have uniform names.
In this way parameters having the same function in several executables will
have the same name, which should ease pipeline maintenance. Here is the
current list of agreed names. All suggestions for new names and functionality
should be sent to oxborrow@dsri.dk . 
This page 
serves as the central repository for this information, and contains the most 
up-to-date list of parameter names in use.

All data structures that reside in the SWG should be accessed through inSWG
and outSWG - parameters for each data structure within the SWG are for
OVERRIDE versions of the particular extension and are included in the parameter
file to allow non-standard, non-SWG version of a particular extension to be
used. This means that while all the required parameter names should appear in
an executable's parameter file, many of these will be without a value, except
in unusual circumstances.

N.B.: There are no data structure override DOLs for children of the instrument
model group. The correct instrument model group is always provided to the
user by the pipeline script that calls individual executables. 

Parameter Name Function Aliases
Accuracy Accuracy of OBT/IJD conversion for GTIs Also known as: GTI-Accuracy
alrtLevel Maximum level of alerts produced by j-prp-verify
alrtBoth Alert level produced when ADC/amp offset and slope are bad
alrtOffset Alert level produced when an ADC/amp offset is bad
alrtOther Alert level produced when something else wrong with ADC/amp
alrtSlope Alert level produced when slope of ADC/amp is wrong
alrtZero Alert level produced when an ADC/amp is dead
angleLimit Maximum offaxis angle for source acceptance in deg Also known as: IMA-angleLimit
anodHis DOL of override to anode population histogram JMXi-ANOD-PRP
aspeScale DOL to override JMXi-ASPE-BKG
attiScale DOL to override JMXi-ATTI-BKG
attTolerance Allowed attitude variation for GTIs Also known as: GTI-attTolerance
backCorr Perform background correction? Also known as: BIN-I-backCorr
baseDir Base directory name string of repository
backRes Optional DOL for background spectra from event binning
bgrMethod Choice of background handling method used by j-src-spectra 0 = flat; 1 = Model Also known as: SPE-bgrMethod LCR-bgrMethod
bkgScale DOL to override JMXi-SCAL-BKG, Also known as: j-ima-shadowgram-bkgScale, j-bin-bkg-spectra-bkgScale
jemx _science _analysis flag: processing simulated data?
bkgSpatial DOL to override JMXi-SPAT-BKG, Also known as: j-ima-shadowgram-bkgSpatial j-bin-bkg-spectra-bkgSpatial
bkgSpatIdx DOL to override JMXi-SPAT-BKG-IDX
bkgSpecCat DOL to override JMXi-SCAT-BKG
bkgSpecIdx DOL to override instrument background spectrum model index
bkgSpecMap DOL to override JMXi-SIDX-BKG Also known as: j-ima-shadowgram-bkgSpecMap j-bin-bkg-spectra-bkgSpecMap
binFactor Performance monitoring binning factor. 0 = `full'
BIN-S-rowSelectEvts Script parameter string for selecting events
BIN-S-rowSelectSpec Script parameter string for selecting spectra
BTI-Dol DOL of Bad Time Interval table Also known as: GTI-BTI-Dol
BTI-Names BTI filenames to be considered in processing Also known as: GTI-BTI-Names
chanHigh Array of Upper boundaries of channel bins if nChanBins > 0
chanLow Array of Lower boundaries of channel bins if nChanBins > 0
chanMax Highest PI bin for shadowgram binning
chanMin Lowest PI bin for shadowgram binning
chatter Sets degree of verbosity of output (0 to 5)- see below Also known as: general-chatter
class Class of objects to select for source catalogue search Also known as: CAT-I-class
clobber Clobber existing output data structure (y/n) Also known as: general-clobber
csswCnv DOL to override JMXi-CSSW-CNV Also known as: j-dead-time-calc-csswCnv
csswHrw DOL to override JMXi-CSSW-HRW Also known as: j-dead-time-calc-csswHrw
date IJD of the public data for source catalogue search Also known as: CAT-I-date
dbgGalDbg DOL of diffuse background database
dbgScale DOL to override JMXi-SCAL-DBG, Also known as: j-ima-shadowgram-dbgScale j-bin-bkg-spectra-dbgScale
dbgSpatial DOL to override JMXi-SPAT-DBG Also known as: j-ima-shadowgram-dbgSpatial j-bin-bkg-spectra-dbgSpatial
dbgSpatIdx DOL to override JMXi-SPAT-DBG-IDX
dbgSpecCat DOL to override JMXi-SCAT-DBG
dbgSpecIdx DOL to override diffuse background spectral models index
dbgSpecMap DOL to override JMXi-SIDX-DBG Also known as: j-ima-shadowgram-dbgSpecMap j-bin-bkg-spectra-dbgSpecMap
deadTime DOL to override JMXi-DEAD-SCP Also known as: j-ima-shadowgram-deadTime j-src-lc-deadTime j-src-spectra-deadTime
diagnosticMode Diagnostic options for source extraction Also known as: j-src-spectra-diagnosticMode j-src-lc-diagnosticMode
diagnosticParam Toggle for Diagnostic Parameter Also known as: j-src-spectra-diagnosticParam j-src-lc-diagnosticParam
dimImage Dimension of fine resolution sky image
distFuzz Allowed fuzziness in source-matching distances Also known as: IMA-distFuzz
ecalPrp DOL of JMXi-ECAL-CPR
ecalRaw DOL of JMXi-ECAL-CRW
endLevel ISDC level at which to end processing---scripts only
errPos Acceptable variation in identifying a flagged source q-flag-srcs-errPos
evtType Type of JEM-X event ( 0=FULL; 1=REST ; 2=SPTI ; 3=TIME ; 4=SPEC ; 5=RATE ; -1=default:all sensible combinations) BIN-I-evtType SPE-evtType LCR-evtType BIN-S-evtType BIN-T-evtType
findRes Override DOL of JMXi-FIND-RES
fluxDef Column used for flux selection during source catalogue search Also known as: CAT-I-fluxDef
fluxLimit Lower flux limit for alerts on unfound sources Also known as: IMA-fluxLimit
fluxMax Upper limit for flux selection for source catalogue search Also known as: CAT-I-fluxMax
fluxMin Lower limit for flux selection for source catalogue search Also known as: CAT-I-fluxMin
fluxScaling Options for flux scaling to area Also known as: SPE-fluxScaling LCR-fluxScaling
fullCor DOL to override JMXi-FULL-COR Also known as: j-cor-both-fullCor j-src-spectra-fullCor j-ima-shadowgram-fullCor j-bin-evts-spectra-fullCor j-src-lc-fullCor
fullPrp DOL to override JMXi-FULL-PRP Also known as: j-cor-both-fullPrp j-src-lc-fullPrp j-ima-shadowgram-fullPrp j-bin-evts-spectra-fullPrp j-src-spectra-fullPrp
fullPrw DOL to override JMXi-FULL-PRW
fullRaw DOL to override JMXi-FULL-RAW Also known as: j-cor-both-fullRaw j-bin-evts-spectra-fullRaw
fullSrw DOL to override JMXi-FULL-SRW
gainHist DOL to JMXi-GAIN-CAL-IDX Also known as: COR-gainHist
gainModel Model options for time-smoothing of detector gain results Also known as: COR-gainModel
gainOut DOL of interactive gain history output for ICAL tools
glitchOut DOL of glitch histogram image, for offline analysis
goodTime DOL to override JMXi-MERG-GTI or JMXi-GNRL-GTI Also known as: j-src-spectra-goodTime j-src-lc-goodTime
gridNum Number of steps on one side of source finding search grid Also known as: IMA-gridNum
gti-data-gaps-XXX Instrument modes for which to make GTIs based on data gaps
gti-data-gaps-COMPTON-SGLE-Mode
gti-data-gaps-COMPTON-MULE-Mode
gti-data-gaps-ISGRI-Mode
gti-data-gaps-JMX1-Mode
gti-data-gaps-JMX2-Mode
gti-data-gaps-PICSIT-MULE-Mode
gti-data-gaps-PICSIT-SGLE-Mode
gti-data-gaps-SPI-Mode
gtiJemxNames Names of JEM-X GTIs to merge Also known as: GTI-gtiJemxNames
gtiNames Names of GTI tables to be used in j-src-spectra Also knowns as: BIN-I-gtiNames
gtiScNames Names of spacecraft GTIs to merge Also known as: GTI-gtiScNames
gtiUser DOL of user GTI table Also known as: GTI-gtiUser
hkType Type of housekeeping to use for perforamance table. 0 = AVGR, 1 = RAW and 2 = CONV
IC-Group DOL of Instrument Model master group table, used by analysis pipeline scripts only
IC-Alias Selection alias string for Instrument Model group: analysis scripts only
ignoreAnode Up to 4 numbers 0 to 3 of anode segments to ignore during image deconvolution Also known as: IMA-ignoreAnode
ignoreScwErrors Script parameter: ignore processing errors?
inCAL DOL of input calibration spectra index table JMXi-FRSS-CRW-IDX
inDOL DOL of single data file not in the SWG, e.g.\ JMXi-FRSS-CRW
indexSWG DOL of the science window group index GNRL-SCWG-GRP-IDX
inObsGrp Input observation group DOL
instMod DOL to JMXi-IMOD-GRP
instStat DOL to override JMXi-INST-STA Also known as: j-ima-src-find-instStat j-src-spectra-instStat j-src-lc-instStat
inSWG Input Science Window Group DOL Also known as: LCR-inSWG
jemxNum JEM-X Instrument number: 1 or 2; 0 = `both' i.e. for performance monitoring and comparison. Also known as: general-jemxNum
lcRes DOL to override output lightcurve JMXi-FULL-DLC or JMXi-SPTI-DLC for j-bin-evts-lc
lcType Option for binning normal or folded lightcurves
limitTable DOL of table with alert/GTI limits. If empty table is taken from Instrument Characteristics database Also known as: GTI-limitTable
listRes Override DOL of JMXi-SRCL-RES
logicType Logic used for source flagging, 1 = AND, 2 = OR. Also known as: q-flag-srcs-logicType
maxNumTrials Maximum number of trials in source search Also known as: IMA-maxNumTrials
MergedName Name of merged GTI table to be used Also known as: GTI-MergedName
minDetLev Minimum detector level for found source acceptance Also known as: IMA-minDetLev
minDist Minimum source separation in arcmins for source search Also known as: IMA-minDist
mosaicFileDOL Script parameter for output mosaic Also known as: IMA2-mosaicFileDOL
mosaicselection Script parameter string for image selection Also known as: IMA2-mosaicselection
nChanBins Number of channel bins in output data (e.g. number energy-resolved light curves or images). If set to 0 there will be a single bin with all data. If set to < 0 the data will be rebinned by grouping abs(chanBins) channels together. To obtain data with binning at full resolution one would set chanBins =-1 Also known as: BIN-I-nChanBins
nPhaseBins Number of bins used in cyclic folding of periodic sources with bins of unequal length an option: if nPhaseBins=0 then no pulse folding is done. If nPhaseBins > 0, then this is the number of phase bins to use. if nPhaseBins < 0 use | nPhaseBins | equal sized bins for cyclic folding. Size of unequal sized bins is given by vector parameter phaseBins
numPixelSubDiv Number of pixel subdivisions in j-imaging transforming from scew to detector coordinates Also known as: IMA-numPixelSubDiv
ogDOL DOL of observation group---input to observation pipeline
orbiScale DOL to override JMXi-ORBI-BKG
osimData Scripts flag for processing on simulated data general-osimData
outBkgSpec DOL to override JXMi-SRCL-BSP
outCAL DOL of output gain calibration index table JMXi-GAIN-CAL-IDX
outDOL DOL of single data file not in the SWG, e.g.\ JMXi-GAIN-CAL-IDX
outSrcArf DOL of override JMXi-SLSP-ARF or JMXi-SLLC-ARF
outSrcLC DOL of override JMXi-SRC.-LCR
outSrcSpec DOL to override JMXi-SRCL-SPE
outSWG Output Science Window Group DOL
parNames Name of ascii file holding HK parameter names to be included in performance monitoring
perfTable Output DOL of performance table
phaseBins Vector parameter giving size of nPhaseBins bins required for cyclic folding of periodic sources
precisionLevel Speed vs. Precision level for j-src-spectra Also known as: SPE-precisionLevel LCR-precisionLevel
qlaCat DOL of QLA sources catalogue. QLA-qlaCat
qlaMode Flag---processing for QLA (or SA)? QLA-qlaMode
radiusLimit Only events out to this many mm from centre of detectorused for imaging Also known as: IMA-radiusLimit
radiusMax Upper limit of range for catalogue position search Also known as: CAT-I-radiusMax
radiusMin Lower limit of range for catalogue position search Also known as: CAT-I-radiusMin
radlScale DOL to override JMXi-RADL-BKG
ratePrp DOL to override JMXi-RATE-PRP
ratePrw DOL to override JMXi-RATE-PRW
rateRaw DOL to override JMXi-RATE-RAW
rateSrw DOL to override JMXi-RATE-SRW
refCat DOL of ISDC Reference Catalogue of sources for scripts only Also known as CAT-I-refCat
relDist Allowed uncertainty-scaled distances between matched sources. Also known as: IMA-relDist
response Script parameter with file of standard ARF and RMF extensions
restCor DOL to override JMXi-REST-COR Also known as: j-cor-both-restCor j-ima-shadowgram-restCor j-bin-evts-spectra-restCor
restPrp DOL to override JMXi-REST-PRP Also known as: j-cor-both-restPrp j-ima-shadowgram-restPrp j-bin-evts-spectra-restPrp
restPrw DOL to override JMXi-REST-PRW
restRaw DOL to override JMXi-REST-RAW Also known as: j-cor-both-restRaw j-bin-evts-spectra-restRaw
restSrw DOL to override JMXi-REST-SRW
revolAvg DOL of ICAL table with revolution averages of gain history
revolStart First revolution to process with ICAL tools
revolStop Last revolution to process with ICAL tools
rowSelect CFITSIO selection string for events Also known as: BIN-I-rowSelect SPE-rowSelect LCR-rowSelect BIN-T-rowSelect
rstiRes Override DOL of JMXi-RSTI-IMA
shdType Type of shadowgram to bin: skew or standard? Also known as: BIN-I-shdType
shdRes DOL of override JMXi-EVTS-SHD Also known as: BIN-I-shdRes
searchRad Range of search around nominal found sources Also known as: IMA-searchRad
simulated Using simulated background models? Also known as: BKG-simulated
skipLevels Script parameter for Jemx-science-analysis; indicates ISDC levels to skip during processing. e.g. BKG
skipHotSpot Ignore data from known hotspots? Also known as: SPE-skipHotSpot LCR-skipHotSpot
skipNearDeadAnode Ignore data near dead anodes? Also known as: SPE-skipNearDeadAnode LCR-skipNearDeadAnode
skyRes Override DOL of JMXi-SKY.-IMA
specCor DOL to override JMXi-SPEC-COR Also known as: j-cor-gain-specCor j-bin-spec-spectra-specCor
specPrp DOL to override JMXi-SPEC-PRP Also known as: j-cor-gain-specPrp j-bin-spec-spectra-specPrp
specRaw DOL to override JMXi-SPEC-RAW Also known as: j-cor-gain-specRaw j-bin-spec-spectra-specRaw
specRes Optional output spectra extension DOL for binning events
sptiCor DOL to override JMXi-SPTI-COR Also known as: j-cor-gain-sptiCor j-bin-evts-spectra-sptiCor
sptiPrp DOL to override JMXi-SPTI-PRP Also known as: j-cor-gain-sptiPrp j-bin-evts-spectra-sptiPrp
sptiPrw DOL to override JMXi-SPTI-PRW
sptiRaw DOL to override JMXi-SPTI-RAW Also known as: j-cor-gain-sptiRaw j-bin-evts-spectra-sptiRaw
sptiSrw DOL to override JMXi-SPTI-SRW
srcattach Script parameter: attach result list to observation? Also known as: IMA2-srcattach
srcFileDOL Script parameter for combined mosaic output source list Also known as: IMA2-srcFileDOL
srcselect Script parameter for selection string for input sources Also known as: IMA2-srcselect
startLevel ISDC analysis level on which to begin processing---scripts only
swgDOL j _scw _analysis: DOL of science window group to analyse
tAccuracy Time Correlation accuracy in j _src _lc Also known as: LCR-tAccuracy SPE-tAccuracy
threshold Limit for size of corrections due to vignetting in imaging Also known as: IMA-threshold
timeFormat Options for possible time formats for GTIs Also known as: GTI-timeFormat
timePrp DOL to override JMXi-TIME-PRP
timePrw DOL to override JMXi-TIME-PRW
timeSrw DOL to override JMXi-TIME-SRW
timeStart Time in IJD (ISDC Julian Date) of beginning of first time bin: used as starting point for time binning. Negative values indicate beginning of ScW as default start time. N.B.: All bin times are given by the centre time of the bin, except for timeStop and timeStart
timeStep Integration time in seconds for a single lightcurve bin or a spectrum in time-resolved spectral binning Also known as: SPE-timeStep LCR-timeStep
timeStop Time in IJD of end of last time bin. If this parameter is negative, last time of ScW is used as default. N.B.: All bin times are given by the centre time of the bin, except for timeStop and timeStart
usrCat DOL of User (private) Catalogue of sources---scripts only Also known as: CAT-I-usrCat
useCatPos Flag for catalog position to override found position Also known as: IMA-useCatPos
useRaDec Use sky coordinates instead of instrument coords.? Also known as: SPE-useRaDec LCR-useRaDec
vignCorr Perform vignetting corrections? Also known as: SPE-vignCorr IMA-vignCorr LCR-vignCorr

All other requests and suggestions welcomed.

Last updated: 2004/12/08 by C.A.Oxborrow
 Return to top of page