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


epicbscalgen (ccftools-1.36) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
eventtableyestable Name of existing EPIC event list
The input event table which drives the boresight angle optimization. It must contain sky image coordinates computed by attcalc; it is likely to be the primary output event list from the chain processing tasks emproc or epproc.
 
xcolumnnocolumnXname of existing column in table eventtable
The name of the column in the input event table containing X-coordinates of sky pixels (used to accumulate sky image with evselect)
 
ycolumnnocolumnYname of existing column in table eventtable
The name of the column in the input event table containing Y-coordinates of sky pixels (used to accumulate sky image with evselect)
 
binxnointeger50 $1\le\mbox{\tt binx}\le200$
size of sky image pixel bin in X-direction (used to accumulate sky image with evselect) - please note: values less than 20 will lead to very large sky images and corresponding performance degradations
 
binynointeger50 $1\le\mbox{\tt biny}\le200$
size of sky image pixel bin in Y-direction (used to accumulate sky image with evselect) - please note: values less than 20 will lead to very large sky images and corresponding performance degradations
 
nrunsnointeger1 $1\le\mbox{\tt nruns}\le4$
Duplicates corresponding parameter of task eboxdetect; controls the source detection process; for more information please consult description of task eboxdetect.
 
likeminnoreal15 $1\le\mbox{\tt likemin}\le20$
Duplicates corresponding parameter of task eboxdetect; controls the source detection process; for more information please consult description of task eboxdetect.
 
sourceradiusnoreal.01 $0.0001\le\mbox{\tt sourceradius}\le2$
Radius in degrees of circle that will be drawn around each detected source.
 
runshowdetectnobooleantruefalse$\vert$true
Boolean switch determining whether or not to show the result of the eboxdetect run in each iteration.
 
withrefsrclistnobooleanfalsefalse$\vert$true
Boolean parameter controlling the source reference input method. When set to false the celestial coordinates of the reference sources have to be typed in explicitly, otherwise they are taken from the source list data set in refsrclist.
 
refsrclistnodata set name of existing source list
If withrefsrclist is set to true the parameter contains the name of an eboxdetect-compliant source list from which the true celestial coordinates of the reference sources are to be read. Actually, from all the columns in an eboxdetect source list only RA and DEC shall be used, i.e., the others can be omitted. The source table row number is used as the source index starting from 1.
 
phinoreal  $-3600\le\phi\le+3600$
Starting value of the boresight misalignment angle $180^{\circ}-\phi$ (see Figure 1) in arcsecs.
 
thetanoreal  $-3600\le\phi\le+3600$
Starting value of the boresight misalignment angle $\theta$ (see Figure 1) in arcsecs.
 
psinoreal  $-3\le\psi\le+3$
Starting value of the boresight misalignment angle $\psi$ (see Figure 1) in degrees.
 
tol1noreal1.e-1 $10^{-10}\le\mbox{\tt tol1}\le10^{-1}$
The parameter controls the stopping criterion for the stage-I minimization as described above. The scheme stops if the fractional convergence tolerance in the function value $\epsilon$ is lower than the given value. Please note: The default value is quite large because the stage-I minimization is only intended to yield approximately correct value for $\phi$ and $\theta$ for a given fixed $\psi$.
 
tol2noreal1.e-4 $10^{-10}\le\mbox{\tt tol1}\le10^{-1}$
The parameter controls the stopping criterion for the stage-II minimization as described above. The scheme stops if the fractional convergence tolerance in the function value $\epsilon$ is lower than the given value. Please note: This value is smaller than the corresponding one for stage I because is determines the quality of the final set of angles.
 
maxiternointeger1000 $0\le\mbox{\tt maxiter}\le1000$
Maximum allowed number of iterations in stage I + stage II to find a unique solution.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30