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

bkgoptrate (bkgfilter-1.8.1) [xmmsas_20211130_0941-20.0.0]


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

ParameterMand Type Default Constraints
Name of the input FITS data set and table, the latter of which can be added, following the `:', such as, `input1.ds:EVENTS'.
Column name of X-axis.
Column name of Y-axis.
Column name of FRACEXP.
Style of the input time-series.
Whether start time is specified (Default: No). If yes, the task reads starttime.
Start time to evaluate.
Whether end time is specified (Default: No). If yes, the task reads endtime.
End time to evaluate.
Style of handling method of FRACEXP. If threshold, the task reads fracexplower.
fracexploweryesreal $0 \ge f \ge 1$
Lower threshold for FRACEXP to be used in the calculation.
Whether the lower cutoff count (or rate) is specified. If yes, the task reads lowercutoffcount.
lowercutoffcountyesreal0.0$\ge 0$
The lower threshold count or ratio in search for the optimum value, that is, any bin having the count (or ratio) equal to, or smaller than, this value is not taken into account in the search. This value has to be either zero or positive.
Whether the minimum time ratio is specified. If yes, the task reads mintimeratio.
mintimeratioyesreal0.05$\ge 0$
The ratio of the acceptable minimum number of (time) bins (or row numbers in the FITS table) to the initial number of bins after other filtering is applied, during the search for the optimum value. If the search does not find the optimum threshold with larger number of bins, then the task raises an error and exits.
If yes, the lower-count tail is ignored and the best local maximum is used to derive the output threshold, when smaller the background count (rate) threshold is, better the statistics will be. Otherwise, in those cases, an error noThresholdFound is issued, unless the number of bins that contains the smallest count consists more than the third of the entire light-curve.
Whether inserting the header attributes in the input time-series dataset. If yes, the (header of the) input time-series dataset will be modified.
Whether outputting the table of signal-to-noise ratio etc (see text for detail) to the cutoff rate/count.
Name of the output table of signal-to-noise ratio to the cutoff rate/count in the form of “FILE.fits:TABLENAME”.
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30