Calibration Access and Data Handbook

Description

This CCF contains the following five extensions: ADUCOEFF, OFFSET_GAIN, GAIN-HIGH, REEMISSION and REEMISSION1.

Keywords to describe the contents of the CCF:

BPT_CODE:

Code of the bad pixel table (BPT) version, which includes the additional column offset values, described in the OFFSET_GAIN extension. Owing to changes in the uploaded BPT and periods of operational changes, the number and value of additional column offsets has altered frequently from observation to observation. These changes are reflected in the corresponding CCFs. In view of the resulting large number of issues, a procedure has been implemented in the SAS to check whether the correct CCF is used for a given observation. This is done by correlating the uploaded BPT version, which is uniquely coded through the pn HK parameters F1629, F1630 and F1628, with the associated CCF header keyword BPT_CODE. A warning is issued if the two do not tally. The coding of the BPT version has been implemented since revolution 293 and the corresponding BPT_CODE keyword will be present in EPN_ADUCONV CCF issues as of 0108.

The CCF contains the following tables:

ADUCOEFF:

Obsolete.

Attributes:

None.

Columns:

CCD_ID:

CCD index number (1-12).

NODE_ID:

Node (0 for pn).

OFFSET:

One global offset value per CCD.

GAIN:

One global gain value per CCD.

OFFSET_GAIN:

Accessed by:

• CAL_offsetCorrect(): There are two versions of this table with ALGOID=0 (or missing ALGOID) and ALGOID=1:

  ALGOID=0: $eOut = eIn - OFFSET[\_node]$

  ALGOID=1: $eOut = eIn - (OFFSET\_CONST[\_node] + deltaT * OFFSET\_SLOPE[\_node])$

  $deltaT = \_observationStartTime - REFTIME$
• CAL_gainCorrect(): [on _accuracyLevel == LOW]

  $eOut = eIn / GAIN[\_node]$

• CAL_piToeV():

  $eOut = KEV0 + \\ eIn * KEV\_P\_PI$

Attributes:

REFTIME:

Reference time for ALGOID=1 offset correction; format
yyyy-mm-ddThh:mm:ss.

KEV0:

Constant in linear PI to keV conversion.

KEV_P_PI:

Slope of linear PI to keV conversion.

Columns:

CCD_ID:

CCD index number (1-12).

GAIN:

Vector column of length 64; one gain value per node per chip.

OFFSET:

Vector column of length 64; one offset value per node per chip.

OFFSET_CONST:

Vector column of length 64; constant in linear offset value calculation (only present for ALGOID=1).

OFFSET_SLOPE:

Vector column of length 64; slope in linear offset value calculation (only present for ALGOID=1).

GAIN_HIGH:

Accessed by CAL_pnGainCorrect(), implements I/F to the detailed pn gain model code in the calpnalgo package.

Attributes:

FINEPAR1, FINEPAR2 and FINEPAR3: three constant coefficients needed in the gain model.

Columns:

GAIN_PAR:

Vector column of length $768 = 12 * 64$; 10 rows with various parameters of the gain model code in calpnalgo. The correspondence between row numbers and code variables is: row 1-4: $pp0/pp1/pp2/pp3$; row 7: $aa$; row 9: $bb$; the rest are dummy values.

REEMISSION:

Accessed by CAL_pnReEmissionThreshold().
$thresh = A[0] + A[1] * EkeV + (B[0] + B[1] * EkeV) * (rawY-RAWY0)$ $EkeV = 1000*Eadu*ADU\_P\_EV$, where $Eadu$ and $rawY$ are inputs to the routine.

Attributes:

ADU_P_EV:

ADU units per eV.

RAWY0:

Reference Y position.

Columns:

A:

Vector of length 2; re-emission parameter.

B:

Vector of length 2; re-emission parameter.

REEMISSION1:

Obsolete. Was initially implemented as a more complex form of the re-emission threshold; the code is no longer in the CAL.

Attributes:

None.

Columns:

C_K:

Parameter for old re-emission model; obsolete.

D_K:

Parameter for old re-emission model; obsolete.

E_K:

Parameter for old re-emission model; obsolete.

F_K:

Parameter for old re-emission model; obsolete.