Classes
class	PartonHistoryBlock

Functions
str	_get_aux_type (str branch, str prefix)
list	_make_particle_branches (str prefix, *, bool include_pdgid=True, Optional[tuple] stages=None, tuple extra=())
list[str]	_replace_in_list (list[str] string_list, str old, str new)
list	_t_branches (str suffix="t")
list	_t_FCNC_branches (str suffix="t")

Variables
tuple	KINEMATIC_VARS = ("pt", "eta", "phi", "m")
	INT_SUFFIXES = frozenset(("pdgId", "IsOnShell", "origin"))
tuple	VECTOR_PREFIXES = ("MC_b_", "MC_bbar_", "MC_c_", "MC_cbar_")
	VECTOR_HISTORIES = frozenset(("Ttbarbbbar", "Ttbarccbar"))
dict	BRANCHES
dict	_TTBAR = BRANCHES["t"] + BRANCHES["tbar"] + BRANCHES["ttbar"]
dict	TRUTH_BRANCHES

Function Documentation

◆ _get_aux_type()

str _get_aux_type	(	str	branch,
		str	prefix )

protected

Definition at line 17 of file PartonHistoryConfig.py.

def _get_aux_type(branch: str, prefix: str) -> str:
    # Handle specific cases where vectors are returned for each particle type
    # In those cases, only external particles can be vectors, there is still
    # a single particle allowed in named positions within decay chains
    is_vector = prefix in VECTOR_HISTORIES and branch.startswith(VECTOR_PREFIXES) and "_from_" not in branch
 
    if is_vector:
        return "vector_int" if any(branch.endswith(s) for s in INT_SUFFIXES) else "vector_float"
    else:
        return "int" if any(branch.endswith(s) for s in INT_SUFFIXES) else "float"
 

◆ _make_particle_branches()

list _make_particle_branches	(	str	prefix,
		*	,
		bool	include_pdgid = True,
		Optional[tuple]	stages = None,
		tuple	extra = () )

protected

Generate standard kinematic branch names for a particle.

Parameters
----------
prefix:
    Particle label as it appears in the branch name, e.g. ``"t"`` ->
    ``MC_t_beforeFSR_pt``. When the prefix already encodes the FSR stage
    (e.g. ``"W_beforeFSR_from_t"``), pass ``stages=()``.
include_pdgid:
    Append ``pdgId`` after the kinematic variables for each stage.
stages:
    FSR stage tokens to iterate over. Defaults to
    ``("beforeFSR", "afterFSR")``. Pass ``()`` when the FSR stage is
    already embedded in prefix — branches become ``MC_{prefix}_{var}``.
extra:
    Additional branch suffixes appended verbatim, e.g. ``("IsOnShell",)``.

Definition at line 28 of file PartonHistoryConfig.py.

) -> list:
    """Generate standard kinematic branch names for a particle.
 
    Parameters
    ----------
    prefix:
        Particle label as it appears in the branch name, e.g. ``"t"`` ->
        ``MC_t_beforeFSR_pt``. When the prefix already encodes the FSR stage
        (e.g. ``"W_beforeFSR_from_t"``), pass ``stages=()``.
    include_pdgid:
        Append ``pdgId`` after the kinematic variables for each stage.
    stages:
        FSR stage tokens to iterate over. Defaults to
        ``("beforeFSR", "afterFSR")``. Pass ``()`` when the FSR stage is
        already embedded in prefix — branches become ``MC_{prefix}_{var}``.
    extra:
        Additional branch suffixes appended verbatim, e.g. ``("IsOnShell",)``.
    """
    if stages is None:
        stages = ("beforeFSR", "afterFSR")
    result = []
    if stages:
        for stage in stages:
            for var in KINEMATIC_VARS:
                result.append(f"MC_{prefix}_{stage}_{var}")
            if include_pdgid:
                result.append(f"MC_{prefix}_{stage}_pdgId")
    else:
        for var in KINEMATIC_VARS:
            result.append(f"MC_{prefix}_{var}")
        if include_pdgid:
            result.append(f"MC_{prefix}_pdgId")
    for suffix in extra:
        result.append(f"MC_{prefix}_{suffix}")
    return result
 
 

◆ _replace_in_list()

list[str] _replace_in_list	(	list[str]	string_list,
		str	old,
		str	new )

protected

Definition at line 71 of file PartonHistoryConfig.py.

def _replace_in_list(string_list: list[str], old: str, new: str) -> list[str]:
    return [item.replace(old, new) for item in string_list]
 
# ---------------------------------------------------------------------------
# Per-particle branch lists
# ---------------------------------------------------------------------------

◆ _t_branches()

list _t_branches ( str suffix = "t" )

protected

Branches for a top quark and its full decay chain.

Sub-particles carry the FSR stage in their prefix so we pass ``stages=()``
to avoid appending a spurious stage token to the variable name.
For antitops (suffix starting with 'tbar'), the b-quark is named 'bbar'.

Definition at line 80 of file PartonHistoryConfig.py.

def _t_branches(suffix: str = "t") -> list:
    """Branches for a top quark and its full decay chain.
 
    Sub-particles carry the FSR stage in their prefix so we pass ``stages=()``
    to avoid appending a spurious stage token to the variable name.
    For antitops (suffix starting with 'tbar'), the b-quark is named 'bbar'.
    """
    b_name = "bbar" if suffix.startswith("tbar") else "b"
    sub_particles = ("W", b_name, "Wdecay1", "Wdecay2")
    result = _make_particle_branches(suffix)
    for particle in sub_particles:
        for stage in ("beforeFSR", "afterFSR"):
            result += _make_particle_branches(
                f"{particle}_{stage}_from_{suffix}", stages=()
            )
    return result
 

◆ _t_FCNC_branches()

list _t_FCNC_branches ( str suffix = "t" )

protected

Branches for a top quark undergoing FCNC decay t -> q X, X -> decay1 decay2.

Sub-particles carry the FSR stage in their prefix so we pass ``stages=()``
to avoid appending a spurious stage token to the variable name.
For tbar, the q-quark is named 'qbar'.

Definition at line 97 of file PartonHistoryConfig.py.

def _t_FCNC_branches(suffix: str = "t") -> list:
    """Branches for a top quark undergoing FCNC decay t -> q X, X -> decay1 decay2.
 
    Sub-particles carry the FSR stage in their prefix so we pass ``stages=()``
    to avoid appending a spurious stage token to the variable name.
    For tbar, the q-quark is named 'qbar'.
    """
    q_name = "qbar" if suffix == "tbar" else "q"
    sub_particles = ("X", q_name, "Xdecay1", "Xdecay2")
    result = _make_particle_branches(suffix)
    for particle in sub_particles:
        for stage in ("beforeFSR", "afterFSR"):
            result += _make_particle_branches(
                f"{particle}_{stage}_from_{suffix}", stages=()
            )
    return result
 

Variable Documentation

◆ _TTBAR

dict PartonHistoryConfig._TTBAR = BRANCHES["t"] + BRANCHES["tbar"] + BRANCHES["ttbar"]

protected

Definition at line 167 of file PartonHistoryConfig.py.

◆ BRANCHES

dict PartonHistoryConfig.BRANCHES

Definition at line 114 of file PartonHistoryConfig.py.

◆ INT_SUFFIXES

PartonHistoryConfig.INT_SUFFIXES = frozenset(("pdgId", "IsOnShell", "origin"))

Definition at line 13 of file PartonHistoryConfig.py.

◆ KINEMATIC_VARS

tuple PartonHistoryConfig.KINEMATIC_VARS = ("pt", "eta", "phi", "m")

Definition at line 12 of file PartonHistoryConfig.py.

◆ TRUTH_BRANCHES

dict PartonHistoryConfig.TRUTH_BRANCHES

Initial value:

=  {
    "Ttbar": _TTBAR,
    "TtbarFCNC": BRANCHES["t_FCNC"] + BRANCHES["tbar_FCNC"] + BRANCHES["ttbar"],
    "Ttbarbbbar": _TTBAR + BRANCHES["b"] + BRANCHES["bbar"],
    "Ttbarccbar": _TTBAR + BRANCHES["c"] + BRANCHES["cbar"],
    "Ttz": _TTBAR + BRANCHES["Z"],
    "Ttw": _TTBAR + BRANCHES["W"],
    "Tth": _TTBAR + BRANCHES["Higgs"],
    "Ttgamma": _TTBAR + BRANCHES["Photon"],
    "Tq": BRANCHES["t"] + BRANCHES["b"],
    "Tzq": BRANCHES["t"] + BRANCHES["Z"] + BRANCHES["b"],
    "Thq": BRANCHES["t"] + BRANCHES["Higgs"] + BRANCHES["b"] + BRANCHES["W"],
    "Tqgamma": BRANCHES["t"] + BRANCHES["Photon"] + BRANCHES["b"],
    "Wtb": BRANCHES["t"] + BRANCHES["W"] + BRANCHES["b"],
    "FourTop": (
        _t_branches("t1")
        + _t_branches("t2")
        + _t_branches("tbar1")
        + _t_branches("tbar2")
    ),
    "HWW": BRANCHES["Higgs"],
    "WW_nonresonant": (
        _replace_in_list(BRANCHES["W"], "W", "W1")
        + _replace_in_list(BRANCHES["W"], "W", "W2")
    ),
    "HWW_nonresonant": BRANCHES["Higgs"],
    "HZZ": BRANCHES["Higgs"],
    "Zb": BRANCHES["Z"] + BRANCHES["b"] + BRANCHES["bbar"],
    "Ztautau": BRANCHES["Z_extended"],
}

Definition at line 169 of file PartonHistoryConfig.py.

◆ VECTOR_HISTORIES

PartonHistoryConfig.VECTOR_HISTORIES = frozenset(("Ttbarbbbar", "Ttbarccbar"))

Definition at line 15 of file PartonHistoryConfig.py.

◆ VECTOR_PREFIXES

tuple PartonHistoryConfig.VECTOR_PREFIXES = ("MC_b_", "MC_bbar_", "MC_c_", "MC_cbar_")

Definition at line 14 of file PartonHistoryConfig.py.

Classes

Functions

Variables

Function Documentation

◆ _get_aux_type()

◆ _make_particle_branches()

◆ _replace_in_list()

◆ _t_branches()

◆ _t_FCNC_branches()

Variable Documentation

◆ _TTBAR

◆ BRANCHES

◆ INT_SUFFIXES

◆ KINEMATIC_VARS

◆ TRUTH_BRANCHES

◆ VECTOR_HISTORIES

◆ VECTOR_PREFIXES