Calibration Access and Data Handbook

Description

The pn CTI CCF holds all information to perform the correction for charge transfer loss for every detected event. The corrections depend on the specific readout of the CCDs for each observation mode.

The CCF contains the following tables:

CTI

The table is not used by the CAL; probably only by QLA but probably neither because the values appear all dummy at present

Attributes:

None.

Columns:

CCD_ID:

CCD number

CTI_X:

single scalar fractional charge loss in serial direction

CTI_Y:

single scalar fractional charge loss in parallel direction

CTI_EXTENDED

The table is used/accessed by: CAL_ctiCorrect() Generic CTI correction algorithm: $eOut = {\frac {eIn} {{1}-{CTI\_X}^{RAWX} (1-CTI\_Y)^{RAWY} }}$

Attributes:

None.

Columns:

MODE_ID:

numeric ID of the mode.

CCD_ID:

CCD number [1, 12]

NODE_ID:

ID of the readout node;. in the case of EPN this is identical to RAWX-1

CTI_FRAME_TRANSFER:

the column is not used by the CAL; can be dropped in future version without consequences

D_CTI_FRAME_TRANDFER:

absolute error of CTI_FRAME_TRANSFER values; column not used by the CAL; can be dropped in future version

CTI_X:

fractional charge loss in RAWX direction; makes no sense for EPN but needs to be kept for commonality with EMOS

D_SERIAL_CTI:

absolute error of CTI_X values; column not used by the CAL; can be dropped in future versions

CTI_Y:

fractional charge loss per transfer in RAWY direction

D_CTI_PARALLEL:

absolute error of CTI_Y values; column not used by the CAL; can be dropped in future versions

HOT_PIXELS

The table is used/accessed by: CAL_pnCtiCorrect() [only up to including cal-3.117 (SAS-5.2)] Table containing the list of hot pixels (not-uplinked bad pixels of type 'H') to be passed to the high-accuracy CTI correction algorithm in calpnalgo. As of cal-3.118 this information is read from EPN_BADPIX:BADPIX - table is thus obsolete and can be dropped in future versions of this CCF

Attributes:

None.

Columns:

QUAD_ID:

hardware quadrant ID [0, 3]

CCD_ID:

hardware CCD number [0, 2]

RAWX:

PIXCOORD0 X-coordinate [0, 63]

RAWY:

PIXCOORD0 Y-coordinate [0, 199]

YLENGTH:

same as EPN_BADPIX:BADPIX:YLENGTH

N_SAT_IMP:

same as EPN_BADPIX:BADPIX:N_SAT_IMP

DISCARDED_PIXELS

The table is used/accessed by: CAL_pnCtiCorrect() [only up to including cal-3.117 (SAS-5.2)] Table containing the list of discarded pixels (uplinked hot pixels (type 'h') which are not telemetered by the event analyzer logic, i.e. appear as logically dead) to be passed to the high-accuracy CTI correction algorithm in calpnalgo. As of cal-3.118 this information is read from EPN_BADPIX:BADPIX - table is thus obsolete and can be dropped in future versions of this CCF

Attributes:

None.

Columns:

QUAD_ID:

hardware quadrant ID [0, 3]

CCD_ID:

hardware CCD number [0, 2]

RAWX:

PIXCOORD0 X-coordinate [0, 63]

RAWY:

PIXCOORD0 Y-coordinate [0, 199]

QUAD_ID:

hardware quadrant number [0, 3]

CCD_ID:

hardware CCD number [0, 2]

CTI-HIGH

The table is used/accessed by: CAL_pnCtiCorrect() Main table to drive the high-accuracy EPN CTI correction algorithm in calpnalgo; Contains four sets of parameters per CCD column; numbers come from hardware group at MPE

Attributes:

EPERADU:

number of released electron per ADU value (needed by calpnalgo)

KEVPER_E:

energy in keV per released electron (needed by calpnalgo)

Columns:

CTI_PAR:

vector column of length 768=12*64 with CTI model parameter; there are four rows corresponding to four main parameter sets

CTI-HIGH_ADD_PAR

The table is used/accessed by: CAL_pnCtiCorrect() Table containing additional parameter needed by the CTI correction in calpnalgo

Attributes:

None.

Columns:

Y_SHIFT:

shift in Y-direction (vector column of length 6 corresponding to modes)

SCALE:

scale factor for CTI correction (only != 1 for TI mode)

MODE_FACTOR:

mode-dependent factor used in CTI correction (vector column length 6)

EFF_PAR:

four parameter values controlling CTI correction in eFF mode

LWSW_PAR:

16 parameter values controlling CTI correction in LW/SW mode

LW_PAR:

16 parameter values controlling CTI correction in LW mode only (to be used in preference to the LWSW_PAR values).

SW_PAR:

16 parameter values controlling CTI correction in SW mode only (to be used in preference to the LWSW_PAR values).

CCD_OFSETS

The table is used/accessed by: CAL_pnAdditionalGainCtiCorrect() Holds single scalar offset values used by EPN gain correction in calpnalgo

Attributes:

None.

Columns:

CCD_OFFSETS:

scalar offset values - one row per CCD

TEMP_CTI

The table is used/accessed by: CAL_pnAdditionalGainCtiCorrect() Parameter controlling temperature-dependent stage of overall gain correction; correction is linear in T: tgain = OFFSET + T*SLOPE

Attributes:

ADU_REF:

Mn K-alpha reference energy in ADU for T-dependent gain correction

Columns:

OFFSET:

offset of linear T-gain correction

SLOPE:

slope of linear T-gain correction

ORSAY_GAIN

The table is used/accessed by: CAL_pnAdditionalGainCtiCorrect() Parameters controlling Orsay gain scaling stage of overall gain correction

Attributes:

None.

Columns:

ORSAY_GAIN:

scalar gain scaling values; one row per CCD

LONG_TERM_CTI

The table is used/accessed by: CAL_pnAdditionalGainCtiCorrect() Parameter controlling long-term CTE degradation correction which is modeled as a gain scaling in calpnalgo

Attributes:

ALGOID:

algorithm identifier.

Columns:

MODE_ID:

numeric ID of the mode.

CCD_ID:

CCD number [1, 12].

T_COEFF:

time dependence of long term CTI; four-element vector column.

E_COEFF:

energy dependence of long term CTI; three-element vector column.

SHIFT:

shift parameter.

TIMING_GAIN

The table is used/accessed by: CAL_pnGainTimingCorrect Table with parameters controlling fine-adjustment of the gain in TI mode

Attributes:

None.

Columns:

TIMING_GAIN:

scalar columns with four parameters (one per row)

BURST_GAIN

The table is used/accessed by: CAL_pnGainBurstCorrect Table with parameters controlling fine-adjustment of the gain in BU mode

Attributes:

None.

Columns:

BURST_GAIN:

scalar columns with four parameters (one per row)

EFF_GAIN

The table is used/accessed by: TBD. Table with the parameters of the gain tuning function which is used to adjust the EFF gain to that of FF.

Attributes:

ALGOID:

algorithm identifier.

Columns:

CCD_ID:

CCD number [1, 12].

EFF_GAIN:

fine tuning of the Gain/CTI in EFF Mode; four-element vector column.

QBOXTEMP_GAIN

The table is used/accessed by: TBD Table with parameters for the correction of the peak gain depending on the quadrant box temperatures.

Attributes:

ADU_REF:

Mn K-alpha reference channel (ADU) for temperature dependent gain correction.

Columns:

MODE_ID:

numeric ID of the mode.

CCD_ID:

CCD number [1, 12].

SLOPE:

temperature dependence of the gain correction.

C_REF:

correction factor to adjust peak position.

RATE_DEPENDENT_CTI

The table is used/accessed by: CAL_pnAdditionalGainCtiCorrect(). The parameters control the rate-dependent CTI correction in pn Fast Modes.

Attributes:

None.

Columns:

MODE_ID:

Numeric ID of the mode.

A_i:

coefficients of the rate-dependent gain correction: $A_0 \times X^{A_1} + A_2$, where X is the number of shifted electrons per pixel per second.