![$[0, TELAPSE]$](img45.png){kind=small}
where 
is the duration of the observation.
![$[0, 5]$](img47.png){kind=small}
corresponding to defects ok/hot/flickering/dead/pinhole/unspecified.
Corresponding symbolic names are available in the file
caltypes.f90.
In case of the OM, information about the severity of the defect are encoded
in this output argument as well: defect modulo 10 yields the
type of the defect (as above) and defect / 10 (integer division)
gives the associated defect severity as an integer number in the range
![$[0..9]$](img48.png){kind=small}
.
rawYsize;
if no window is specified, the image covers the entire CCD chip area,
e.g., the size is
for EMOS1. The actual size
can be inquired with the Fortran-90 size() operator
function; if the pixel 
is not defect, the value of map(i,j)
will be zero. For defect pixels map(i,j) modulo 10 gives the type of
defect in the range ![$[0-5]$](img52.png){kind=small}
(see above for the encoding). INT(map(i,j),
10) will be 1 if the pixel is declared defect on-board, 0 otherwise.
In the case of OM the map is always at maximum detector resolution
(centroided pixels).
angle coordinates in the
TELCOORD reference frame
of 3-2-1 Euler angles. These define the
transformation from the SACCOORD reference frame into the
Instrument Boresight System (INS) (in which the 
-axis is formed by the
telescope's optical axis) by three successive rotations about the 
-,
-, and 
-axes respectively. The return type is a structure
of type EulerAngles321
(see caloaldefs.f90
that can be converted to a direction cosine matrix of the INS frame via
CAL_toDirectionCosineMatrix.
function CAL_toDirectionCosineMatrix(eulerAngles) result(matrix)
use CalTypes
type(EulerAngles321) :: eulerAngles
real(kind=double), dimension(:,:), pointer :: matrix
end function
is a SACCOORD vector, then
 |
(1) |
for real, orthogonal matrices yields
![\begin{displaymath}
\vec{O} = \mbox{\boldmath BSM}^{-1} \left(\begin{array}{c}1\...
...[0]}\\ \mbox{BSM[0][1]}\\ \mbox{BSM[0][2]}
\end{array}\right)
\end{displaymath}](img61.png) |
(2) |
expressed in the SACCOORD reference frame.
This means that is simply given by the first row of BSM.
The second (BSM[1][0], BSM[1][1], BSM[1][2]) and third
(BSM[2][0], BSM[2][1], BSM[2][2]) row of BSM define the 
-
and 
-axis of the INS frame expressed in the SACCOORD system.
Please note: The first index of the array returned by
this function indicates the row number of the corresponding boresight
matrix, not the column number. Although this adheres to the usual convention,
it is opposite to the sense of the arrays returned by
OAL_toAttitudeMatrix (see oal)
in which the first index of the array is the column number.
In other words, to translate for example the matrix equation
 |
(3) |
call CAL_getBoresightMatrix(timestamp, BSM)
call OAL_toAttitudeMatrix(att, ASC)
ASC_trans = transpose(ASC)
INS_trans = matmul(BSM, ASC_trans)
This leaves the array INS_trans adhering to the usual convention, i.e.
the first index of the array INS_trans represents the row number of
the matrix.
direction cosine matrix -
has to be deleted after last use with
CAL_releaseMemory
 |
(4) |
being the radial distance from the centre of the field-of-view.
versus PI channel numbers for the diffuse X-ray background at the input
point and time.
function CAL_getEffectiveArea(Efrom, Eto, theta, phi) result(area)
use types
real(kind=double), intent(in) :: Efrom, Eto, &
theta, phi
real(kind=double) :: area
end function
. The obscuration effect of the
RGA (for EMOS1 and EMOS2) is taken into account.
. The central pixel in each pattern (pattern(i, 2, 2))
is the one with the highest charge (
). This and all other pixels above
the EDU threshold are marked with the value 1 in the pattern image.
The value 2 denotes pixels below threshold and pixels with 0 are
insignificant for the event reconstruction process (can be below or above
threshold). Details for EPN are TBD.
function CAL_getFilterTransmission(Efrom, Eto, theta, phi) &
result(transmission)
use types
real(kind=double), intent(in) :: Efrom, Eto, &
theta, phi
real(kind=double) :: transmission
end function
![$[0, 1]$](img71.png){kind=small}
.
The second form returns the transmission curve integrated over a given
energy interval weighted by .
rawYsize;
if no window is specified, the image covers the entire CCD chip area,
e.g., the size is
for EMOS1. The actual size
can be inquired with the Fortran-90 size() operator
function; if the pixel is within the field of view
the value of map(i,j) will be 1 otherwise 0.
In the case of OM the map is always at maximum detector resolution
(centroided pixels).
corresponds to the PIXCOORD1
coordinate 
.
, off-axis angle 
and
azimuth angle 
. The CAL/CCF offers PSF construction at three
distinct accuracy levels (selected via state variable accuracyLevel):
| accuracyLevel | scheme | description |
| ACCURACY_LOW | analytic | the PSF is constructed using an analytic expressions involving energy/field-angle dependent parameters which are available in the CCF. This mode is supposedly the fastest way to compute the PSF. Please note that the accuracy of this model is very limited and should therefore merely be used if the detailed shape of the PSF does not matter. Consult the Calibration Access and Data Handbook for more information on this especially limitations concerning the evaluation of encircled energies with this model. |
| ACCURACY_MEDIUM | tabular | the PSF is constructed from tabulated data in the CCF, i.e., small maps of PSFs at various fixed energies and off-axis angles; interpolation in E and/or theta is carried out as required; for details please consult the Calibration Access and Data Handbook. |
| ACCURACY_EXTENDED | analytic | the PSF is constructed using an analytic King-Gauss description; see Calibration Access and Data Handbook for details. |
| ACCURACY_HIGH | analytic | the PSF is constructed using a superposition of multiple Gaussians modified by azimuthal terms; see Calibration Access and Data Handbook for details. |
] at the requested position.
subroutine CAL_psfSetBinSize(psf, binSize)
use CalTypes
type(PsfT) :: psf
type(PsfBinSizeT) :: binSize
end subroutine
function CAL_psfBinSize(psf) result(binSize)
use CalTypes
type(PsfT) :: psf
type(PsfBinSizeT) :: binSize
end function
, 
being the size of the image bins in x- and y-direction
and 
the value of the PSF at the center of the image
bin 
.
signifying the fraction of the total
photonic energy contained in the box whose extents is to be determined.
signifying the fraction of the total
photonic energy contained in the circle whose radius is to be determined.
versus PI channel numbers for particle background at the input
point and time. The background is modeled according to the simple
prescription:
 |
(5) |
function CAL_getQuantumEfficiency(Efrom, Eto, rawX, rawY, patternId) &
result(quantumEff)
use types
integer(kind=int16), intent(in) :: rawX, rawY
real(kind=double), intent(in) :: Efrom, Eto
integer(kind=int32), intent(in), optional :: patternId
real(kind=double) :: quantumEff
end function
function CAL_getLargePatterns(Efrom, Eto) &
result(largePatts)
use types
real(kind=double), intent(in) :: Efrom, Eto
real(kind=double) :: largePatts
end function
function CAL_curveWeightedIntegralOver(curve, &
fromValue, toValue) result(value)
use CalTypes
type(CurveT), intent(in) :: curve
real(kind=double), intent(in) :: fromValue, &
toValue
real(kind=double) :: value
end function
subroutine CAL_getRedistribution(eIn, eAxisLoBounds, eAxisHiBounds, &
response, eventType, peakChannel)
use types
real(kind=double), intent(in) :: eIn
real(kind=double), dimension(0:), intent(in) :: eAxisLoBounds,&
eAxisHiBounds
real(kind=double), dimension(:), pointer :: response
integer(kind=int32), intent(in), optional :: eventType
integer(kind=int16), intent(out), optional :: peakChannel
end subroutine
GRADE_SDTQ for all allowed values
are defined in file
caltypes.f90.
eventType is optional, if omitted it defaults to ALL_GRADES.
corresponding to
the input arguments