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

Coordinate transformations

• CAL_rawXY2mm -- pixel coordinates to physical position
  

  
  

  SYNOPSIS

  
  
  

  subroutine CAL_rawXY2mm(rawX, rawY, Xmm, Ymm, Zmm, coordSysType)
      use types
      integer(kind=int16), dimension(:), intent(in)   :: rawX, rawY
      real(kind=double), dimension(:), pointer        :: Xmm, Ymm, Zmm
      integer(kind=int32), intent(in), optional       :: coordSysType
  end subroutine

  DESCRIPTION

  
  Routine to convert CCD pixel coordinates in the PIXCOORD1 reference frame into either the SACCOORD, CAMCOORD1, CAMCOORD2 frame, i.e., physical locations in the focal plane. According to the setting of the boolean state variable randomize an initial $\pm0.5$ pixel randomization is carried out.

  ARGUMENTS

  
  
  

  
  

  In:

  
  

  rawX, rawY

  
  arrays with X/Y pixel coordinates on the current CCD chip expressed in the PIXCOORD1 reference frame

  coordSysType

  
  integer parameter in the range $0--2$ selecting either SACCOORD, CAMCOORD1, CAMCOORD2 as target reference frame. It is recommended to use the symbolic constants SACCOORD, CAMCOORD1, and CAMCOORD2 (see caltypes.f90) instead of $0-2$. coordSysType is optional, if omitted it defaults to SACCOORD.

  
  

  Out:

  
  

  Xmm, Ymm, Zmm

  
  three real arrays containing the converted pixel positions in the reference frame selected by the coordSysType parameter.

  USED STATE VARIABLES

  
  instrument, ccdChipId, ccdNodeId, randomize

  CCF ACCESS

  
  LinCoord

  
  
  

• CAL_pixCoord0ToPixCoord1 -- PIXCOORD0 $\longrightarrow$ PIXCOORD1
  
  
  
  
• CAL_pixCoord1ToPixChipCoord -- PIXCOORD1 $\longrightarrow$ CHIPCOORD
  
  
  
  
• CAL_chipCoordToPixCoord1 -- CHIPCOORD $\longrightarrow$ PIXCOORD1
  
  
  
  
• CAL_chipCoordToCamCoord1 -- CHIPCOORD $\longrightarrow$ CAMCOORD1
  
  
  
  
• CAL_camCoord1ToChipCoord -- CAMCOORD1 $\longrightarrow$ CHIPCOORD
  
  
  
  
• CAL_camCoord1ToCamCoord2 -- CAMCOORD1 $\longrightarrow$ CAMCOORD2
  
  
  
  
• CAL_camCoord2ToCamCoord1 -- CAMCOORD2 $\longrightarrow$ CAMCOORD1
  
  
  
  
• CAL_camCoord2ToSacCoord -- CAMCOORD2 $\longrightarrow$ SACCOORD
  
  
  
  
• CAL_sacCoordToCamCoord2 -- SACCOORD $\longrightarrow$ CAMCOORD2
  
  
  
  
• CAL_sacCoordToRowCoord -- SACCOORD $\longrightarrow$ ROWCOORD
  
  
  
  
• CAL_rowCoordToSacCoord -- ROWCOORD $\longrightarrow$ SACOORD
  
  
  
  
• CAL_camCoord2ToTelCoord -- CAMCOORD2 $\longrightarrow$ TELCOORD
  
  
  
  
• CAL_telCoordToCamCoord2 -- TELCOORD $\longrightarrow$ CAMCOORD2
  

  
  

  SYNOPSIS

  
  
  

  !   PIXCOORD0 -> PIXCOORD1
  subroutine CAL_pixCoord0ToPixCoord1(telX, telY, rawX, rawY)
      use types
      integer(kind=int16), dimension(:), intent(in)   :: telX, telY
      integer(kind=int16), dimension(:), pointer      :: rawX, rawY
  end subroutine
  
  

  
  !   PIXCOORD1 <-> CHIPCOORD
  subroutine CAL_pixCoord1ToChipCoord(rawX, rawY, chipX, chipY, &
                                      nodes)
      use types
      integer(kind=int16), dimension(:), intent(in)   :: rawX, rawY
      integer(kind=int16), dimension(:), pointer      :: chipX, chipY
      integer(kind=int8), dimension(:), intent(in), optional :: nodes
  end subroutine
  
  

  
  subroutine CAL_chipCoordToPixCoord1(chipX, chipY, rawX, rawY, nodes)
      use types
      integer(kind=int16), dimension(:), intent(in)   :: chipX, chipY
      integer(kind=int16), dimension(:), pointer      :: rawX, rawY
      integer(kind=int8), dimension(:), pointer, optional :: nodes
  end subroutine
  
  

  
  !   CHIPCOORD <-> CAMCOORD1
  subroutine CAL_chipCoordToCamCoord1(chipX, chipY, &
                                      xmm1, ymm1, zmm1)
      use types
      integer(kind=int16), dimension(:), intent(in)   :: chipX, chipY
      real(kind=double), dimension(:), pointer        :: xmm1, ymm1, zmm1
  end subroutine
  
  

  
  subroutine CAL_camCoord1ToChipCoord(xmm1, ymm1, zmm1, &
                                      chipX, chipY)
      use types
      real(kind=double), dimension(:), intent(in)     :: xmm1, ymm1, zmm1
      integer(kind=int16), dimension(:), pointer      :: chipX, chipY
  end subroutine
  
  

  
  !   CAMCOORD1 <-> CAMCOORD2
  subroutine CAL_camCoord1ToCamCoord2(xmm1, ymm1, zmm1, &
                                      xmm2, ymm2, zmm2)
      use types
      real(kind=double), dimension(:), intent(in)     :: xmm1, ymm1, zmm1
      real(kind=double), dimension(:), pointer        :: xmm2, ymm2, zmm2
  end subroutine
  
  

  
  subroutine CAL_camCoord2ToCamCoord1(xmm2, ymm2, zmm2, &
                                      xmm1, ymm1, zmm1)
      use types
      real(kind=double), dimension(:), intent(in)     :: xmm2, ymm2, zmm2
      real(kind=double), dimension(:), pointer        :: xmm1, ymm1, zmm1
  end subroutine
  
  

  
  !   CAMCOORD2 <-> SACCOORD
  subroutine CAL_camCoord2ToSacCoord(xmm2, ymm2, zmm2, &
                                     xmmSc, ymmSc, zmmSc)
      use types
      real(kind=double), dimension(:), intent(in)  :: xmm2, ymm2, zmm2
      real(kind=double), dimension(:), pointer     :: xmmSc, ymmSc, zmmSc
  end subroutine
  
  

  
  subroutine CAL_sacCoordToCamCoord2(xmmSc, ymmSc, zmmSc, &
                                     xmm2, ymm2, zmm2)
      use types
      real(kind=double), dimension(:), intent(in)  :: xmmSc, ymmSc, zmmSc
      real(kind=double), dimension(:), pointer     :: xmm2, ymm2, zmm2
  end subroutine
  
  

  
  !   SACCOORD <-> ROWCOORD
  subroutine CAL_sacCoordToRowCoord(xmmSc, ymmSc, zmmSc, &
                                    beta, chi)
      use types
      real(kind=double), dimension(:), intent(in)  :: xmmSc, ymmSc, zmmSc
      real(kind=double), dimension(:), pointer     :: beta, chi
  end subroutine
  
  

  
  subroutine CAL_rowCoordToSacCoord(beta, chi, &
                                    xmmSc, ymmSc, zmmSc)
      use types
      real(kind=double), dimension(:), intent(in)  :: beta, chi
      real(kind=double), dimension(:), pointer     :: xmmSc, ymmSc, zmmSc
  end subroutine
  
  

  
  !   CAMCOORD <-> TELCOORD
  subroutine CAL_camCoord2ToTelCoord(xmm2, ymm2, zmm2, theta, phi)
      use types
      real(kind=double), dimension(:), intent(in)  :: xmm2, ymm2, zmm2
      real(kind=double), dimension(:), pointer     :: theta, phi
  end subroutine
  
  

  
  subroutine CAL_telCoordToCamCoord2(theta, phi, xmm2, ymm2, zmm2)
      use types
      real(kind=double), dimension(:), intent(in)  :: theta, phi
      real(kind=double), dimension(:), pointer     :: xmm2, ymm2, zmm2
  end subroutine

  DESCRIPTION

  
  The set of coordinate conversion routines as depicted in the figure above

  ARGUMENTS

  
  
  

  
  

  InOut:

  
  

  telX, telY

  
  arrays with X/Y pixel coordinates on the current CCD chip expressed in the PIXCOORD0 reference frame

  rawX, rawY

  
  arrays with X/Y pixel coordinates on the current CCD chip expressed in the PIXCOORD1 reference frame

  chipX, chipY

  
  arrays with X/Y pixel coordinates on the current CCD chip expressed in the CHIPCOORD reference frame

  xmm1, ymm1, zmm1

  
  arrays with X/Y/Z Cartesian coordinates in the CAMCOORD1 reference frame

  xmm2, ymm2, zmm2

  
  arrays with X/Y/Z Cartesian coordinates in the CAMCOORD2 reference frame

  xmmSc, ymmSc, zmmSc

  
  arrays with X/Y/Z Cartesian coordinates in the SACCOORD reference frame

  beta, chi

  
  arrays with $\beta/\chi$ angle coordinates in the ROWCOORD reference frame

  theta, phi

  
  arrays with $\theta/\phi$ angle coordinates in the TELCOORD reference frame

  USED STATE VARIABLES

  
  instrument, ccdChipId, ccdNodeId, randomize

  CCF ACCESS

  
  LinCoord