caf_klm_time.py

# -*- coding: utf-8 -*-
 
 
 
"""
Calibration of KLM time. It provides calibration constants for the KLMTimeCableDelay
and KLMTimeConstants database objects.
"""
 
import basf2
from prompt import CalibrationSettings, INPUT_DATA_FILTERS
 
 
 
 
settings = CalibrationSettings(name='KLM time',
                               expert_username='seemac',
                               description=__doc__,
                               input_data_formats=['cdst'],
                               input_data_names=['hlt_mumu'],
                               input_data_filters={
                                   'hlt_mumu': [INPUT_DATA_FILTERS['Run Type']['physics'],
                                                INPUT_DATA_FILTERS['Data Tag']['mumutight_calib'],
                                                INPUT_DATA_FILTERS['Data Quality Tag']['Good Or Recoverable']]
                               },
                               depends_on=[])
 
 
 
 
 
 
def get_calibrations(input_data, **kwargs):
    """
    Parameters:
      input_data (dict): Should contain every name from the 'input_data_names' variable as a key.
        Each value is a dictionary with {"/path/to/file_e1_r5.root": IoV(1,5,1,5), ...}. Useful for
        assigning to calibration.files_to_iov
 
      **kwargs: Configuration options to be sent in. Since this may change we use kwargs as a way to help prevent
        backwards compatibility problems. But you could use the correct arguments in b2caf-prompt-run for this
        release explicitly if you want to.
 
        Currently only kwargs["requested_iov"] is used. This is the output IoV range that your payloads should
        correspond to. Generally your highest ExpRun payload should be open ended e.g. IoV(3,4,-1,-1)
 
    Returns:
      list(caf.framework.Calibration): All of the calibration objects we want to assign to the CAF process
    """
    # Set up config options
 
    # In this script we want to use one sources of input data.
    # Get the input files from the input_data variable
    file_to_iov_cdst = input_data['hlt_mumu']
    input_files_cdst = sorted(list(file_to_iov_cdst.keys()))
    basf2.B2INFO(f'Total number of \'hlt_mumu\' files actually used as input = {len(input_files_cdst)}')
 
    if not input_files_cdst:
        raise Exception('No valid input files found!')
 
    # Get the overall IoV we our process should cover. Includes the end values that we may want to ignore since our output
    # IoV should be open ended. We could also use this as part of the input data selection in some way.
    requested_iov = kwargs['requested_iov']
 
    from caf.utils import IoV
    # The actual value our output IoV payload should have. Notice that we've set it open ended.
    output_iov = IoV(requested_iov.exp_low, requested_iov.run_low, -1, -1)
 
    
 
    from ROOT.Belle2 import KLMTimeAlgorithm
 
    alg = KLMTimeAlgorithm()
 
    
 
    from caf.framework import Calibration, Collection
 
    cal_klm = Calibration('KLMTime')
 
    
 
    from klm_calibration_utils import get_time_pre_collector_path
 
    if input_files_cdst:
        muon_list_name = 'klmTime'
        coll_cdst = get_collector(input_data_name='hlt_mumu',
                                  muon_list_name=muon_list_name)
        rec_path_cdst = get_time_pre_collector_path(muon_list_name=muon_list_name)
 
        collection_cdst = Collection(collector=coll_cdst,
                                     input_files=input_files_cdst,
                                     pre_collector_path=rec_path_cdst)
 
        cal_klm.add_collection(name='cdst', collection=collection_cdst)
 
    
 
    cal_klm.algorithms = [alg]
 
    from caf.strategies import SequentialRunByRun
 
    for algorithm in cal_klm.algorithms:
        algorithm.strategy = SequentialRunByRun
        algorithm.params = {'iov_coverage': output_iov}
 
    # You must return all calibrations you want to run in the prompt process, even if it's only one
    return [cal_klm]
 
 
 
 
def get_collector(input_data_name, muon_list_name):
    """
    Return the correct KLMTimeCollector module setup for each data type.
    Placed here so it can be different for prompt compared to standard.
    """
 
    if input_data_name == 'hlt_mumu':
        return basf2.register_module('KLMTimeCollector',
                                     inputParticleList=f'mu+:{muon_list_name}')
    raise Exception("Unknown input data name used when setting up collector")