XMM-Newton Science Analysis System


ssclib (ssclib-4.36.1) [xmmsas_20230412_1735-21.0.0]

A module containing routines to give supplementary information about EPIC

Module name: epic_aux

Author: Masaaki Sakano (University of Leicester, mas@star.le.ac.uk)

Note that the contents of these routines should be ideally defined somewhere in the library of EPIC.

In the EPIC event files, they use Table names for the exposure in the form of

   'EXPOSU'//ccdNodeNum

where ccdNodeNum is a serial number for ccdNum (CCD chip number) and nodeNum (chip node number for MOSs, of which the default is 1 in almost all the actual observations except for a very few test observations). ccdNodeNum is defined and hard-coded in the related tasks as

  $${\rm ccdNodeNum} = 10 \times ({\rm nodeNumLocal} - 1) + {\rm ccdNum}.$$ (5)

The following subroutines in this module give this relation.

  function getCcdNodeNum(ccdNum, nodeNum) result(ccdNodeNum)
    integer(int8), intent(in) :: ccdNum
    integer(int8), intent(in), optional :: nodeNum
  end function getCcdNodeNum

  subroutine inverseCcdNodeNum(ccdNodeNum, ccdNum, nodeNum, instrumentId)
    integer(int32), intent(in) :: ccdNodeNum
    integer(int8),  intent(out) :: ccdNum
    integer(int8),  intent(out), optional :: nodeNum
    integer(int32), intent(in),  optional :: instrumentId
  end subroutine inverseCcdNodeNum

In the latter inverseCcdNodeNum(), if instrumentId is not given, CAL is read and is essential.