XMM-Newton Science Analysis System


eimchip2sky (eimchip2sky-2.0.1) [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
templateset	yes	dataset
The name of the input template image. This supplies information about the projection plane and pixel size (via WCS keywords) and pixel dimensions (via the array dimensions) of the output image.
chipimgsets	yes	dataset list
A list of names of input images (in chip coordinates).
ccdstyle	no	string	implicit	user|kwd|implicit
Controls the way in which the task obtains the CCD number for each image in the chipimgsets list (in the standard XMM-Newton numbering scheme for the relevant instrument). If ccdstyle=`user', the user is expected to submit these numbers explicitly via the parameter ccds. If ccdstyle=`kwd', the task looks for a CCDNR keyword in the array header of each input image. If ccdstyle=`implicit', the task assumes that the order of an image in the chipimgsets list is the same as the CCD number.
ccds	yes	integer list		$1 \le$ccds$\le 12$
This parameter is only mandatory if ccdstyle=`user'. The parameter should contain a list of CCD numbers (in the standard XMM EPIC numbering scheme; see cal documentation for a description of this). The elements of this list should therefore correspond in number and order to those of chipimgsets.
outsets	no	dataset list	outset.ds
The list of output images (in sky coordinates). See section 5.2 for a description of how they match up with the input images.
withindices	no	bool	no
Whether to read the indices parameter.
indices	yes	integer list	1
See section 5.2 for a description of how they work.
attstyle	no	string	template	binnedset|template|user
As described in section 5.1, in general the attitude (ie, pointing direction and roll angle) of the spacecraft doesn't stay fixed during the course of an exposure. This `wandering' of the attitude can be approximated by sampling the attitude at a series of times during the exposure. A separate coordinate transform is computed for each attitude sample and the output image is build up of appropriately weighted contributions from each transform. The present parameter allows the user to choose whether to supply such a list of attitude samples (attstyle=`binnedset') or to simply compute a single coordinate transform for the whole exposure, either at an attitude read from the _PNT keywords of the templateset (attstyle=`template', the default) or at an attitude submitted by the user (attstyle=`user').
binnedatttab	yes	table
This parameter is read (and only mandatory) if attstyle=`binnedset'. The parameter should give the name of a dataset plus table (eg: `mySet.ds:ATT_TAB'). The table should contain samples of the XMM spacecraft attitude in time bins (see the task binned_att documentation for a description of the format).
weightstyle	no	string	gti	none|binnedset|gti
This parameter is read if attstyle=`binnedset'. A series of attitude samples is supplied; it remains to decide how to calculate the weight for each sample. weightstyle=`none' is only valid if there is only 1 attitude sample: the task will fail with an error otherwise. For weightstyle=`binnedset', the task will seek for weights in a column named WEIGHTS in the binnedatttab table. If weightstyle=`gti', the task attempts to obtain a list of Good Time Intervals (GTIs), the exact way these are supplied being dictated via the parameter gtistyle; these GTIs are ANDed with the attitude time bins; the net GTI in each bin provides the weight.
gtistyle	no	string	fromimages	user|kwd|fromimages|gtitablist
This parameter is read if weightstyle=`gti'. In this case the task attempts to obtain a list of Good Time Intervals (GTIs); these GTIs are ANDed with the attitude time bins; the net GTI in each bin provides the weight. Note that matters are complicated by the fact that different CCDs usually have different sets of GTIs. Parameter gtistyle specifies the way in which GTIs are supplied. If gtistyle=`user', the task obtains a single, simple GTI for all chip images from the parameters tstart and tstop. The same is true if gtistyle=`kwd', except that the task expects to the start and stop times in keywords TSTART and TSTOP, (or whatever alternates are specified via parameters tstartkwd and tstopkwd), in the FITS table specified by the parameter kwdtab. Slightly more freedom is afforded by the alternate gtistyle=`fromimages': in this case the task looks for a separate set of $N$ GTIs for each input image, specified in a table in each image dataset. Only 1 common table name, specified in parameter gtitabname, is allowed however. The final alternate, gtistyle=`gtitablist', affords the most general and flexible specification of GTIs. In this case the task looks for a list of GTI tables in the parameter gtitablist. Note that this parameter must have the same number of elements as chipimgsets.
tstart	yes	real
This parameter is read if gtistyle=`user'. Specifies the start of the single, universal GTI.
tstop	yes	real
This parameter is read if gtistyle=`user'. Specifies the end of the single, universal GTI.
kwdtab	yes	table
This parameter is read if gtistyle=`kwd'. It gives the FITS table description in which to find the GTI start and stop keywords.
tstartkwd	no	string	TSTART
This parameter is read if gtistyle=`kwd'. Name of the keyword in kwdtab which specifies the start of the single, universal GTI.
tstopkwd	no	string	TSTOP
This parameter is read if gtistyle=`kwd'. Name of the keyword in kwdtab which specifies the end of the single, universal GTI.
gtitabname	yes	string
This parameter is read if gtistyle=`fromimages'. Gives the common name of an extension containing GTIs in each input image.
gtitablist	yes	table
This parameter is read if gtistyle=`gtitablist'. A list of FITS table descriptions, 1 per input image, which should contain GTI lists.
ra	yes	real
This parameter is read (and only mandatory) if attstyle=`user'.
dec	yes	real
This parameter is read (and only mandatory) if attstyle=`user'.
apos	yes	real
This parameter is read (and only mandatory) if attstyle=`user'.
usefast	no	bool	yes
Whether to use a fast, approximate or slow and accurate regridding algorithm.
conserveflux	no	bool	yes
A CCD pixel covers, in general, a different amount of sky to a sky-image pixel. With some sorts of quantities (eg background rate per pixel) this change of area matters; for others (eg exposure time) it does not. In the former case you should set conserveflux to `yes', in the latter, `no'.
withnormalize	no	bool	no
I am no longer sure what this is about. Best to leave it at default!
tempset	no	dataset	tempset.ds
Name of a temporary dataset. If you are running more than 1 invocation of the task in the same working directory, you should name this uniquely for each invocation, to avoid crosstalk.
Parameter	Mand	Type	Default	Constraints