XMM-Newton Science Analysis System


eimsimbatch (eimsim-2.3) [xmmsas_20160201_1833-15.0.0]

Meta Index / Home Page

Parameters

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

Parameter	Mand	Type	Default	Constraints
streamnumber	no	int	1
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.
nfields	no	int	1
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.
startatn	no	int	1
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.
nextonfail	no	bool	yes
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.
cleanup	no	bool	no
Set this to `yes' if you want all intermediate files except the source lists to be cleared away at the end of processing.
obsidroots	no	string	.
See eimsim documentation.
entrystage	no	string	makesimlist
See eimsim documentation.
finalstage	no	string	compare
See eimsim documentation.
refband	no	string	1
See eimsim documentation.
prdssubdir	no	string	product
See eimsim documentation.
simopsubdir	no	string	sim_output
See eimsim documentation.
simgensubdir	no	string	sim_generic
See eimsim documentation.
srcspecset	no	dataset	srcspec.fits
See eimsim documentation.
withsimsources	no	bool	yes
See eimsim documentation.
energyfraction	no	real	0.95
See eimsim documentation.
fluxcutoff	no	real	2.0e-15
See eimsim documentation.
withfluxoffset	no	bool	no
See eimsim documentation.
fluxoffset	no	real
See eimsim documentation.
dettaskstyle	no	string	auto	user|auto
See eimsim documentation.
dettask	no	string	eimsimdetect1xmm
See eimsim documentation.
withdetentrystage	no	bool	no
See eimsim documentation.
detentrystage	yes	string
See eimsim documentation.
withdetfinalstage	no	bool	no
See eimsim documentation.
detfinalstage	yes	string
See eimsim documentation.
astest	no	bool	no
See eimsim documentation.
Parameter	Mand	Type	Default	Constraints