PartonHistoryConfig Namespace Reference

Classes
class	PartonHistoryBlock

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

Variables
tuple	KINEMATIC_VARS = ("pt", "eta", "phi", "m")
	INT_SUFFIXES = frozenset(("pdgId", "IsOnShell", "origin"))
dict	BRANCHES
dict	_TTBAR = BRANCHES["t"] + BRANCHES["tbar"] + BRANCHES["ttbar"]
dict	TRUTH_BRANCHES

Function Documentation

_get_aux_type()

str PartonHistoryConfig._get_aux_type ( str branch )

protected

Definition at line 14 of file PartonHistoryConfig.py.

def _get_aux_type(branch: str) -> str:
    return "int" if any(branch.endswith(s) for s in INT_SUFFIXES) else "float"
 
 

_make_particle_branches()

list PartonHistoryConfig._make_particle_branches ( str prefix, * , bool include_pdgid = True, 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 18 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] PartonHistoryConfig._replace_in_list ( list[str] string_list, str old, str new )

protected

Definition at line 61 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 PartonHistoryConfig._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 tbar, the b-quark is named 'bbar'.

Definition at line 70 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 tbar, the b-quark is named 'bbar'.
    """
    b_name = "bbar" if suffix == "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
 
 

Variable Documentation

_TTBAR

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

protected

Definition at line 139 of file PartonHistoryConfig.py.

BRANCHES

dict PartonHistoryConfig.BRANCHES

Definition at line 88 of file PartonHistoryConfig.py.

INT_SUFFIXES

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

Definition at line 11 of file PartonHistoryConfig.py.

KINEMATIC_VARS

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

Definition at line 10 of file PartonHistoryConfig.py.

TRUTH_BRANCHES

dict PartonHistoryConfig.TRUTH_BRANCHES

Initial value:

=  {
    "Ttbar": _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"],
    "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": (
        _replace_in_list(BRANCHES["t"], "t_", "t1_")
        + _replace_in_list(BRANCHES["t"], "t_", "t2_")
        + _replace_in_list(BRANCHES["tbar"], "tbar_", "tbar1_")
        + _replace_in_list(BRANCHES["tbar"], "tbar_", "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 141 of file PartonHistoryConfig.py.