Isolation tool for CharmWG

Taking inspiration from !2147 (merged), particles in the cone angle of the decay can be persisted in the DST with the function make_iso_particles(input, coneangle = 2., cone_for_each_track=False) defined in isolation.py and added as extra_particles in the definition of the line.

This is implemented in rare_charm_lines.py, serving also as an example.

Depends on: Rec!3434 (merged), Rec!3444 (merged), Rec!3441 (merged)

It superseed !2378 (merged), ie. it already includes the new lines of this MR

Rec!3456 (closed) allows only for the removal of duplicate candidates among the attached extra_particles and therefore shouldn't have an huge impact

Example to retrive the isolation variables in DaVinci can be found here.

Hlt/Hlt2Conf/python/Hlt2Conf/lines/charm/isolation.py

+###############################################################################
+# (c) Copyright 2022 CERN for the benefit of the LHCb Collaboration           #
+#                                                                             #
+# This software is distributed under the terms of the GNU General Public      #
+# Licence version 3 (GPL Version 3), copied verbatim in the file "COPYING".   #
+#                                                                             #
+# In applying this licence, CERN does not waive the privileges and immunities #
+# granted to it by virtue of its status as an Intergovernmental Organization  #
+# or submit itself to any jurisdiction.                                       #
+###############################################################################
+from PyConf import configurable
+from PyConf.Algorithms import WeightedRelTableAlg, SelectionFromWeightedRelationTable, ThOrParticleSelection
+from Hlt2Conf.standard_particles import make_long_pions, make_up_pions, make_down_pions, make_ttrack_pions, make_photons, make_merged_pi0s
+
+import Functors as F
+from Functors.math import in_range
+
+
+@configurable
+def extra_outputs_for_isolation(name, ref_particles, extra_particles,
+                                selection):
+    """
+    Save TES locations in extra outputs based on selection of extra particles information 
+    Args:
+        name: Name of the TES location to store extra particles
+        ref_particles: Containers of reference particles 
+        extra_particles: Containers of extra particles
+        selection: Expression to select combinations
+    """
+    RelTableAlg = WeightedRelTableAlg(
+        InputCandidates=extra_particles(),
+        ReferenceParticles=ref_particles,
+        Cut=selection)
+
+    RelTable = RelTableAlg.OutputRelations
+
+    selection_to_persist = SelectionFromWeightedRelationTable(
+        InputRelations=RelTable)
+
+    extra_outputs = [(name, selection_to_persist.OutputLocation)]
+
+    return extra_outputs
+
+
+@configurable
+def select_parts_for_isolation(
+        candidates=[],
+        cut=F.require_all(in_range(0., F.DR2, 1.), ~F.SHARE_TRACKS()),
+        LongTrackIso=True,
+        TTrackIso=False,
+        DownstreamTrackIso=False,
+        UpstreamTrackIso=False,
+        NeutralIso=True,
+        PizIso=False,
+):
+    """
+    Add to the extra_outputs different kind of isolations by properly setting the given flag 
+    Args:
+        candidates: List of containers of reference particles to relate extra particles
+        cut: Predicate to select extra information to persist. Be default: cone geometry with max dr2=1 and extra particles not signal
+        LongTrackIso: Boolean value to make isolation with long tracks
+        TTrackIso: Boolean value to make isolation with tt tracks
+        DownstreamTrackIso: Boolean value to make isolation with downstream tracks
+        UpstreamTrackIso: Boolean value to make isolation with upstream tracks
+        NeutralIso: Boolean value to make isolation with neutral particles
+        PizIso: Boolean value to make isolation with merged pi0 -> gamma gamma
+    """
+    extra_outputs = []
+    for cand in candidates:
+        if LongTrackIso:
+            extra_outputs += extra_outputs_for_isolation(
+                name="LongTrackIso",
+                extra_particles=make_long_pions,
+                ref_particles=cand,
+                selection=cut)
+        if TTrackIso:
+            extra_outputs += extra_outputs_for_isolation(
+                name="TTrackIso",
+                extra_particles=make_ttrack_pions,
+                ref_particles=cand,
+                selection=cut)
+        if DownstreamTrackIso:
+            extra_outputs += extra_outputs_for_isolation(
+                name="DownstreamTrackIso",
+                extra_particles=make_down_pions,
+                ref_particles=cand,
+                selection=cut)
+        if UpstreamTrackIso:
+            extra_outputs += extra_outputs_for_isolation(
+                name="UpstreamTrackIso",
+                extra_particles=make_up_pions,
+                ref_particles=cand,
+                selection=cut)
+        if NeutralIso:
+            extra_outputs += extra_outputs_for_isolation(
+                name="NeutralIso",
+                extra_particles=make_photons,
+                ref_particles=cand,
+                selection=cut)
+        if PizIso:
+            extra_outputs += extra_outputs_for_isolation(
+                name="PizIso",
+                extra_particles=make_merged_pi0s,
+                ref_particles=cand,
+                selection=cut)
+
+    return extra_outputs
+
+
+@configurable
+def make_iso_particles(input,
+                       coneangle=2.,
+                       LongTrackIso=True,
+                       TTrackIso=False,
+                       DownstreamTrackIso=False,
+                       UpstreamTrackIso=False,
+                       NeutralIso=True,
+                       PizIso=False,
+                       cone_for_each_track=False):
+
+    candidate = input
+    cut = F.require_all(in_range(0., F.DR2, coneangle), ~F.FIND_IN_TREE())
+
+    if cone_for_each_track:
+        code = F.GET_ALL_BASICS()
+        candidate = ThOrParticleSelection(
+            InputParticles=input, Functor=code).OutputSelection
+        cut = F.require_all(in_range(0., F.DR2, coneangle), ~F.SHARE_TRACKS())
+
+    iso_parts = select_parts_for_isolation(
+        candidates=[candidate],
+        cut=cut,
+        LongTrackIso=LongTrackIso,
+        TTrackIso=TTrackIso,
+        DownstreamTrackIso=DownstreamTrackIso,
+        UpstreamTrackIso=UpstreamTrackIso,
+        NeutralIso=NeutralIso,
+        PizIso=PizIso,
+    )
+
+    return iso_parts