XMM-Newton Science Analysis System
attbin (attcalc2-1.5) [xmmsas_20211130_0941-20.0.0]
Besides being used in equation 1, the average attitude is written to the output dataset in the form of the following keywords:
- RA_PNT: the average right ascension of the spacecraft -X axis during the time period of interest.
- DEC_PNT: the average declination of the spacecraft -X axis during the time period of interest.
- PA_PNT: the average roll angle, ie the position angle of the spacecraft -Z axis during the time period of interest.
- AVRG_PNT: records the type of average. In the present case this can take values `MEAN' or `MEDIAN'.
The way in which the average attitude is calculated depends on the attsource and odfattsource parameters as follows:
- timesource=`eventlist': in this case the average values are not calculated at all, rather they are sought from the file pointed to by parameter pntkwdset. Why doesn't attbin
calculate the average itself in this circumstance? Because the time difference between successive events in the event list can vary. `Average attitude' only makes sense if the times of the attitude samples are regularly spaced.
The filename supplied to pntkwdset should normally be the output file of atthkgen, which is the SSC product file with the name string ATTTSR. The sought keywords have the form `tsa', where `t' is either `M' for median or `A' for mean, `s' is either `AHF' or `OM', and `a' is either `RA', `DEC' or `PA'. The exact values of `t' and `s' looked for depend on the parameters withmedianpnt and odfattsource. The relevant keywords are copied to the output dataset, but in the *_PNT format. The value written to AVRG_PNT is `MEDIAN' if withmedianpnt=`yes' and 'MEAN' if withmedianpnt=`no'.
- timesource=`user': here the time samples are evenly spaced, so it makes sense to calculate an average. The attitude is obtained from the ODF via an oal
call for each time sample. This call returns either true, for successful, or false, for unsuccessful. The average of each attitude component (ie RA, dec and apos) is calculated as either the mean or the median (depending on the value of withmedianpnt) of all the successful values.
- attsource=`atthk': in this case the time samples are obtained from the atthk file (atthkset), therefore are expected to be uniform; however the averages of these values have already been calculated and are present as keywords. The action of the task in this circumstance is thus identical to that described in the first item above (except that the choice between AHF and OM is governed by parameter atthkattsource).
XMM-Newton SOC -- 2021-11-30