titles_tcal


                              Titles:  TCAL
                              =============
 
    Contact:  R. Van de Water, Penn
 
    Revision History:-
    ================
 
    2.07  R. Van de Water,     First version.
    3.01  N. West              Add _BAD_CCC_PMT.
    3.02  D. Wark              Add _TIME_OFFSET.
          M. Thorman           Add _REV_TIME.
          S. Biller            Add _ECA_VERSION.
          J. Cameron           Add _WALK_TYPE and _GAIN_TYPE constants.
          N. West              Correct Titles File link.  Add _REF_CONSTS.
                               Remove fail_eca symbolic command.
    4.01  J. Cameron           Update mode_flag settings
    4.02  G. McGregor          Add HCA control words.
          R. Van de Water      Add ECA and ADC validation switches.
          J. Cameron           Add PCA validation switch.
          J. Cameron           Modify _walk_type and _gain_type
          M. Dunford           Add cross talk cut words.
    5.00  C. Kyba              Add MPCA word.
                               Add combined charge mode
    5.01  C. Kyba              Add improved version of PCA gain
          A. Anthony           Add QRC unpacking and correction
          N. McCauley          Add LRBP type.
          J. Klein             Add _EFF_MODE


 
Titles Files
------------
 
calibration.dat
 
 
Verification
------------
 
 
Description
-----------
 
    This bank contains input data to control event calibration.
 
 
Data Words
----------
 
        Fixed length Database Header.  See titles_dbhdr.html
 
        Data types: B(bit), I, F, D(double), H(hollerith 4 char)
 
   1  I _CAL_OPT     0= simple/same cal. const for all tubes (see 
                        cal_const0.dat)  NO LONGER AVAILABLE.
                     1= full/different cal. constants for each tube (see
                        cal_const1.dat)  **NOW FORCED**
 
   2  I  Walk Flag   0= T vs Q Walk NOT included in MC event
                     1= T vs Q Walk IS included in MC event

   3  I _BAD_CCC_PMT PMT number used if CCC has no associated PMT.

   4  I _MODE_FLAG   [calibration_mode] This is the calibration mode and should be set to the
                     sum of the charge mode and the time mode. The choices are:
 
                     Charge: 10 -counts above pedestal (see charge zero flag)
                             20 -ECA linear correction
                             30 -ECA quadratic correction - old ECA,
                                    (same as 2 new ECA)
                             40 -PCA charge ( uses ECA counts above pedestal
                                    see charge zero flag)
                             50 -Improved PCA charge with MB channel dependance
                                            ( uses ECA counts above pedestal
                                    see charge zero flag)

                    Time:   1  -counts above pedestal (see time zero flag)
                             2  -ECA time linear correction - old ECA
                                    (same as 3 new ECA)
                             3  -ECA time ( new ECA -linear interp or cubic,
                                    old ECA -cubic )
                             4  -PCA walk corrected time

                     For example if you want charge in counts above pedestal
                     and time in PCA ns then set the mode to 14.

   5  I _CHARGE_ZERO Pedestals or intercepts for charge zero?
                     (0 = pedestals, 1 = intercepts)

   6  I _TIME_ZERO   Pedestals or intercepts for time zero?
                     (0 = pedestals, 1 = intercepts)

   7  F _TIME_OFFSET Time offset of the calibrated data.

   8  I _REV_TIME    Time Reversal Flag (for calibrating packed 
                                                    MC data)
                     (0 = off, 1 = on)   See Note 1.

   9  I _ECA_VERSION [old_eca, newer_eca] Type of ECA calibration constants to use:
                     1=old ECA, 2=new ECA (linear interp TSlope),
                     3=new ECA (cubic TSlope)

  10  I _WALK_TYPE   [pca_walk_type, queens_pca]   0 = New PCA walk version 1 and gain version 1
                     Type of PCA WALK calibration constants to use:
                        1  exponential fit
                        3  inverse poly fit
                        4  old PCA times and charges
                     New PCA:
                       10  New PCA & walk version 1
                       11  New PCA & walk version 2

  11  I _GAIN_TYPE   [pca_gain_type] Type of PCA GAIN calibration constants to use:
                        1  old gain fit
                        3  gain from counts above pedastel
                     New PCA:
                       10  New PCA & gain version 1

  12  I _REF_CONSTS  [use_ref_cal_consts] Use reference (non-optimal) 
                     calibration constants.
                     SET THIS SWITCH ONLY FOR TESTING --- NEVER FOR ANALYSIS.
                        0 no, 1 yes

  13  I _HCA_TYPE    [apply_hca] Type of HCA calibration to use:
                        0 none
			1 new correction
			2 Queen's correction
  
  14  I _HCA_FAIL    [hca_return_fails] Behaviour if HCA information is undefined (fail)
                        0 return uncorrected time (sync to ECA rate)
			1 return undefined time

  15  I _VAL_TYPE    [eca_val_flag] ECA Validation flag -- applicable if ECA type.ge.4
                     0= generate ECA validation status word in PMT bank
                     1= same as 0, plus, set cell Q/T to -9999 for 
                        pathologically bad ECA channels (see ECA document 
                        for details).
                     2= same as 0, plus, set cell Q/T to -9999 if failed cell
                        validation (E.G. If only Qlx and TAC failed cell 
                        validation, they are set to  -9999, while Qhs and Qhl 
                        are left unaffected).
                     3= same as 2, plus, if cell (Qhs.or.TAC) failed 
                        validation, set cell TAC= -9999 
                     4= same as 2, plus, if failed channel Q/T validation, set
                        all cell Q and T= -9999

  16 I _BADC_TYPE    [bad_adc_flag] Bad ADC (Wittich jumps) flag -- applicable if ECA type.ge.4
                     0= generate bad ADC status word in PMT bank
                     1= if ADC failed CALDAC, then set corresponding Q/T to 
                        -9999
                     2= if ADC failed Frati jump test, set corresponding TAC to
                         -9999

  17 I _PCA_VAL      [pca_val_flag] PCA Validation flag -- applicable if word 10 = 0
                     0= Generate PCA validation status word in PMT bank.
                     1= Same as 0, plus set Q/T to -9999 if card fails DQID check.

  18 I _XTALK_CUT    [apply_xtalk_cut] Flag for cutting cross talk from data
                     0= No cross talk cut is applied
                     1= cross talk is cut from the data by setting the discard
                        bit in KPMT_PF

                     Next five bits are the cut parameters for the cross talk 
                     cut

  19 F _XT_HIGH_CHARGE  Minimum charge for high charge tube

  20 F _XT_CHARGE_HIGH  Upper charge cut parameter for cross talk tube

  21 F _XT_CHARGE_LOW   Lower charge cut parameter for cross talk tube

  22 F _XT_TIME_HIGH    Upper cut parameter for time difference between
                        primary tube - adjacent (cross talk) tube
                        ECA times are used here

  23 F _XT_TIME_LOW     Lower cut parameter for time difference between
                        primary tube - adjacent (cross talk) tube
                        ECA times are used here

  24 F _MPCA_CHARGE     Charge at which Multiphoton PCA is used instead of 
                        regular PCA.  Set to zero to disable MPCA.
                        BEWARE: To use the MPCA you MUST be using the gain
                        calibration.  Symbolic command via $set_mpca_threshold

  25 I _BEST_Q_MODE     Switch to control which version of the combined
                        charge code you run.  Current modes available:
                          (0) off
                          (1) on
                        Symbolic command available via $combined_q_mode

  26 I _QRC_MODE        Flag for unpacking QRC information from xzdab
                        0= Ignore QRC information
                        1= Unpack QRC information

  27 I _QRC_QHS         Flag for applying QRC Correction to QHS.  Note:
                        For any _QRC_Qxx flag to apply correction, QRC_MODE
                        must be set to 1, otherwise no correction available.
                        0= Correction not applied to QHS
                        1= Correction applied to QHS

  28 I _QRC_QHL         Flag for applying QRC Correction to QHL
                        0= Correction not applied to QHL
                        1= Correction applied to QHL 

  29 I _QRC_QLX         Flag for applying QRC Correction to QLX
                        0= Correction not applied to QLX
                        1= Correction applied to QLX

  30 I _LRBP_TYPE       Flag to control LRBP type.
                        =1 Use original LRBPs. Best known laser position.
                        =2 Use updated LRBPs. Unified laser positions.

  31 I _EFF_MODE        Switch for calculation of channel efficiencies.
                        =0 No calculation
                        =1 Calculation

10*0 I            Spare.


Notes
-----

1)  Due to an inconsistency between the uncalibration process before version
    3.0182 and the full ECA calibration, the times from MC data which have
    been packed in ZDAB can become reversed after calibration. If the ZDAB
    was packed with at least the $zdab_min_mc option, then the calibrator
    will be able to recognize old data and can correct the reversed times
    automatically. The time reversal switch is provided for cases where this
    is not possible. It only has an effect on packed MC data.


Go Back to the Snoman Companion Top Page