XMM-Newton Science Analysis System


cal (cal-3.184) [xmmsas_20070308_1802-6.6.0]

Meta Index / Home Page / Developer's notes / Using CAL in a / Using CAL from Fortran-90 / Fortran90 Interface

Calibration of data -- generic

• CAL_correctTime -- correct time values
  

  
  

  SYNOPSIS

  
  
  

  subroutine CAL_correctTime(timeCoordinate)
      use types
      real(kind=double), dimension(:), intent(inout)  :: timeCoordinate
  end subroutine

  DESCRIPTION

  
  Routine to correct event times expressed as values in the TIMCOORD time system for CCD sequencing delays and any other corrections needed to compute a mean photon absorption time.

  ARGUMENTS

  
  
  

  
  

  InOut:

  
  

  timeCoordinate

  
  array with time value to be corrected - updated on exit

  USED STATE VARIABLES

  
  instrument, ccdChipId, ccdNodeId

  CCF ACCESS

  
  TimeCorr

  
  
  

• CAL_gainCorrect -- PHA to PI channel conversion
  

  
  

  SYNOPSIS

  
  
  

  subroutine CAL_gainCorrect(time, eIn, eOut, nodes)
      use types
      real(kind=double), dimension(:), intent(in)     :: time
      real(kind=single), dimension(:), intent(in)     :: eIn
      real(kind=single), dimension(:), pointer        :: eOut
      integer(kind=int8), dimension(:), intent(in), optional &
                                                      :: nodes
  end subroutine

  DESCRIPTION

  
  Routine to convert an array of PHA channels into PI channels. This conversion takes into account the momentary principal gain value of the current CCD readout node. The routines operates on real-valued arrays, i.e., integer-valued PHA channels from ODF data sets must be converted to corresponding real arrays with routine CAL_integerToReal before it can be passed to CAL_gainCorrect.

  ARGUMENTS

  
  
  

  
  

  In:

  
  

  time

  
  array with event time coordinates in the TIMCOORD time frame. This input is required to account for time dependent gain drifts which the CAL shall monitor - currently not in effect.

  eIn

  
  input array with PHA channels to correct for gain

  nodes

  
  optional array with nodes identifiers in the range $[0,$...$, max]$ with $max$ being one less than the number of readout nodes ($max=1$ for RGS, $max=63$ for EPN). The specification of nodes overrides the default usage of the state variable ccdNodeId for inferring the readout node. Note for EPN: For using the rawX pixel coordinate array as value of nodes it has to be converted to type int8 and $-1$ has to be subtracted.

  
  

  Out:

  
  

  eOut

  
  array with gain corrected PI channels; size is equal to input arrays; can be an uninitialized pointer in which case the CAL allocates the required memory as outlined in above.

  USED STATE VARIABLES

  
  instrument, ccdChipId, ccdNodeId, temperature

  CCF ACCESS

  
  ADUConv

  
  
  

• CAL_offsetCorrect -- offset correction
  

  
  

  SYNOPSIS

  
  
  

  subroutine CAL_offsetCorrect(time, eIn, eOut, nodes)
              use types
              real(kind=double), dimension(:), intent(in)    :: time
              real(kind=single), dimension(:), intent(in)    :: eIn
              real(kind=single), dimension(:), pointer       :: eOut
              integer(kind=int8), dimension(:), intent(in), optional :: &
                                                            nodes
          end subroutine

  DESCRIPTION

  
  Routine to offset-correct an array of energy channels. It operates on real-valued arrays, i.e., integer-valued PHA channels from ODF data sets must be converted to corresponding real arrays with routine CAL_integerToReal before it can be passed to CAL_offsetCorrect.

  ARGUMENTS

  
  
  

  
  

  In:

  
  

  time

  
  array with event time coordinates in the TIMCOORD time frame. This input is required to account for time dependent offset drifts which the CAL shall monitor - currently not in effect.

  eIn

  
  input array with energy channels to correct for gain

  nodes

  
  optional array with nodes identifiers in the range $[0,$...$, max]$ with $max$ being one less than the number of readout nodes ($max=1$ for RGS, $max=63$ for EPN). The specification of nodes overrides the default usage of the state variable ccdNodeId for inferring the readout node. Note for EPN: For using the rawX pixel coordinate array as value of nodes it has to be converted to type int8 and $-1$ has to be subtracted.

  
  

  Out:

  
  

  eOut

  
  array with offset corrected energy channels; size is equal to input arrays; can be an uninitialized pointer in which case the CAL allocates the required memory as outlined in above.

  USED STATE VARIABLES

  
  instrument, ccdChipId, ccdNodeId, temperature

  CCF ACCESS

  
  ADUConv

  
  
  

• CAL_piToeV -- PI channel to eV conversion
  

  
  

  SYNOPSIS

  
  
  

  subroutine CAL_piToeV(eIn, eOut)
      use types
      real(kind=single), dimension(:), intent(in)    :: eIn
      real(kind=single), dimension(:), pointer       :: eOut
  end subroutine

  DESCRIPTION

  
  Routine to convert an array with Pulse-Invariant channel numbers into eV. This routine is extremely simple and multiplies the channel number by 1.0 to get the value in eV.

  ARGUMENTS

  
  
  

  
  

  In:

  
  

  eIn

  
  input array with energy channels to convert

  
  

  Out:

  
  

  eOut

  
  array with eV values corresponding to input channel numbers; can be an uninitialized pointer in which case the CAL allocates the required memory as outlined in above.

  USED STATE VARIABLES

  
  instrument

  CCF ACCESS

  
  ADUConv