Belle II Software  release-08-02-06
caf_beamspot.py
1 
8 
9 """
10 Airflow script to perform BeamSpot calibration.
11 """
12 
13 from prompt import CalibrationSettings, INPUT_DATA_FILTERS
14 from prompt.calibrations.caf_cdcdedx import settings as caf_cdc_dedx
15 # todo: add svd dedx in release-9
16 from prompt.calibrations.caf_top import settings as caf_top
17 from prompt.calibrations.caf_klm_strip_efficiency import settings as caf_klm_strip_efficiency
18 
19 
20 settings = CalibrationSettings(
21  name="BeamSpot Calibrations",
22  expert_username="zlebcr",
23  description=__doc__,
24  input_data_formats=["cdst"],
25  input_data_names=["mumu_tight_or_highm_calib"],
26  input_data_filters={
27  "mumu_tight_or_highm_calib": [
28  INPUT_DATA_FILTERS["Data Tag"]["mumu_tight_or_highm_calib"],
29  INPUT_DATA_FILTERS["Run Type"]["physics"],
30  INPUT_DATA_FILTERS["Data Quality Tag"]["Good Or Recoverable"],
31  INPUT_DATA_FILTERS["Magnet"]["On"]]},
32  expert_config={
33  "outerLoss": "pow(rawTime - 2.0, 2) + 10 * pow(maxGap, 2)",
34  "innerLoss": "pow(rawTime - 0.5, 2) + 10 * pow(maxGap, 2)",
35  "minPXDhits": 0},
36  depends_on=[caf_cdc_dedx, caf_top, caf_klm_strip_efficiency])
37 
38 
39 
40 
41 def get_calibrations(input_data, **kwargs):
42  """
43  Parameters:
44  input_data (dict): Should contain every name from the 'input_data_names' variable as a key.
45  Each value is a dictionary with {"/path/to/file_e1_r5.root": IoV(1,5,1,5), ...}. Useful for
46  assigning to calibration.files_to_iov
47 
48  **kwargs: Configuration options to be sent in. Since this may change we use kwargs as a way to help prevent
49  backwards compatibility problems. But you could use the correct arguments in b2caf-prompt-run for this
50  release explicitly if you want to.
51 
52  Currently only kwargs["output_iov"] is used. This is the output IoV range that your payloads should
53  correspond to. Generally your highest ExpRun payload should be open ended e.g. IoV(3,4,-1,-1)
54 
55  Returns:
56  list(caf.framework.Calibration): All of the calibration objects we want to assign to the CAF process
57  """
58  import basf2
59  # Set up config options
60 
61  # In this script we want to use one sources of input data.
62  # Get the input files from the input_data variable
63  file_to_iov_physics = input_data["mumu_tight_or_highm_calib"]
64 
65  # We might have requested an enormous amount of data across a run range.
66  # There's a LOT more files than runs!
67  # Lets set some limits because this calibration doesn't need that much to run.
68  max_files_per_run = 1000000
69 
70  # We filter out any more than 100 files per run. The input data files are sorted alphabetically by b2caf-prompt-run
71  # already. This procedure respects that ordering
72  from prompt.utils import filter_by_max_files_per_run
73 
74  reduced_file_to_iov_physics = filter_by_max_files_per_run(file_to_iov_physics, max_files_per_run)
75  input_files_physics = list(reduced_file_to_iov_physics.keys())
76  basf2.B2INFO(f"Total number of files actually used as input = {len(input_files_physics)}")
77 
78  # Get the overall IoV we our process should cover. Includes the end values that we may want to ignore since our output
79  # IoV should be open ended. We could also use this as part of the input data selection in some way.
80  requested_iov = kwargs.get("requested_iov", None)
81 
82  from caf.utils import IoV
83  # The actual value our output IoV payload should have. Notice that we've set it open ended.
84  output_iov = IoV(requested_iov.exp_low, requested_iov.run_low, -1, -1)
85 
86 
88 
89  from ROOT.Belle2 import BeamSpotAlgorithm
90  from basf2 import create_path, register_module
91  import modularAnalysis as ana
92 
93 
95 
96  from caf.framework import Calibration
97  from caf.strategies import SingleIOV
98 
99  # module to be run prior the collector
100  rec_path_1 = create_path()
101 
102  minPXDhits = kwargs['expert_config']['minPXDhits']
103  muSelection = '[p>1.0]'
104  muSelection += ' and abs(dz)<2.0 and abs(dr)<0.5'
105  muSelection += f' and nPXDHits >= {minPXDhits} and nSVDHits >= 8 and nCDCHits >= 20'
106  ana.fillParticleList('mu+:BS', muSelection, path=rec_path_1)
107  ana.reconstructDecay('Upsilon(4S):BS -> mu+:BS mu-:BS', '9.5<M<11.5', path=rec_path_1)
108 
109  collector_bs = register_module('BeamSpotCollector', Y4SPListName='Upsilon(4S):BS')
110  algorithm_bs = BeamSpotAlgorithm()
111  algorithm_bs.setOuterLoss(kwargs['expert_config']['outerLoss'])
112  algorithm_bs.setInnerLoss(kwargs['expert_config']['innerLoss'])
113 
114  calibration_bs = Calibration('BeamSpot',
115  collector=collector_bs,
116  algorithms=algorithm_bs,
117  input_files=input_files_physics,
118  pre_collector_path=rec_path_1)
119 
120  calibration_bs.strategies = SingleIOV
121 
122  # Do this for the default AlgorithmStrategy to force the output payload IoV
123  # It may be different if you are using another strategy like SequentialRunByRun
124  for algorithm in calibration_bs.algorithms:
125  algorithm.params = {"iov_coverage": output_iov}
126 
127  # Most other options like database chain and backend args will be overwritten by b2caf-prompt-run.
128  # So we don't bother setting them.
129 
130  # You must return all calibrations you want to run in the prompt process, even if it's only one
131  return [calibration_bs]
132 
133