Calibration of data -- OM-specific

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 -- OM-specific

CAL_omDistortion -- equivalent of rawXY2mm (above) for OM

SYNOPSIS

subroutine CAL_omDistortion(rawX, rawY, deltaX, deltaY, & sigmaX, sigmaY, calcMode, nInterPoints) use types real(kind=single), dimension(:), intent(in) :: rawX, rawY real(kind=single), dimension(:), pointer :: deltaX, deltaY real(kind=single), dimension(:), pointer, optional :: sigmaX, & sigmaY integer(kind=int32), intent(in), optional :: calcMode, & nInterPoints end subroutine

DESCRIPTION

Routine to calculate for a set of OM pixel positions the displacement from the ideally linear grid. This makes use of a basic calibration file containing a coarsely sampled distortion map. Interpolations/extrapolations are carried out as necessary. Two modes of calculation are supported. CAL_omDistortion is the counterpart of CAL_rawXY2mm for the X-ray instruments.

ARGUMENTS

In:

rawX, rawY

arrays with CCD (real) pixel coordinates in the PIXCOORD1 reference system;

calcMode

Optional numerical switch (default 0) determining the scheme of calculation: If calcMode=0 the offsets are calculated with a 2D-dimensional interpolation scheme while for calcMode=1 the offsets are calculated using a fit polynomial. All other values of calcMode lead to an error condition.

nInterPoints

An optional numerical parameter determining the number of data points that are used to approximate partial derivatives in the interpolation case (calcMode=0). Please note that this parameter is currently ignored.

Out:

deltaX, deltaY

calculated X/Y offset in raw (fractional) pixels

sigmaX, sigmaY

uncertainties associated with calculated offset values (optional arguments)

USED STATE VARIABLES

filterId

CCF ACCESS

AstroMet
CAL_omInverseDistortion -- inverse transform of CAL_omDistortion (above)

SYNOPSIS

subroutine CAL_omInverseDistortion(rawX, rawY, deltaX, deltaY, & sigmaX, sigmaY, calcMode, nInterPoints) use types real(kind=single), dimension(:), intent(in) :: rawX, rawY real(kind=single), dimension(:), pointer :: deltaX, deltaY real(kind=single), dimension(:), pointer, optional :: sigmaX, & sigmaY integer(kind=int32), intent(in), optional :: calcMode, & nInterPoints end subroutine

DESCRIPTION

Routine to calculate for a set of OM pixel positions the ideally linear grid from the displacements. This makes use of a basic calibration file containing a coarsely sampled distortion map. Interpolations/extrapolations are carried out as necessary. Two modes of calculation are supported. CAL_omInverseDistortion is the inverse transform of CAL_omDistortion.

ARGUMENTS

In:

rawX, rawY

arrays with CCD (idealised) pixel coordinates in the PIXCOORD1 reference system;

calcMode

Optional numerical switch (default 0) determining the scheme of calculation: If calcMode=0 the offsets are calculated with a 2D-dimensional interpolation scheme while for calcMode=1 the offsets are calculated using a fit polynomial. All other values of calcMode lead to an error condition.

nInterPoints

An optional numerical parameter determining the number of data points that are used to approximate partial derivatives in the interpolation case (calcMode=0). Please note that this parameter is currently ignored.

Out:

deltaX, deltaY

calculated X/Y offset in raw (fractional) pixels

sigmaX, sigmaY

uncertainties associated with calculated offset values (optional arguments)

USED STATE VARIABLES

filterId

CCF ACCESS

AstroMet
CAL_omGetColorTransformator -- obtain handle to color transformation object

SYNOPSIS

function CAL_omGetColorTransformator(filter1, filter2) & result(colorTrans) use CalTypes integer(kind=int32), intent(in) :: filter1, filter2 type(OmColorTransformatorT) :: colorTrans end function

DESCRIPTION

Returns a handle to an object that can perform color and magnitude conversion from the natural into the standard system. The transformation is characterized by two filters which have to be provided as input.

ARGUMENTS

In:

filter1, filter2

A pair of filters which define the color/magnitude transformation; filter1 must be at shorter wavelength than filter2 otherwise an error condition is raised. Only certain filter combinations are supported (see the Calibration Access and Data Handbook for details)

RETURNS

Handle to color transformation object to be passed to routines CAL_omColorTransValidityRange, CAL_omStandardColor, CAL_omStandardMagnitude below.

USED STATE VARIABLES

none

CCF ACCESS

ColTrans
CAL_omColorTransBranches -- inquire number of branches in Herzsprung-Russel diagram

SYNOPSIS

function CAL_omColorTransBranches(colorTrans) result(nBranches) use CalTypes integer(kind=int8) :: nBranches type(OmColorTransformatorT), intent(in) :: colorTrans end function

DESCRIPTION

For the color-color transformation defined through a preceding call to CAL_omGetColorTransformator this function inquires the number of available branches in the Herzsprung-Russel diagram.

ARGUMENTS

In:

colorTrans

handle to color transformation object returned by CAL_omGetColorTransformator.

RETURNS

Number of branches in Herzsprung-Russel diagram for selected color-color transformation.

USED STATE VARIABLES

none

CCF ACCESS

ColTrans
CAL_omColorTransSetBranch -- set a color-color transformation branch

SYNOPSIS

subroutine CAL_omColorTransSetBranch(colorTrans, branch) use CalTypes type(OmColorTransformatorT), intent(in) :: colorTrans integer(kind=int8), intent(in) :: branch end subroutine

DESCRIPTION

For color-color transformation selected through a preceding call to CAL_omGetColorTransformator this routines defines a particular branch in the Herzsprung-Russel diagram that is to be used.

ARGUMENTS

In:

colorTrans

handle to color transformation object returned by CAL_omGetColorTransformator.

branch

Integer number in the range with being the number of available branches as returned by CAL_omColorTransBranches.

USED STATE VARIABLES

none

CCF ACCESS

ColTrans
CAL_omColorTransValidityRanges -- inquire number of validity ranges of color transformation

SYNOPSIS

function CAL_omColorTransValidityRanges(colorTrans) result(nRanges) use CalTypes integer(kind=int8) :: nRanges type(OmColorTransformatorT), intent(in) :: colorTrans end function

DESCRIPTION

Inquire the number of validity limits of the color-color transformation select with preceding calls to CAL_omGetColorTransformator and (optionally) CAL_omColorTransSetBranch.

ARGUMENTS

In:

colorTrans

handle to color transformation object returned by CAL_omGetColorTransformator.

RETURNS

Number of validity ranges for selected color-color transformation.

USED STATE VARIABLES

none

CCF ACCESS

ColTrans
CAL_omColorTransValidityRange -- inquire validity range of color transformation

SYNOPSIS

function CAL_omColorTransValidityRange(colorTrans, n) result(valInterval) use CalTypes type(OmColorTransformatorT), intent(in) :: colorTrans integer(kind=int8), intent(in), optional :: n type(IntervalT) :: valInterval end function

DESCRIPTION

Inquire the validity limits of the color transformation, i.e., the input magnitudes , passed to CAL_omStandardColor must satisfy the condition for the transformation to succeed. See Calibration Access and Data Handbook for more details.

ARGUMENTS

In:

colorTrans

handle to color transformation object returned by CAL_omGetColorTransformator.

n

number of validity interval in the range with being the number of defined intervals as returned by CAL_omColorTransValidityRanges.

RETURNS

Structure of type IntervalT (see caltypes.f90 for the definition of this type) containing fields that signify the minimum and maximum legal values for the magnitude difference.

USED STATE VARIABLES

none

CCF ACCESS

ColTrans
CAL_omStandardColor -- calculate color index from two input magnitudes

SYNOPSIS

function CAL_omStandardColor(colorTrans, magnitude1, magnitude2) & result(stdColor) use CalTypes type(OmColorTransformatorT), intent(in) :: colorTrans real(kind=double), intent(in) :: magnitude1, & magnitude2 type(ValueErrorT) :: stdColor end function

DESCRIPTION

Calculate the color index from two input magnitudes in the standard system.

ARGUMENTS

In:

colorTrans

handle to color transformation object returned by CAL_omGetColorTransformator.

magnitude1, magnitude2

zero-point corrected magnitudes derived from the deadtime corrected count rate measured in the passband filter1/filter2 respectively. The first magnitude is transformed into the standard system. The second magnitude is used to determine the color correction term. The calculation requires that the magnitudes satisfy the criterion stated in CAL_omColorTransValidityRange otherwise an error condition is raised.

RETURNS

Structure of type ValueErrorT (see caltypes.f90 for the definition of this type) containing fields that signify the color in the standard system derived from the input magnitudes

USED STATE VARIABLES

none

CCF ACCESS

ColTrans
CAL_omStandardMagnitude -- Transform magnitude from instrumental into the standard system

SYNOPSIS

function CAL_omStandardMagnitude(colorTrans, stdColor, magnitude) & result(stdMagnitude) use CalTypes type(OmColorTransformatorT), intent(in) :: colorTrans type(ValueErrorT), intent(in) :: stdColor real(kind=double), intent(in) :: magnitude type(ValueErrorT) :: stdMagnitude end function

DESCRIPTION

Transforms a given input magnitude value from the instrumental into the standard system.

ARGUMENTS

In:

colorTrans

handle to color transformation object returned by CAL_omGetColorTransformator.

stdColor

color index in the standard system as returned by CAL_omStandardColor

magnitude

brightness in the instrumental system of the second filter passed to CAL_omGetColorTransformator.

RETURNS

Structure of type ValueErrorT (see caltypes.f90 for the definition of this type) containing fields that signify the value and associated error of the input magnitude transformed into the standard system (see Calibration Access and Data Handbook for details)

USED STATE VARIABLES

none

CCF ACCESS

ColTrans
CAL_omColorTransform -- convert color and magnitude from natural into standard system
SYNOPSIS

subroutine CAL_omColorTransform(filter1, filter2, & magnitude1, magnitude2, & stdColor12, stdMagnitude2, & stdColor12Error, stdMagnitude2Error) use types integer(kind=int32), intent(in) :: filter1, filter2 real(kind=double), intent(in) :: magnitude1, & magnitude2 real(kind=double), intent(out) :: stdColor12, & stdMagnitude2 real(kind=double), intent(out), optional :: stdColor12Error, & stdMagnitude2Error end subroutine

DESCRIPTION
This routines performs two operation:
1. Calculates the color index from two input magnitudes in the standard system
2. Transforms the second input magnitude value from the instrumental into the standard system.
ARGUMENTS

In:

filter1, filter2

filters associated with given input magnitudes magnitude1 and magnitude2. filter1 must be at shorter wavelength than filter2 otherwise an error condition is raised. Only certain filter combinations are supported (see the Calibration Access and Data Handbook)

magnitude1, magnitude2

zero-point corrected magnitudes derived from the deadtime corrected count rate measured in the passband filter1/filter2 respectively. The first magnitude is transformed into the standard system. The second magnitude is used to determine the color correction term.

Out:

stdColor12

color derived from the input magnitudes magnitude1/magnitud2 transformed into the standard system

stdMagnitude2

input magnitude2 corrected to its standard system.

stdColor12Error, stdMagnitude2Error

uncertainties associated with calculated quantities stdColor12, magnitude2 respectively (optional arguments)

USED STATE VARIABLES

none

CCF ACCESS

ColTrans
CAL_omGetApertureRadius -- obtain aperture radius

SYNOPSIS

function CAL_omGetApertureRadius() result(radius) use CalTypes real(kind=double) :: radius end function

DESCRIPTION

Inquire aperture radius used in the photometric calibration of the specified filter.

RETURNS

Aperture radius in units of centroided pixels

USED STATE VARIABLES

none

CCF ACCESS

ColorTrans, PhotToNat
CAL_omGetFluxConvFactors -- obtain flux conversion factors and related zero points

SYNOPSIS

function CAL_omGetFluxConvFactors() result(fcf) use CalTypes type(OmFluxConvF) :: fcf end function

DESCRIPTION

Returns factors to allow count rates to be converted into fluxes using a number of conversion systems. The values are returned in a structure which may be accessed by:
fcf%cfwd - count rate to flux conversion factor based on white dwarves
fcf%cfab - count rate to flux conversion factor based on the AB system
fcf%cfvega - count rate to flux conversion factor based on the spectrum of Vega
fcf%zpab - zero point for the AB system

RETURNS

Structure of type OmFluxConvF (see caltypes.f90 for the definition of this type) containing fields that signify the zero point and flux conversion factor in the AB system and the count rate to flux conversion factor of two systems based on the spectra of a set of White Dwarves and Vega respectively (see Calibration Access and Data Handbook for details)

USED STATE VARIABLES

none

CCF ACCESS

ColorTrans
CAL_omGetFrameParameters -- obtain CCD frame readout parameters

SYNOPSIS

subroutine CAL_omGetFrameParameters(frameParameters) use CalTypes type(OMframeParameters) :: frameParameters end subroutine

DESCRIPTION

Routine to obtain the OM frame parameters from the CCF. These are needed to compute CCD frame times from priority window data.

ARGUMENTS

Out:

modeParameters

structure with various characteristic readout parameters; see caltypes.f90 for the definition of this type

USED STATE VARIABLES

none

CCF ACCESS

PhotToNat
CAL_omGetPlateScale -- inquire current intrinsic OM platescale

SYNOPSIS

subroutine CAL_omGetPlateScale(lambda, plateScale, errorX, errorY) use types real(kind=double), intent(in) :: lambda real(kind=double), intent(out) :: plateScale real(kind=double), intent(out), optional :: errorX, errorY end subroutine

DESCRIPTION

Routine to inquire the intrinsic OM plate scale. This describes the extent of a (square) pixels in units of arcsec/pixel for a given filter at the specified nominal wavelength and the OM reference focal plane position (centre of FOV).

ARGUMENTS

In:

lambda

Nominal wavelength for which platescale is inquired.

Out:

plateScale

Intrinsic plate scale corresponding to the currently used filter in units of arcsec/pixel.

errorX

/errorYuncertainties of returned platescale in X- and Y direction (units: arcsec/pixel)

USED STATE VARIABLES

filterId

CCF ACCESS

AstroMet
CAL_omGetPSF -- obtain handle to Point-Spread-Function

SYNOPSIS

function CAL_omGetPSF(cenX, cenY, countFrameRateRatio) result(psf) use CalTypes real(kind=double), intent(in) :: cenX, cenY, & countFrameRateRatio type(OmPsfT) :: psf end function

DESCRIPTION

Returns a handle to an object which represents the OM point-spread-function characterized by a given CHIPCOORD position and count-rate frame-rate ration.

ARGUMENTS

In:

cenX, cenY

PSF centroid in the CHIPCOORD frame

countRateFrameRation

count-/frame rate ration in units of counts/pixel/frame

RETURNS

Handle to OM PSF data object to be passed to subsequent PSF-related routines, e.g. CAL_omPsfEncircledEnergy

USED STATE VARIABLES

instrument

CCF ACCESS

PSF1DRBXPSF
CAL_omPsfEncircledEnergy -- compute encircled energy fraction

SYNOPSIS

function CAL_omPsfEncircledEnergy(psf, radius) result(fraction) use CalTypes type(OmPsfT) :: psf real(kind=double), intent(in) :: radius real(kind=double) :: fraction end function

DESCRIPTION

Compute fraction of the energy that is contained in a circle of a given radius centered on the PSF centroid.

ARGUMENTS

In:

psf

Handle to OM PSF to use (returned by CAL_omGetPSF)

radius

Circle radius in centroided pixels.

RETURNS

Fraction of energy that is contained in circle radius in interval .
CAL_omPsfCircleRadius -- compute circle containing given PSF fraction

SYNOPSIS

function CAL_omPsfCircleRadius(psf, fraction) result(radius) use CalTypes type(OmPsfT) :: psf real(kind=double), intent(in) :: fraction real(kind=double) :: radius end function

DESCRIPTION

Compute the radius of a circle centered on the PSF barycenter that contains a given fraction of the total photonic energy.

ARGUMENTS

In:

psf

Handle to OM PSF to use (returned by CAL_omGetPSF)

fraction

A number in the interval signifying the fraction of the total photonic energy contained in the circle whose radius is to be determined.

RETURNS

Radius of the circle in centroided pixels that contains the given fraction of the total energy.
CAL_omGetPSFmap -- map representation of OM PSF

SYNOPSIS

subroutine CAL_omGetPSFmap(rawX, rawY, & nPixelsNegX, nPixelsPosX, & nPixelsNegY, nPixelsPosY, & xRes, yRes, & countFrameRateRatio, & PSFmap) use CalTypes real(kind=double), intent(in) :: rawX, rawY, & countFrameRateRatio integer(kind=int32), intent(in) :: nPixelsNegX, & nPixelsPosX, & nPixelsNegY, & nPixelsPosY, & xRes, yRes

real(kind=single), dimension(:,:), pointer & :: PSFmap end subroutine

DESCRIPTION

This routine is the OM-specific counterpart of CAL_psfImage for the X-ray instruments. It returns a map representation of the OM point-spread-function sampled on an equidistant, rectangular spatial grid around a specified point in the focal plane.

ARGUMENTS

In:

rawX, rawY

position in the focal plane in the PIXCOORD1 reference system - determines the nominal ray incidence position, i.e., the position of the PSF centroid (e.g. source position in the FOV). Please note that the arguments are real, thus, the position can be specified to an accuracy of a fraction of a centroided pixel.

nPixelsNegX, nPixelsPosX, nPixelsNegY, nPixelsPosY

these four arguments determine the size of the rectangular region on the detector chip (in centroided pixels) inside which the PSF is to be sampled; the lower left and upper right corner of the rectangle are: (rawX - nPixelsNegX / rawY - nPixelsNegY) (rawX + nPixelsPosX / rawY + nPixelsPosY), i.e., the size of the sample region in centroided pixels is: (nPixelsNegX + nPixelsPosX + 1) $\times$ (nPixelsNegY + nPixelsPosY + 1).

xRes, yRes

these two arguments (must be ) determine the resolution of the requested PSF map in units of PSF bins per centroided pixel in the X- and Y direction, e.g. xRes=yRes=2 requests a PSF bin size of 2 per centroided pixel and consequently, the returned PSF map will have the size (nPixelsNegX + nPixelsPosX + 1) $\cdot$ xRes $\times$ (nPixelsNegY + nPixelsPosY + 1) $\cdot$ yRes.

countFrameRateRatio

the count- frame rate ratio of the source region; unit is counts/pixel/frame

Out:

PSFmap

two-dimensional array containing the selected part of the PSF (total is normalized to one) at the requested points - the array element PSFmap(INT((nPixelsNegX+rawX-INT(rawX))*xRes), INT((nPixelsNegY+rawY-INT(rawY))*yRes)) corresponds to the PSF centroid.

USED STATE VARIABLES

filterId

CCF ACCESS

PSF1DRB
CAL_omLargeSenseVariation -- large scale sensitivity variations

SYNOPSIS

subroutine CAL_omLargeSenseVariation(x0, y0, xSize, ySize, lambda, & senseMap, & averageFlatField, & averageFlatFieldError, & pixelError) use types integer(kind=int32), intent(in) :: x0, y0, xSize, ySize real(kind=double), intent(in) :: lambda real(kind=single), dimension(:,:), pointer :: senseMap real(kind=double), intent(out), optional :: averageFlatField, & averageFlatFieldError,& pixelError end subroutine

DESCRIPTION

Routine for obtaining a flatfield image which describes the large-scale sensitivity variations due to filter defects, contaminations, etc. The returned image is at maximum detector resolution, i.e., in centroided pixel space.

ARGUMENTS

In:

x0, y0

CCD pixel coordinates of lower left corner of requested image in the PIXCOORD1 reference frame

xSize, ySize

extent of requested image in X and Y pixels

lambda

nominal wavelength in nm (currently ignored)

Out:

senseMap

two-dimensional sensitivity map; values denote deviations from average throughput; the normalization is such that the value of a smooth 2-dimensional fit function through the sample points of the flatfield in the CCF is 1 at the centre of the OM FOV. The returned image is at maximum detector resolution (centroided pixel space).

averageFlatField

, averageFlatFieldErrorflatfield value averaged over all good detector pixels and its associated uncertainty

pixelError

uncertainty of a single pixel value in units of percent

USED STATE VARIABLES

filterId

CCF ACCESS

LrgScaleSens
CAL_omLEDtemplateMap -- retrieve LED illumination map

SYNOPSIS

subroutine CAL_omLEDtemplateMap(x0, y0, xSize, ySize, map, & averageIlluCorr, & averageIlluCorrError, & pixelError) use types integer(kind=int32), intent(in) :: x0, y0, xSize, & ySize real(kind=single), dimension(:,:), pointer :: map real(kind=double), intent(out), optional :: averageIlluCorr, & averageIlluCorrError, & pixelError end subroutine

DESCRIPTION

Function for obtaining the LED illumination template as a two-dimensional map.

ARGUMENTS

In:

x0, y0

CCD pixel coordinates of lower left corner of requested image in the PIXCOORD1 reference frame

xSize, ySize

extent of requested image in X and Y pixels

Out:

map

two-dimensional map; the returned image is at maximum detector resolution (centroided pixel space)

averageIlluCorr, averageIlluCorrError

average correction for non-flat illumination and its associated uncertainty

pixelError

average single pixel deviation in units of percent

USED STATE VARIABLES

none ccfPixToPixSens
CAL_omPhotoMagnitude -- convert count rates to magnitudes

SYNOPSIS

subroutine CAL_omPhotoMagnitude(naturalRate, magnitude, & naturalRateErrorMinus, & naturalRateErrorPlus, & magnitudeErrorMinus, & magnitiudeErrorPlus) use types real(kind=double), intent(in) :: naturalRate real(kind=double), intent(out) :: magnitude real(kind=double), intent(in), optional :: naturalRateErrorMinus, & naturalRateErrorPlus real(kind=double), intent(out), optional:: magnitudeErrorMinus, & magnitiudeErrorPlus end subroutine

function CAL_omNaturalMagnitude(naturalRate, & naturalRateErrorMinus, & naturalRateErrorPlus, & magnitudeErrorMinus, & magnitiudeErrorPlus) result(result) use types real(kind=double), intent(in) :: naturalRate real(kind=double), intent(in), optional :: naturalRateErrorMinus, & naturalRateErrorPlus real(kind=double), intent(out), optional:: magnitudeErrorMinus, & magnitiudeErrorPlus real(kind=double) :: result end function

DESCRIPTION

Routine to convert a brightness value expressed in corrected count rates (as output from routine CAL_omPhotoNatural) into magnitude values in the natural system using the definition of the zero point in the CCF color transformation table.

ARGUMENTS

In:

naturalRate

A corrected count rate in the natural system as output by routine CAL_omPhotoNatural

naturalRateErrorMinus, naturalRateErrorPlus

absolute asymmetric errors (plus/minus) associated with naturalRate (optional arguments)

Out:

magnitude

a magnitude value in the natural system corresponding to input count rate

magnitudeErrorMinus, magnitudeErrorPlus

absolute asymmetric errors (plus/minus) associated with magnitude (optional arguments)

USED STATE VARIABLES

filterId

CCF ACCESS

ColTrans
CAL_omPhotoNatural -- correct raw count rate

SYNOPSIS

function CAL_omPhotoNatural(rawRate, frameTime, & deadFrac, eventLoss, & extendedSource, & empiricalLinearityCorrection) & result(naturalRate) use CalTypes type(ValueAsymmetricErrorT) :: rawRate real(kind=double), intent(in) :: frameTime, & deadFrac, & eventLoss logical, intent(in), optional :: extendedSource, & empiricalLinearityCorrection type(ValueAsymmetricErrorT) :: naturalRate end function

DESCRIPTION

Routine to convert a raw input count rate from the instrumental into the natural system which includes corrections due to instrumental effects (CCD deadtime, non-linearity, detector aging, etc.)

ARGUMENTS

In:

rawRate

uncorrected OM count rate to correct; units are: counts/aperture/sec

frameTime

CCD frame time in units of ms

deadFrac

deadtime caused by frame transfer expressed as fraction of CCD frame time

eventLoss

fraction of events below detection threshold in the most recent PHD (optional argument)

extendedSource

boolean switch determining whether the celestial source is extended or not; in the former case the coincidence loss correction is not applied; default value is false

empiricalLinearityCorrection

boolean flag to switch on an empirical linearity correction in addition to the theoretical; see Calibration Access and Data Handbook for details.

RETURNS

Structure of type ValueAsymmetricErrorT (see caltypes.f90 for the definition of this type) containing fields that signify the corrected count rate plus associated uncertainties.

USED STATE VARIABLES

filterId

CCF ACCESS

PhotToNat
CAL_omPixelSenseVariation -- pixel-to-pixel sensitivity variations

SYNOPSIS

subroutine CAL_omPixelSenseVariation(x0, y0, xSize, ySize, & countRateFrameRatio, senseMap, & averageFlatField, & averageFlatFieldError, & pixelError) use types integer(kind=int32), intent(in) :: x0, y0, xSize, & ySize real(kind=double), intent(in) :: countRateFrameRatio real(kind=single), dimension(:,:), pointer :: senseMap real(kind=double), intent(out), optional :: averageFlatField, & averageFlatFieldError,& pixelError end subroutine

DESCRIPTION

Function for obtaining a flatfield image describing the pixel-to-pixel sensitivity variations caused by the detector. The returned image is at maximum detector resolution, i.e., in centroided pixel space.

ARGUMENTS

In:

x0, y0

CCD pixel coordinates of lower left corner of requested image in the PIXCOORD1 reference frame

xSize, ySize

extent of requested image in X and Y pixels

countRateFrameRatio

count-/frame rate ration in units of counts/pixel/frame; currently ignored

Out:

senseMap

two-dimensional sensitivity map; values denote deviations from average throughput; the returned image is at maximum detector resolution (centroided pixel space)

averageFlatField, averageFlatFieldError

flatfield value averaged over all good detector pixels and its associated uncertainty

pixelError

uncertainty of a single pixel value in units of percent

USED STATE VARIABLES

filterId

CCF ACCESS

PixToPixSens
CAL_omGetGrismFlux -- flux data from OM Grism

SYNOPSIS

subroutine CAL_omGetGrismFlux(lamda, isf, isfError) use CalTypes real(kind=double), dimension(:), pointer :: lamda, isf, isfError end subroutine

DESCRIPTION

This routine extracts the inverse sensitivty function (ISF) for the OM grisms. It returns arrays of wavelength, ISF and ISF error.

ARGUMENTS

Out:

lamda

one-dimensional array containing the wavelengths over which the ISF is defined.

isf

one-dimensional array containing the inverse sensitivity function.

isfError

one-dimensional array containing the error on the ISF.

USED STATE VARIABLES

filterId

CCF ACCESS

GrismCal
CAL_omGetGrismWavelength -- wavelengthdata from OM Grism

SYNOPSIS

subroutine CAL_omGetGrismWavelength(lamda) use CalTypes real(kind=double), dimension(:), pointer :: lamda end subroutine

DESCRIPTION

This routine extracts the wavelength array for the OM grisms.

ARGUMENTS

Out:

lamda

one-dimensional array containing the wavelengths for the grism.

USED STATE VARIABLES

filterId

CCF ACCESS

GrismCal

XMM-Newton SOC/SSC -- 2007-03-08