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


eimsimbatch (eimsim-2.4.2) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
streamnumbernoint1 
If you want to run several instances of eimsimbatch (thus eimsim) at the same time from the same PWD, you should give them different stream numbers via this parameter. The streamnumber is included in all intermediate file names.
 
nfieldsnoint1 
If you want each invocation of eimsimbatch to accumulate an ensemble of $N$ statistically independent simulations, set nfields to $N$. The task will then call eimsim $N$ times, incrementing the value of the parameter –idnumber on each occasion. The starting value of –idnumber is taken from parameter startatn. The –idnumber is included in all intermediate file names.
 
startatnnoint1 
This is useful if you have run eimsimbatch at least once before, and now wish to run it again so as to add further simulation runs to the ensemble. Suppose your previous runs at the specified value of streamnumber have accumulated $N$ simulations: you should therefore set startatn to $N+1$ for your next run at the same streamnumber. WARNING! If you do not set startatn to an appropriate value before restarting eimsimbatch, your previous data will be silently overwritten.
 
nextonfailnoboolyes 
If `yes', a failure in any iteration of eimsim will cause eimsimbatch to proceed to the next iteration; if set to `no', a failure of eimsim will cause eimsimbatch also to fail.
 
cleanupnoboolno 
Set this to `yes' if you want all intermediate files except the source lists to be cleared away at the end of processing.
 
obsidrootsnostring. 
See eimsim documentation.
 
entrystagenostringmakesimlist 
See eimsim documentation.
 
finalstagenostringcompare 
See eimsim documentation.
 
refbandnostring1 
See eimsim documentation.
 
prdssubdirnostringproduct 
See eimsim documentation.
 
simopsubdirnostringsim_output 
See eimsim documentation.
 
simgensubdirnostringsim_generic 
See eimsim documentation.
 
srcspecsetnodatasetsrcspec.fits 
See eimsim documentation.
 
withsimsourcesnoboolyes 
See eimsim documentation.
 
energyfractionnoreal0.95 
See eimsim documentation.
 
fluxcutoffnoreal2.0e-15 
See eimsim documentation.
 
withfluxoffsetnoboolno 
See eimsim documentation.
 
fluxoffsetnoreal  
See eimsim documentation.
 
dettaskstylenostringautouser|auto
See eimsim documentation.
 
dettasknostringeimsimdetect1xmm 
See eimsim documentation.
 
withdetentrystagenoboolno 
See eimsim documentation.
 
detentrystageyesstring  
See eimsim documentation.
 
withdetfinalstagenoboolno 
See eimsim documentation.
 
detfinalstageyesstring  
See eimsim documentation.
 
astestnoboolno 
See eimsim documentation.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30