Functor to replace MCTupleToolPrompt

DaVinciExamples/python/DaVinciExamples/tupling/example-tupling-mc-reconstructible-reconstructed.py

@@ -38,7 +38,8 @@ def main(options: Options):
     #Get variables related to reconstructible information.
     mcrtible = MCReconstructible(mc_track_info=get_mc_track_info())
     #The option extra_info is set to False by default and can be set to True to get more information
-    vars_rtible = MCReconstructible_Collection(mcrtible, extra_info=True)
+    vars_rtible = MCReconstructible_Collection(
+        mcreconstructible_alg=mcrtible, extra_info=True)
     print('Reconstructible functors:', vars_rtible.functor_dict.keys())
     #Note instead of importing functorcollections (MCReconstructed_Collection), one
     # can directly add track related information using the helper class (MCReconstructible)
@@ -58,7 +59,8 @@ def main(options: Options):
         relations_charged=relations_charged,
         relations_neutral=relations_neutral)
     #The option extra_info below is set to False by default in the functor collection.
-    vars_rted = MCReconstructed_Collection(mcrted_all, extra_info=False)
+    vars_rted = MCReconstructed_Collection(
+        mcreconstructed_alg=mcrted_all, extra_info=False)
     #Note:
     # - Instead of importing functorcollections (MCReconstructed_Collection), one
     #   can directly add track related information using the helper class (MCReconstructed).

DaVinciExamples/python/DaVinciExamples/tupling/option_davinci_tupling_from_collections.py

@@ -10,11 +10,12 @@
 ###############################################################################
 """
 Read an HLT2 file and create an ntuple using pre-defined Functor collections.
+This example is also used to test all available functor collections.
 """
 
 import Functors as F
 from DaVinciMCTools import MCReconstructible, MCReconstructed
-from FunTuple import FunctorCollection, functorcollections
+from FunTuple import FunctorCollection, functorcollections as functorcollections_original
 from FunTuple import FunTuple_Particles as Funtuple, FunTuple_MCParticles as MCFuntuple
 from DaVinci.algorithms import add_filter
 from DaVinci import Options, make_config
@@ -24,54 +25,86 @@ from Gaudi.Configuration import INFO
 from PyConf.reading import get_particles, get_mc_particles, get_mc_track_info
 
 
+class check_wrapper:
+    def __init__(self, functorcollection):
+        self.functorcollection = functorcollection
+        self.called = set()
+
+    def __getattr__(self, name: str):
+        func = getattr(self.functorcollection, name)
+        self.called.add(func.__name__)
+        return func
+
+    def number_of_functor_collection(self):
+        return len(self.functorcollection.__all__)
+
+    def number_of_called_functor_collection(self):
+        return len(self.called)
+
+    def check(self):
+        if self.number_of_functor_collection(
+        ) != self.number_of_called_functor_collection():
+            return False
+        sorted_set_all = sorted(set(self.functorcollection.__all__))
+        sorted_set_called = sorted(self.called)
+        if sorted_set_all != sorted_set_called:
+            return False
+        return True
+
+
 def main(options: Options):
     line_name = 'Hlt2Charm_D0ToKmPip_Line'
 
     d02kpi_data = get_particles(f"/Event/HLT2/{line_name}/Particles")
     MC_data = get_mc_particles("/Event/HLT2/MC/Particles")
 
-    #Get variables related to reconstructible information.
+    # Get variables related to reconstructible information.
     mcrtible = MCReconstructible(mc_track_info=get_mc_track_info())
 
-    #Get variables related to reconstructed information.
+    # Get variables related to reconstructed information.
     mcrted_all = MCReconstructed(MC_data, use_best_mcmatch=True)
 
-    #get configured "MCTruthAndBkgCatAlg" algorithm for HLT2 output
+    # get configured "MCTruthAndBkgCatAlg" algorithm for HLT2 output
     mctruth = configured_MCTruthAndBkgCatAlg(inputs=d02kpi_data)
 
-    #configure "WeightedRelTableAlg" algorithm for HLT2 output
+    # configure "WeightedRelTableAlg" algorithm for HLT2 output
     iso_rel_table = WeightedRelTableAlg(
         ReferenceParticles=d02kpi_data,
         InputCandidates=d02kpi_data,
         Cut=(F.DR2() < 0.4),
         OutputLevel=INFO)
 
+    # initialize the checker
+    functorcollections = check_wrapper(functorcollections_original)
+
     # use functorcollections to add variables, please expand when there's new collections :)
     collections = [
         functorcollections.Kinematics(),
-        functorcollections.MCHierarchy(mctruth),
-        functorcollections.MCKinematics(mctruth),
-        functorcollections.MCVertexInfo(mctruth),
-        functorcollections.TrackIsolation(iso_rel_table),
+        functorcollections.MCHierarchy(mctruth=mctruth),
+        functorcollections.MCKinematics(mctruth=mctruth),
+        functorcollections.MCVertexInfo(mctruth=mctruth),
+        functorcollections.MCPromptDecay(mctruth=mctruth),
+        functorcollections.TrackIsolation(iso_rel_table=iso_rel_table),
     ]
 
     MC_collections = [
         functorcollections.MCReconstructible_Collection(
-            mcrtible, extra_info=True),
+            mcreconstructible_alg=mcrtible, extra_info=True),
         functorcollections.MCReconstructed_Collection(
-            mcrted_all, extra_info=False),
+            mcreconstructed_alg=mcrted_all, extra_info=False),
         functorcollections.MCHierarchy(),
+        functorcollections.MCVertexInfo(),
+        functorcollections.MCPromptDecay(),
     ]
 
     evt_collections = [
         functorcollections.EventInfo(),
-        functorcollections.SelectionInfo("Hlt2", [line_name])
+        functorcollections.SelectionInfo(
+            sel_type="Hlt2", line_names=[line_name])
     ]
 
-    assert len(collections) + len(evt_collections) + len(
-        MC_collections) - 1 == len(  # -1 because MCHierarchy is tested twice.
-            functorcollections.__all__
-        ), "Oh no! Did you forget to add a new collection to this test?"
+    assert functorcollections.check(
+    ), "Oh no! Did you forget to add a new collection to this test?"
 
     field_vars = FunctorCollection()
     for coll in collections:

DaVinciExamples/python/DaVinciExamples/tupling/option_davinci_tupling_from_hlt2.py

@@ -101,7 +101,7 @@ def main(options: Options):
         "RUNNUMBER": F.RUNNUMBER(odin),
         "EVENTNUMBER": F.EVENTNUMBER(odin)
     })
-    evt_variables += SelectionInfo("Hlt2", [line_name])
+    evt_variables += SelectionInfo(sel_type="Hlt2", line_names=[line_name])
     #For now remove: The 'Hlt2' line decision tuples fine but breaks unit test with an error. (Why?)
     #see linked issue here: https://gitlab.cern.ch/lhcb/DaVinci/-/merge_requests/654#note_5320732
     evt_variables.pop('Hlt2')

DaVinciExamples/python/DaVinciExamples/tupling/option_davinci_tupling_substitutePID.py

@@ -21,7 +21,7 @@ from Gaudi.Configuration import INFO
 from FunTuple import FunTuple_Particles as Funtuple
 from FunTuple import FunctorCollection as FC
 from DaVinci.algorithms import add_filter
-from PyConf.reading import get_particles, get_odin
+from PyConf.reading import get_particles
 from DaVinciTools import SubstitutePID
 from PyConf.Algorithms import ParticleContainerMerger
 from FunTuple.functorcollections import EventInfo
@@ -74,8 +74,7 @@ def main(options: Options):
     variables = {'ALL': variables_all}
 
     # Get event information
-    odin = get_odin(options)
-    evt_vars = EventInfo(odin)
+    evt_vars = EventInfo(extra_info=True)
 
     #
     # Configure Funtuple algorithms

DaVinciExamples/python/DaVinciExamples/tupling/option_davinci_tupling_weightedrelation_trackvariables.py

@@ -77,7 +77,7 @@ def main(options: Options):
 
     variables_all = FunctorCollection({'THOR_P': F.P, 'THOR_PT': F.PT})
 
-    track_iso_variables = TrackIsolation(ftAlg)
+    track_iso_variables = TrackIsolation(iso_rel_table=ftAlg)
 
     variables_jpsik = {
         'B': variables_all + extra_variables,

DaVinciExamples/python/DaVinciExamples/tupling/option_trigger_decisions.py

@@ -40,7 +40,7 @@ def main(options: Options):
     ]
 
     #define event level variables
-    evt_variables = SelectionInfo("Hlt1", Hlt1_decisions)
+    evt_variables = SelectionInfo(sel_type="Hlt1", line_names=Hlt1_decisions)
 
     #define FunTuple instance
     my_tuple = Funtuple(

DaVinciTutorials/python/DaVinciTutorials/tutorial4_trigger_eventinfo.py

@@ -79,7 +79,7 @@ def main(options: Options):
     turbo_line = "Hlt2BsToJpsiPhi_JPsi2MuMu_PhiToKK_Line"
     turbo_line2 = "Hlt2BsToJpsiPhi_JPsi2ee_PhiToKK_Line"
     line_names = [f'{turbo_line}Decision', f'{turbo_line2}']
-    selinfo = SelectionInfo(sel_type, line_names)
+    selinfo = SelectionInfo(sel_type=sel_type, line_names=line_names)
     print(selinfo)
 
     #Define variables dictionary "field name" -> Collections of functor

DaVinciTutorials/python/DaVinciTutorials/tutorial5_MCTruth.py

@@ -50,8 +50,8 @@ def main(options: Options):
 
     #Pass it to collections
     kin = Kinematics()
-    mckin = MCKinematics(mctruth)
-    mchierarchy = MCHierarchy(mctruth)
+    mckin = MCKinematics(mctruth=mctruth)
+    mchierarchy = MCHierarchy(mctruth=mctruth)
     #print(mckin)
     #print(mchierarchy)