Belle II Software development
caf_klm_time.py
1
8
9"""
10Calibration of KLM time. It provides calibration constants for the KLMTimeCableDelay
11and KLMTimeConstants database objects.
12"""
13
14import basf2
15from prompt import CalibrationSettings, INPUT_DATA_FILTERS
16
17
24
25
26settings = CalibrationSettings(name='KLM time',
27 expert_username='amubarak',
28 subsystem='klm',
29 description=__doc__,
30 input_data_formats=['cdst'],
31 input_data_names=['hlt_mumu'],
32 input_data_filters={
33 'hlt_mumu': [INPUT_DATA_FILTERS['Run Type']['physics'],
34 INPUT_DATA_FILTERS['Data Tag']['mumu_tight_or_highm_calib'],
35 INPUT_DATA_FILTERS['Data Quality Tag']['Good Or Recoverable']]
36 },
37 depends_on=[],
38 produced_payloads=["KLMTimeConstants", "KLMTimeCableDelay", "KLMTimeResolution"])
39
40
41
50
51
52def get_calibrations(input_data, **kwargs):
53 """
54 Parameters:
55 input_data (dict): Should contain every name from the 'input_data_names' variable as a key.
56 Each value is a dictionary with {"/path/to/file_e1_r5.root": IoV(1,5,1,5), ...}. Useful for
57 assigning to calibration.files_to_iov
58
59 **kwargs: Configuration options to be sent in. Since this may change we use kwargs as a way to help prevent
60 backwards compatibility problems. But you could use the correct arguments in b2caf-prompt-run for this
61 release explicitly if you want to.
62
63 Currently only kwargs["requested_iov"] is used. This is the output IoV range that your payloads should
64 correspond to. Generally your highest ExpRun payload should be open ended e.g. IoV(3,4,-1,-1)
65
66 Returns:
67 list(caf.framework.Calibration): All of the calibration objects we want to assign to the CAF process
68 """
69 # Set up config options
70
71 # In this script we want to use one sources of input data.
72 # Get the input files from the input_data variable
73 file_to_iov_cdst = input_data['hlt_mumu']
74 input_files_cdst = sorted(list(file_to_iov_cdst.keys()))
75 basf2.B2INFO(f'Total number of \'hlt_mumu\' files actually used as input = {len(input_files_cdst)}')
76
77 if not input_files_cdst:
78 raise Exception('No valid input files found!')
79
80 # Get the overall IoV we our process should cover. Includes the end values that we may want to ignore since our output
81 # IoV should be open ended. We could also use this as part of the input data selection in some way.
82 requested_iov = kwargs['requested_iov']
83
84 from caf.utils import IoV
85 # The actual value our output IoV payload should have. Notice that we've set it open ended.
86 output_iov = IoV(requested_iov.exp_low, requested_iov.run_low, -1, -1)
87
88
90 from ROOT import Belle2 # noqa: make the Belle2 namespace available
91 from ROOT.Belle2 import KLMTimeAlgorithm
92
93 alg = KLMTimeAlgorithm()
94
95
97
98 from caf.framework import Calibration, Collection
99
100 cal_klm = Calibration('KLMTime')
101
102
104
105 from klm_calibration_utils import get_time_pre_collector_path
106
107 if input_files_cdst:
108 muon_list_name = 'klmTime'
109 coll_cdst = get_collector(input_data_name='hlt_mumu',
110 muon_list_name=muon_list_name)
111 rec_path_cdst = get_time_pre_collector_path(muon_list_name=muon_list_name)
112
113 collection_cdst = Collection(collector=coll_cdst,
114 input_files=input_files_cdst,
115 pre_collector_path=rec_path_cdst)
116
117 cal_klm.add_collection(name='cdst', collection=collection_cdst)
118
119
121
122 cal_klm.algorithms = [alg]
123
124 from caf.strategies import SequentialRunByRun
125
126 for algorithm in cal_klm.algorithms:
127 algorithm.strategy = SequentialRunByRun
128 algorithm.params = {'iov_coverage': output_iov}
129
130 # You must return all calibrations you want to run in the prompt process, even if it's only one
131 return [cal_klm]
132
133
134
135
136def get_collector(input_data_name, muon_list_name):
137 """
138 Return the correct KLMTimeCollector module setup for each data type.
139 Placed here so it can be different for prompt compared to standard.
140 """
141
142 if input_data_name == 'hlt_mumu':
143 return basf2.register_module('KLMTimeCollector',
144 inputParticleList=f'mu+:{muon_list_name}')
145 raise Exception("Unknown input data name used when setting up collector")