Improving design of DV add_filter function

DaVinciExamples/python/DaVinciExamples/tupling/example-tupling-AllFunctors.py

@@ -22,7 +22,7 @@ from FunTuple import FunctorCollection
 from FunTuple import FunTuple_Particles as Funtuple
 from PyConf.application import make_data_with_FetchDataFromFile
 from DaVinci.reco_objects import make_pvs_for
-from DaVinci.algorithms import set_hlt_config, add_filter
+from DaVinci.algorithms import add_filter
 from DaVinci import options
 
 #
@@ -151,10 +151,8 @@ def alg_config():
     #
     # Sprucing filter
     #
-    hlt_dec_reports, spruce_dec_reports = set_hlt_config(options)
     my_filter = add_filter("HDRFilter_B0DsK",
-                           f"HLT_PASS('{bd2dsk_line}Decision')",
-                           hlt_dec_reports, spruce_dec_reports)
+                           f"HLT_PASS('{bd2dsk_line}Decision')")
 
     #
     # FunTuple

DaVinciTests/tests/options/option_davinci_filters.py

@@ -15,7 +15,7 @@ from FunTuple import FunctorCollection
 from FunTuple import FunTuple_Particles as Funtuple
 from FunTuple.NewTupleTools import Kinematics
 from PyConf.application import make_data_with_FetchDataFromFile
-from DaVinci.algorithms import add_filter, set_hlt_config
+from DaVinci.algorithms import add_filter
 
 bd2dsk_line = make_data_with_FetchDataFromFile(
     "/Event/Spruce/SpruceB2OC_BdToDsmK_DsmToHHH_FEST_Line/Particles")
@@ -91,15 +91,12 @@ def main():
     options.evt_pre_filters = {"Hlt2TopoLineFilter": evt_filter}
     options.output_level = 3
 
-    hlt_dec_reports, spruce_dec_reports = set_hlt_config(options)
     filter_B0DsK = add_filter(
         "HDRFilter_B0DsK",
-        "HLT_PASS('SpruceB2OC_BdToDsmK_DsmToHHH_FEST_LineDecision')",
-        hlt_dec_reports, spruce_dec_reports)
+        "HLT_PASS('SpruceB2OC_BdToDsmK_DsmToHHH_FEST_LineDecision')")
     filter_B0Dspi = add_filter(
         "HDRFilter_B0Dspi",
-        "HLT_PASS('SpruceB2OC_BdToDsmPi_DsmToHHH_LineDecision')",
-        hlt_dec_reports, spruce_dec_reports)
+        "HLT_PASS('SpruceB2OC_BdToDsmPi_DsmToHHH_LineDecision')")
 
     tools = []
     algs = {

DaVinciTests/tests/options/option_davinci_reading_hlt2.py

@@ -16,7 +16,7 @@ from FunTuple import FunctorCollection
 from FunTuple import FunTuple_Particles as Funtuple
 from PyConf.application import make_data_with_FetchDataFromFile
 from DaVinci.reco_objects import make_pvs_for
-from DaVinci.algorithms import add_filter, set_hlt_config
+from DaVinci.algorithms import add_filter
 from DaVinci import options
 
 branches = {
@@ -53,11 +53,9 @@ def main():
 
     d02kpi_line = "Hlt2CharmD0ToKmPipLine"
     d02kpi_data = make_data_with_FetchDataFromFile(f"/Event/HLT2/{d02kpi_line}/Particles")
-    hlt_dec_reports, _ = set_hlt_config(options)
     my_filter = add_filter(
         "HDRFilter_D0Kpi",
-        f"HLT_PASS('{d02kpi_line}Decision')",
-        hlt_dec_reports, None)
+        f"HLT_PASS('{d02kpi_line}Decision')")
     my_tuple = Funtuple(
         name="Tuple",
         tree_name="DecayTree",

DaVinciTests/tests/options/option_davinci_recVertices.py

@@ -16,7 +16,7 @@ from FunTuple import FunctorCollection
 from FunTuple import FunTuple_Particles as Funtuple
 from PyConf.application import make_data_with_FetchDataFromFile
 from DaVinci.reco_objects import make_pvs_for
-from DaVinci.algorithms import set_hlt_config, add_filter
+from DaVinci.algorithms import add_filter
 from DaVinci import options
 
 bd2dsk_line = "SpruceB2OC_BdToDsmK_DsmToHHH_FEST_Line"
@@ -40,17 +40,14 @@ def alg_config():
         'B0': variables_pvs,
         }
 
-    hlt_dec_reports, spruce_dec_reports = set_hlt_config(options)
     my_filter = add_filter(
         "HDRFilter_B0DsK",
-        f"HLT_PASS('{bd2dsk_line}Decision')",
-        hlt_dec_reports, spruce_dec_reports)
+        f"HLT_PASS('{bd2dsk_line}Decision')")
     my_tuple = Funtuple(
         name="B0DsK_Tuple",
         tree_name="DecayTree",
         branches=branches_dsk,
         variables=variables_dsk,
-        loki_preamble=[],
         inputs=bd2dsk_data)
 
     return {"UserAlgs" : [v2_pvs, my_filter, my_tuple]}, []

Phys/DaVinci/python/DaVinci/ConfigurationUpgrade.py

@@ -16,7 +16,7 @@ from PyConf.Algorithms import EventAccounting
 from DaVinci.configOptions import (check_options, set_job_options,
                                    set_args_options, set_input_file_options)
 from DaVinci.algorithms import (setup_algorithms, define_fsr_writer,
-                                set_hlt_config, apply_filters_and_unpacking)
+                                set_hltAnn_svc, apply_filters_and_unpacking)
 from DaVinci.config import davinci_control_flow, prepare_davinci_nodes
 
 
@@ -90,10 +90,8 @@ def add_davinci_configurables(options):
     check_options(options)
     config = configure_input(options)
 
-    hlt_dec_reports, spruce_dec_reports = set_hlt_config(options, config)
-    dvMainFlow.update(
-        apply_filters_and_unpacking(options, userAlgs, hlt_dec_reports,
-                                    spruce_dec_reports))
+    set_hltAnn_svc(config, options.getProp("annsvc_config"))
+    dvMainFlow.update(apply_filters_and_unpacking(options, userAlgs))
 
     if options.write_fsr:
         if options.simulation:

Phys/DaVinci/python/DaVinci/algorithms.py

@@ -60,42 +60,58 @@ def setup_algorithms(options):
     return dvAlgs, publicTools
 
 
-def add_filter(name, code, hlt_dec_reports, spruce_dec_reports):
+def set_filter(name, code, dec_reports):
     """
-    Adding HDR filter to FunTuple algorithms checking is the corresponding SpruceLine fired.
+    Adding an HDR filter to FunTuple algorithms checking if the corresponding HLT/Sprucing line fired.
 
-     Args:
+    Args:
        - name: filter's name.
        - code: filter's code.
-       - hlt_dec_reports: HltDecReportsDecoder containing the configuration for spruced lines.
-       - spruce_dec_reports: HltDecReportsDecoder containing the configuration for spruced lines.
+       - dec_reports: HltDecReportsDecoder containing the configuration for HLT/Sprucing lines.
 
     Returns:
        - Filter with name and code defined by the user.
     """
-    if "Spruce" in code:
-        algFilter = HDRFilter(name=name,
-                              Code=code,
-                              Location=spruce_dec_reports.OutputHltDecReportsLocation)
-    elif "Hlt" in code:
+    if dec_reports:
         algFilter = HDRFilter(name=name,
                               Code=code,
-                              Location=hlt_dec_reports.OutputHltDecReportsLocation)
+                              Location=dec_reports.OutputHltDecReportsLocation)
     else:
         algFilter = VoidFilter(name=name, Code=code)
-         
+
+    return algFilter
+
+
+def add_filter(name, code):
+    """
+    Adding an event pre-filter using a code defined by the user
+
+    Args:
+       - name: filter's name.
+       - code: filter's code.
+
+    Returns:
+       - Filter with name and code defined by the user.
+    """
+    import re
+    from DaVinci import options
+    dec_reports = None
+    for source in ["Hlt2", "Spruce"]:
+        if re.search("^HLT_PASS.*"+source, code):
+            dec_reports = get_hlt_reports(options, source)
+            break
+
+    algFilter = set_filter(name, code, dec_reports)
     return algFilter
 
 
-def apply_filters_and_unpacking(options, algs_dict, hlt_dec_reports, spruce_dec_reports):
+def apply_filters_and_unpacking(options, algs_dict):
     """
     Adding filter and unpacking algorithms.
     
     Args:
        - options: list of DaVinci options.
        - algs_dict: dict of the user algorithms.
-       - hlt_dec_reports: HltDecReportsDecoder containing the configuration for hlt2 lines.
-       - spruce_dec_reports: HltDecReportsDecoder containing the configuration for spruced lines.
 
     Returns:
        - Dict where at each node filters and unpacking algorithms are prepended to the initial list of user algorithms.
@@ -107,7 +123,7 @@ def apply_filters_and_unpacking(options, algs_dict, hlt_dec_reports, spruce_dec_
             evt_pre_filters = []
             code_filters = options.evt_pre_filters
             for title, code in code_filters.items():
-                evt_filter = add_filter(title, code, hlt_dec_reports, spruce_dec_reports) 
+                evt_filter = add_filter(title, code)
                 evt_pre_filters.append(evt_filter)
             algs_list += evt_pre_filters
 
@@ -259,14 +275,14 @@ def unpack_locations(options):
 
     return reading_algs
 
-
-def set_hlt_config(options, config=None):
+ 
+def get_hlt_reports(options, source=''):
     """
     Set the Hlt service and algorithms.
 
     Args:
        - options: list of DaVinci options.
-       - config: dict of configured Configurable instances.
+       - source: source ID required by the user.
 
     Returns:
        - HltDecReportsDecoder containing the configuration for hlt2 lines.
@@ -275,30 +291,17 @@ def set_hlt_config(options, config=None):
     from PyConf.Algorithms import HltDecReportsDecoder
     from PyConf.application import default_raw_event
     from PyConf.dataflow import force_location
-    annsvc_config = get_option_value(options, "annsvc_config")
      
-    if config:
-        set_hltAnn_svc(config, annsvc_config)
-
-    hlt_dec_reports = HltDecReportsDecoder(
+    dec_reports = HltDecReportsDecoder(
         RawEventLocations=default_raw_event(raw_event_format=options.input_raw_format,
                                             bank_types=["HltDecReports"]),
-        SourceID='Hlt2',
+        SourceID=source,
         outputs={
             "OutputHltDecReportsLocation":
-            force_location("/Event/Hlt2/DecReports")
+            force_location("/Event/%s/DecReports"%source)
         })
 
-    spruce_dec_reports = HltDecReportsDecoder(
-        RawEventLocations=default_raw_event(raw_event_format=options.input_raw_format,
-                                            bank_types=["HltDecReports"]),
-        SourceID="Spruce",
-        outputs={
-            "OutputHltDecReportsLocation":
-            force_location("/Event/Spruce/DecReports")
-        })
-
-    return hlt_dec_reports, spruce_dec_reports
+    return dec_reports
 
 
 def get_hltAnn_dict(annsvc_config):
@@ -386,11 +389,8 @@ def ConfiguredFuntuple(config):
     """
     from FunTuple import FunTuple_Particles as Funtuple
     from PyConf.application import make_data_with_FetchDataFromFile
-    from DaVinci import options
     
-    hlt_dec_reports, spruce_dec_reports = set_hlt_config(options)
     dictAlgs = {}
-
     for key in config.keys():
         inputs = make_data_with_FetchDataFromFile(config[key]["location"])
         dictAlgs[key] = []
@@ -404,8 +404,7 @@ def ConfiguredFuntuple(config):
 
             tupleFilter = add_filter(
                 filter_name,
-                line,
-                hlt_dec_reports, spruce_dec_reports)
+                line)
             dictAlgs[key].append(tupleFilter)
 
         funTuple = Funtuple(