XMM-Newton Science Analysis System


lccorr_pcms (lccorr_pcms-1.1.7) [xmmsas_20070308_1802-6.6.0]

Meta Index / Home Page

Parameters

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

Parameter	Mand	Type	Default	Constraints
srctsset	yes	dataset
Name of the input timeseries.
eventset	yes	dataset
Name of the whole-camera event list (for either MOS1, 2 or PN, as appropriate).
withbkgtsset	no	boolean	no
Look for a bkg timeseries name on the command line.
bkgtsset	no	dataset	bkg_ts.ds
Name of the input local background timeseries.
bkgweightstyle	no	string	flat	none|user|flat
In order to correct properly for GTIs, lccorr_pcms needs to know what fraction of events fall on which CCD. (It is assumed that this fraction does not vary over time.) If the spatial distribution of the events is known, these weights can be computed by projecting this distribution against the detector, masked by the selection region; alternatively it may on occasion be simplest just input the CCD weights directly. lccorr_pcms now allows the user several options (with possibly more to come in future). If bkgweightstyle=`none', the task assumes that all the weights equal 1. If bkgweightstyle=`user', the weights are read from parameter bkgweightsnode0 (and, optionally, bkgweightsnode1). Finally, for bkgweightstyle=`flat', the task assumes a uniform spatial distribution of events and projects this distribution against the masked detector CCDs to calculate the weights.
bkgweightsnode0	yes	real list		0 $\le$ bkgweightsnode0
If bkgweightstyle=`user', this list of values is read by the task. Each value, as a fraction of their sum, should be the fraction of events that are expected to fall on the respective CCD. (If both primary and redundant nodes were used to readout any CCD, the respective weight in the bkgweightsnode0 list should instead be that fraction of bkg events expected to fall on the primary-node half of the CCD. The user should also in this case set withbkgnode1=`yes' and supply the redundant-node weights via bkgweightsnode1.) The user must supply as many values as there are CCDs in the detector: ie 12 for PN and 7 for MOS. The weights should be listed in order of increasing CCD number.
withbkgnode1	no	boolean	no
The task reads this parameter if bkgweightstyle=`user'. withbkgnode1 instructs the task to look for a list of redundant-node weights in parameter bkgweightsnode1.
bkgweightsnode1	yes	real list		0 $\le$ bkgweightsnode1
If bkgweightstyle=`user' and withbkgnode1=`yes', this list of values is read by the task. Each value, as a fraction of their sum, should be the fraction of events that are expected to fall on the redundant-node half of the respective CCD. The user must supply as many values as there are CCDs in the detector: ie 12 for PN and 7 for MOS. The weights should be listed in order of increasing CCD number.
bkgarea	no	real	1.0	0 $<$ bkgarea
If bkgweightstyle=`user', this value is read by the task. The user should provide the area of the extraction region, in units of CCD pixels, not counting dead pixels, chip gaps or other non-live areas of the detector. This parameter is necessary if the background is to be subtracted from the source, in which case the ratio between the areas of the source and background extraction regions must be known.
subtractbkg	no	boolean	no
Whether to subtract the background from the source count rate.
bkgregiontab	yes	table
DSS replacement. Records (background) events selections on X, Y, DETX and DETY.
outset	no	dataset	output_ts.ds
Name of the output dataset containing the corrected source and background time series.
tempset	no	dataset	temp_output_ts.ds
Temporary name of output dataset.
tempeventset	no	dataset	temp_evlist.ds
Name of a temporary event list set.
srcweightstyle	no	string	deduce	none|user|deduce
In order to correct properly for GTIs, lccorr_pcms needs to know what fraction of events fall on which CCD. (It is assumed that this fraction does not vary over time.) If the spatial distribution of the events is known, these weights can be computed by projecting this distribution against the detector, masked by the selection region; alternatively it may on occasion be simplest just input the CCD weights directly. lccorr_pcms now allows the user several options (with possibly more to come in future). If srcweightstyle=`none', the task assumes that all the weights equal 1. If srcweightstyle=`user', the weights are read from parameter srcweightsnode0 (and, optionally, srcweightsnode1). Finally, for srcweightstyle=`deduce', the task assumes that the source is point-like and attempts to estimate the fraction of source events falling on each CCD.
srcweightsnode0	yes	real list		0 $\le$ srcweightsnode0
If srcweightstyle=`user', this list of values is read by the task. Each value, as a fraction of their sum, should be the fraction of events that are expected to fall on the respective CCD. (If both primary and redundant nodes were used to readout any CCD, the respective weight in the srcweightsnode0 list should instead be that fraction of src events expected to fall on the primary-node half of the CCD. The user should also in this case set withsrcnode1=`yes' and supply the redundant-node weights via srcweightsnode1.) The user must supply as many values as there are CCDs in the detector: ie 12 for PN and 7 for MOS. The weights should be listed in order of increasing CCD number.
withsrcnode1	no	boolean	no
The task reads this parameter if srcweightstyle=`user'. withsrcnode1 instructs the task to look for a list of redundant-node weights in parameter srcweightsnode1.
srcweightsnode1	yes	real list		0 $\le$ srcweightsnode1
If srcweightstyle=`user' and withsrcnode1=`yes', this list of values is read by the task. Each value, as a fraction of their sum, should be the fraction of events that are expected to fall on the redundant-node half of the respective CCD. The user must supply as many values as there are CCDs in the detector: ie 12 for PN and 7 for MOS. The weights should be listed in order of increasing CCD number.
srcarea	no	real	1.0	0 $<$ srcarea
If srcweightstyle=`user', this value is read by the task. The user should provide the area of the extraction region, in units of CCD pixels, not counting dead pixels, chip gaps or other non-live areas of the detector. This parameter is necessary if the background is to be subtracted from the source, in which case the ratio between the areas of the source and background extraction regions must be known.
srcposstyle	no	string	user	user|keyword|dss
If srcweightstyle=`deduce', the task attempts to calculate the fraction of events falling on each CCD. To do this correctly, the task needs to know the RA and dec of the source. The task provides the user, via the present parameter, with a choice of ways to specify this position. If srcposstyle=`user', the task reads the source position from parameters srcra and srcdec; if `keyword', the task looks for keywords SRC_RA and SRC_DEC (in decimal degrees) in the dataset given in parameter srcposset; if `dss', the task attempts to deduce the centre of the spatial selection regions stored in the srcregiontab.
srcra	yes	angle	0.0	0 $\le$ srcra$<$ 360
RA of the source. Read by the task if srcposstyle=`user'.
srcdec	yes	angle	0.0	-90 $\le$ srcdec$\le$ 90
Dec of the source. Read by the task if srcposstyle=`user'.
srcposset	no	dataset	srcposset.ds
If srcposstyle=`keyword', the present parameter is read by the task. It contains the name of the dataset containing source position keywords SRC_RA and SRC_DEC. Their values should be in decimal degrees.
srcdeducestyle	no	string	psf	psf|events
If srcweightstyle=`deduce', the task attempts to calculate the fraction of events falling on each CCD. There are (at present) two ways to do this, corresponding to the choices `psf' and `events': If `psf', the task models the Point Spread Function (PSF) can calculates the fraction of this PSF which falls on each CCD in the collection area. If srcdeducestyle=`events', the task just counts, for each CCD, the total number of events which fall within the extraction region.
efrac	yes	real	0.95	0 $<$ efrac$<$ 1
This parameter is read by the task if srcdeducestyle=`psf'. The PSF model is necessarily truncated to a square area. The present parameter defines the size of this area as that which contains (approximately) fraction efrac of the total flux. efrac should be chosen to be high enough such that these square array bounds are larger than the collection area, otherwise the source weights may be incorrect.
treatvignet	no	boolean	yes
Calculate corrections for the mirror vignetting?
treatfiltertrans	no	boolean	yes
Calculate corrections for the filter attenuation?
treatquantumeff	no	boolean	yes
Calculate corrections for quantum efficiency of the ccds?
treatcosmicrays	no	boolean	yes
Calculate corrections for cosmic ray masking?
treatdeadtime	no	boolean	yes
Calculate corrections for frame readout dead time?
treatgti	no	boolean	yes
Calculate corrections for events lost outside GTIs?
treatalias	no	boolean	no
Where the event times are not dithered within the frame duration (the default for PN event lists at time of writing, on 23 Sept 2004), one can generally expect that the binned events will exhibit some form of periodic noise at the difference frequency (plus harmonics) between the time series binning frequency and the CCD frame readout frequency. If treatalias is set `yes', lccorr_pcms will attempt to correct this effect. At present it is recommended to leave this parameter at default.
applycorrections	no	boolean	yes
Apply the exposure corrections to source and background count rates?
patternlo	no	int
DSS replacement. The lowest value of event PATTERN which was selected.
patternhi	yes	int
DSS replacement. The highest value of event PATTERN which was selected.
flagmask	no	string	0x0
DSS replacement. The selection mask applied to the events FLAG column.
pilos	yes	int
DSS replacement. A list of lower bounds of selections on column PI.
pihis	yes	int
DSS replacement. A list of upper bounds of selections on column PI.
withgtis	no	bool	no
Whether to look for GTI tables listed in parameter gtitabsnode0.
gtitabsnode0	yes	table
DSS replacement. A list of GTI tables, one per CCD, recording selections on column TIME.
withgtitabsnode1	no	bool	no
Whether to look in parameter gtitabsnode1 for a list of redundant-node GTI tables.
gtitabsnode1	yes	table
DSS replacement. Similar to gtitabsnode0, but for the redundant node.
rawylo	no	int
DSS replacement. Allows an extra lower bound to be placed on RAWY.
srcregiontab	yes	table
DSS replacement. Records events selections on X, Y, DETX and DETY.
Parameter	Mand	Type	Default	Constraints