#!/usr/bin/env python3
##########################################################################
# basf2 (Belle II Analysis Software Framework) #
# Author: The Belle II Collaboration #
# #
# See git log for contributors and copyright holders. #
# This file is licensed under LGPL-3.0, see LICENSE.md. #
##########################################################################
import re
import basf2 as b2
import modularAnalysis as ma
from variables import variables
import pdg
from ROOT import Belle2
Const = Belle2.Const
_TrainingMode = Belle2.ChargedPidMVAWeights.ChargedPidMVATrainingMode
# define arrays to interpret cut matrix
_chargednames = ['pi', 'K', 'p', 'e', 'mu']
_pidnames = ['pionID', 'kaonID', 'protonID', 'electronID', 'muonID']
_stdnames = ['all', 'loose', 'loosepid', 'good', 'higheff']
_effnames = ['95eff', '90eff', '85eff']
# default particle list for stdPi() and similar functions
_defaultlist = 'good'
_mostLikelyList = 'mostlikely'
def _stdChargedEffCuts(particletype, listtype):
"""
Provides the PID cut corresponding to a given efficiency percentile
@param particletype type of charged particle (pi, K, p, e, mu)
@param listtype efficiency percentile for the list (95eff, 90eff, 85eff)
"""
particleindex = _chargednames.index(particletype)
effindex = _effnames.index(listtype)
# efficiency cuts = [.95,.90,.85] efficiency; values outside (0,1) mean the cut does not exist and an error will be thrown
effcuts = [[0.001, 0.019, 0.098],
[5e-6, 0.027, 0.167],
[0.000, 0.043, 0.251],
[0.093, 0.301, 0.709],
[0.187, 0.418, 0.909]]
#
return effcuts[particleindex][effindex]
[docs]def stdCharged(particletype, listtype, path, writeOut=True):
"""
Function to prepare one of several standardized types of charged particle lists:
- 'all' with no cuts on track
- 'good' high purity lists for data studies
- 'loosepid' loose selections for skimming, PID cut only
- 'loose' loose selections for skimming
- 'higheff' high efficiency list with loose global ID cut for data studies
- 'mostlikely' list with the highest PID likelihood
Also the following lists, which may or may not be available depending on the release
- '99eff' with 99% selection efficiency (calculated for 1<p<4 GeV) and good track (MC only)
- '95eff' with 95% selection efficiency (calculated for 1<p<4 GeV) and good track (MC only)
- '90eff' with 90% selection efficiency (calculated for 1<p<4 GeV) and good track (MC only)
- '85eff' with 85% selection efficiency (calculated for 1<p<4 GeV) and good track (MC only)
@param particletype type of charged particle to make a list of
@param listtype name of standard list
@param path modules are added to this path
@param writeOut whether RootOutput module should save the created ParticleList
"""
# basic quality cut strings
trackQuality = 'thetaInCDCAcceptance and nCDCHits>20'
ipCut = 'dr < 0.5 and abs(dz) < 2'
goodTrack = trackQuality + ' and ' + ipCut
if particletype not in _chargednames:
b2.B2ERROR("The requested list is not a standard charged particle. Use one of pi, K, e, mu, p.")
if listtype == 'all':
ma.fillParticleList(particletype + '+:all', '', writeOut=writeOut, path=path)
elif listtype == 'good':
ma.fillParticleList(
particletype + '+:good',
_pidnames[_chargednames.index(particletype)] + ' > 0.5 and ' + goodTrack,
writeOut=writeOut,
path=path)
elif listtype == 'loose':
ma.fillParticleList(
particletype + '+:loose',
_pidnames[_chargednames.index(particletype)] + ' > 0.1 and ' + goodTrack,
writeOut=writeOut,
path=path)
elif listtype == 'loosepid':
ma.fillParticleList(
particletype + '+:loosepid',
_pidnames[_chargednames.index(particletype)] + ' > 0.1',
writeOut=writeOut,
path=path)
elif listtype == 'higheff':
ma.fillParticleList(
particletype + '+:higheff',
_pidnames[_chargednames.index(particletype)] + ' > 0.002 and ' + goodTrack,
writeOut=writeOut,
path=path)
elif listtype not in _effnames:
b2.B2ERROR("The requested list is not defined. Please refer to the stdCharged documentation.")
else:
pidcut = _stdChargedEffCuts(particletype, listtype)
if 0.0 < pidcut < 1.0:
ma.fillParticleList(
particletype +
'+:' +
listtype,
_pidnames[_chargednames.index(particletype)] +
' > ' +
str(pidcut) +
' and ' +
goodTrack,
writeOut=writeOut,
path=path)
else:
b2.B2ERROR('The requested standard particle list ' + particletype +
'+:' + listtype + ' is not available in this release.')
[docs]def stdPi(listtype=_defaultlist, path=None, writeOut=True):
"""
Function to prepare standard pion lists, refer to `stdCharged` for details
@param listtype name of standard list
@param path modules are added to this path
@param writeOut whether RootOutput module should save the created ParticleList
"""
stdCharged('pi', listtype, path, writeOut)
[docs]def stdK(listtype=_defaultlist, path=None, writeOut=True):
"""
Function to prepare standard kaon lists, refer to `stdCharged` for details
@param listtype name of standard list
@param path modules are added to this path
@param writeOut whether RootOutput module should save the created ParticleList
"""
stdCharged('K', listtype, path, writeOut)
[docs]def stdPr(listtype=_defaultlist, path=None, writeOut=True):
"""
Function to prepare standard proton lists, refer to `stdCharged` for details
@param listtype name of standard list
@param path modules are added to this path
@param writeOut whether RootOutput module should save the created ParticleList
"""
stdCharged('p', listtype, path, writeOut)
[docs]def stdLep(pdgId,
working_point,
method,
classification,
lid_weights_gt,
release=None,
channel_eff="combination",
channel_misid_pi="combination",
channel_misid_K="combination",
inputListName=None,
outputListLabel=None,
trainingModeMulticlass=_TrainingMode.c_Multiclass,
trainingModeBinary=_TrainingMode.c_Classification,
path=None):
"""
Function to prepare one of several standardized types of lepton (:math:`e,\\mu`) lists, with the following working points:
* 'FixedThresh05', PID cut of > 0.5 for each particle in the list.
* 'FixedThresh09', PID cut of > 0.9 for each particle in the list.
* 'FixedThresh095', PID cut of > 0.95 for each particle in the list.
* 'FixedThresh099', PID cut of > 0.99 for each particle in the list.
* 'UniformEff60' 60% lepton efficiency list, uniform in a given multi-dimensional parametrisation.
* 'UniformEff70' 70% lepton efficiency list, uniform in a given multi-dimensional parametrisation.
* 'UniformEff80' 80% lepton efficiency list, uniform in a given multi-dimensional parametrisation.
* 'UniformEff90' 90% lepton efficiency list, uniform in a given multi-dimensional parametrisation.
* 'UniformEff95' 95% lepton efficiency list, uniform in a given multi-dimensional parametrisation.
* 'UniformPiFR5EM1' 50% pion to lepton fake rate, uniform in a given multi-dimensional parametrisation.
* 'UniformPiFR1EM1' 10% pion to lepton fake rate, uniform in a given multi-dimensional parametrisation.
* 'UniformPiFR5EM2' 5% pion to lepton fake rate, uniform in a given multi-dimensional parametrisation.
* 'UniformPiFR1EM2' 1% pion to lepton fake rate, uniform in a given multi-dimensional parametrisation.
* 'UniformPiFR5EM3' 0.5% pion to lepton fake rate, uniform in a given multi-dimensional parametrisation.
* 'UniformPiFR1EM3' 0.1% pion to lepton fake rate, uniform in a given multi-dimensional parametrisation.
The function creates a ``ParticleList``, selecting particles according to the chosen ``working_point``,
and decorates each candidate in the list with the nominal Data/MC :math:`\\ell` ID efficiency and
:math:`\\pi,K` fake rate correction factors and their stat, syst uncertainty, reading the info
from the Conditions Database (CDB) according to the chosen input global tag (GT).
.. note::
Particles will **not** be selected if they are outside the Data/MC *efficiency* corrections' phase space coverage
for the given working point.
In fact, the threshold value for the PID cut in such cases is set to NaN.
.. warning::
At the moment, the only supported *binary* lepton identification is against the **pion** hypothesis.
This implies that, if binary classification is chosen, only :math:`\\pi` fake rate corrections will be added to the
resulting particle list.
Parameters:
pdgId (int): the lepton pdg code.
working_point (str): name of the chosen working point that defines the content of the list. Choose among the above values.
method (str): the PID method: 'likelihood' or 'bdt'.
classification (str): the type of classifier: 'binary' (one-vs-pion) or 'global' (one-vs-all).
lid_weights_gt (str): the name identifier of the global tag with the recommended Data/MC correction weights.
.. tip::
Please refer to the
`Lepton ID Confluence page <https://confluence.desy.de/display/BI/Lepton+ID+Performance>`_
for info about the recommended global tags.
release (Optional[int]): the major release number of the data and MC campaigns considered.
If specified, it ensures the correct :math:`\\ell` ID variables are used.
.. tip::
Please refer to the
`Lepton ID Confluence page <https://confluence.desy.de/display/BI/Lepton+ID+Performance>`_
for info about lepton identification variables and campaigns.
channel_eff (Optional[str]): the channel used to derive the :math:`\\ell` ID efficiency corrections.
By default, 'combination' is set, meaning they are obtained by combining results
of several hadronic and low multiplicity channels, wherever they overlap.
.. tip::
Please refer to the
`Lepton ID Confluence page <https://confluence.desy.de/display/BI/Lepton+ID+Performance>`_
for other possible choices (if any).
channel_misid_pi (Optional[str]): the channel used to derive the :math:`\\pi` fake rate corrections.
channel_misid_K (Optional[str]): the channel used to derive the :math:`K` fake rate corrections.
inputListName (Optional[str]): the name of a pre-existing ``ParticleList`` object (defined as a full ``decayString``,
e.g. 'e-:my_input_electrons') of which the standard lepton list will be a subset.
For instance, users might want to apply a Bremsstrahlung correction to electrons first,
which modifies their 4-momentum, and only later define the subset passing the PID selection,
including the appropriate PID weights and uncertainties (which are :math:`p`-dependent).
By default, the standard lepton list is created from all ``Track`` objects in the event.
.. warning::
Do **not** apply any PID selection on the input list, otherwise results could be biased.
outputListLabel (Optional[str]): the name of the output lepton list label, i.e.,
the string that follows the particle identifier ('e-:', 'mu-:').
By default, it is assigned as:
``'{method}_{classification}_{working_point}'``.
trainingModeMulticlass (Optional[``Belle2.ChargedPidMVAWeights.ChargedPidMVATrainingMode``]): enum identifier
of the multi-class (global PID) training mode.
See `modularAnalysis.applyChargedPidMVA` docs for available options.
trainingModeBinary (Optional[``Belle2.ChargedPidMVAWeights.ChargedPidMVATrainingMode``]): enum identifier
of the classification (binary PID) training mode.
See `modularAnalysis.applyChargedPidMVA` docs for available options.
path (basf2.Path): modules are added to this path.
Returns:
tuple(str, list(str)): the alias for the lepton ID variable, and the list of aliases for the weights.
"""
working_points = (
"FixedThresh05",
"FixedThresh09",
"FixedThresh095",
"FixedThresh099",
"UniformEff60",
"UniformEff70",
"UniformEff80",
"UniformEff90",
"UniformEff95",
"UniformPiFR5EM1",
"UniformPiFR1EM1",
"UniformPiFR5EM2",
"UniformPiFR1EM2",
"UniformPiFR5EM3",
"UniformPiFR1EM3",
)
available_methods = ("likelihood", "bdt")
available_classificators = ("global", "binary")
if working_point not in working_points:
b2.B2ERROR(f"The requested lepton list working point: {working_point} is not defined. \
Please refer to the stdLep and stdCharged documentation.")
return None
if method not in available_methods:
b2.B2ERROR(f"method: {method}. Must be any of: {available_methods}.")
return None
if classification not in available_classificators:
b2.B2ERROR(f"classification: {classification}. Must be any of: {available_classificators}.")
return None
b2.B2INFO(f"Prepending GT with LID corrections: {lid_weights_gt}")
b2.conditions.prepend_globaltag(lid_weights_gt)
# We stick to positive pdgId by convention.
# Anyway, the particle list will be filled for anti-particles too.
lepton = abs(pdgId)
lepton_name = pdg.to_name(lepton)
electron = Const.electron.getPDGCode()
muon = Const.muon.getPDGCode()
pion = Const.pion.getPDGCode()
if lepton not in (electron, muon):
b2.B2ERROR(f"{pdgId} is not that of a light charged lepton.")
return None
# Declare LID variables (as in the VariableManager), and aliases to match the naming scheme used in the payloads.
pid_variables = {
"likelihood": {
"global": {
"var": {
electron: "electronID",
muon: "muonID",
},
"alias": {
electron: "electronID",
muon: "muonID",
}
},
"binary": {
"var": {
electron: f"binaryPID({electron}, {pion})",
muon: f"binaryPID({muon}, {pion})",
},
"alias": {
electron: "binaryPID_e_pi",
muon: "binaryPID_mu_pi",
}
}
},
"bdt": {
"global": {
"var": {
lepton: f"pidChargedBDTScore({lepton}, ALL)",
},
"alias": {
lepton: re.sub(r"\W+", "", f"pidChargedBDTScore_{lepton_name}"),
}
},
"binary": {
"var": {
lepton: f"pidPairChargedBDTScore({lepton}, {pion}, ALL)",
},
"alias": {
lepton: re.sub(r"\W+", "", f"pidPairChargedBDTScore_{lepton_name}_pi"),
}
}
}
}
# Depending on the release associated to the chosen LID recommendations GT,
# some variable names and aliases may need to be reset.
if int(release) in [5, 6]:
if lepton == electron:
b2.B2INFO(f"The likelihood-based electron ID in release {release} samples is defined w/o the SVD and the TOP")
pid_variables["likelihood"]["global"]["var"][electron] = "electronID_noSVD_noTOP"
pid_variables["likelihood"]["global"]["alias"][electron] = "electronID_noSVD_noTOP"
pid_variables["likelihood"]["binary"]["var"][electron] = f"binaryElectronID_noSVD_noTOP({pion})"
pid_variables["likelihood"]["binary"]["alias"][electron] = "binaryElectronID_noSVD_noTOP_pi"
else:
b2.B2INFO(f"The likelihood-based muon ID in release {release} samples is defined w/o the SVD")
pid_variables["likelihood"]["global"]["var"][muon] = "muonID_noSVD"
pid_variables["likelihood"]["global"]["alias"][muon] = "muonID_noSVD"
pid_variables["likelihood"]["binary"]["var"][muon] = f"binaryPID_noSVD({muon}, {pion})"
pid_variables["likelihood"]["binary"]["alias"][muon] = "binaryMuonID_noSVD_pi"
# Create the aliases.
pid_var = pid_variables[method][classification]["var"][lepton]
pid_alias = pid_variables[method][classification]["alias"][lepton]
if pid_alias != pid_var:
variables.addAlias(pid_alias, pid_var)
# Start creating the particle list, w/o any selection.
outputListName = f"{lepton_name}:{method}_{classification}_{working_point}"
if outputListLabel is not None:
outputListName = f"{lepton_name}:{outputListLabel}"
if inputListName is None:
ma.fillParticleList(outputListName, "", path=path)
else:
b2.B2INFO(
f"The standard lepton list: '{outputListName}' will be created as a subset \
of the following ParticleList: '{inputListName}'")
ma.copyList(outputListName, inputListName, path=path)
# Here we must run the BDT if requested.
if method == "bdt":
if classification == "global":
ma.applyChargedPidMVA(particleLists=[outputListName],
path=path,
trainingMode=trainingModeMulticlass)
elif classification == "binary":
ma.applyChargedPidMVA(particleLists=[outputListName],
path=path,
binaryHypoPDGCodes=(lepton, pion),
trainingMode=trainingModeBinary)
# The names of the payloads w/ efficiency and mis-id corrections.
payload_eff = f"ParticleReweighting:{pid_alias}_eff_{channel_eff}_{working_point}"
payload_misid_pi = f"ParticleReweighting:{pid_alias}_misid_pi_{channel_misid_pi}_{working_point}"
# Configure weighting module(s).
path.add_module("ParticleWeighting",
particleList=outputListName,
tableName=payload_eff).set_name(f"ParticleWeighting_eff_{outputListName}")
path.add_module("ParticleWeighting",
particleList=outputListName,
tableName=payload_misid_pi,
allowToSkip=True).set_name(f"ParticleWeighting_misid_pi_{outputListName}")
if classification == "global":
payload_misid_K = f"ParticleReweighting:{pid_alias}_misid_K_{channel_misid_K}_{working_point}"
path.add_module("ParticleWeighting",
particleList=outputListName,
tableName=payload_misid_K,
allowToSkip=True).set_name(f"ParticleWeighting_misid_K_{outputListName}")
# Apply the PID selection cut, which is read from the efficiency payload.
# The '>=' handles extreme cases in which the variable and the threshold value are at a boundary of the PID variable range.
cut = f"[{pid_alias} >= extraInfo({payload_eff}_threshold)]"
ma.applyCuts(outputListName, cut, path=path)
# Define convenience aliases for the nominal weight and up/dn variations.
weight_aliases_to_var = {
f"weight_{pid_alias}_eff_{working_point}": f"extraInfo({payload_eff}_data_MC_ratio)",
f"weight_{pid_alias}_misid_pi_{working_point}": f"extraInfo({payload_misid_pi}_data_MC_ratio)",
# These aliases are *absolute* variations.
f"weight_{pid_alias}_eff_{working_point}_stat_up": f"extraInfo({payload_eff}_data_MC_uncertainty_stat_up)",
f"weight_{pid_alias}_eff_{working_point}_stat_dn": f"extraInfo({payload_eff}_data_MC_uncertainty_stat_dn)",
f"weight_{pid_alias}_eff_{working_point}_sys_up": f"extraInfo({payload_eff}_data_MC_uncertainty_sys_up)",
f"weight_{pid_alias}_eff_{working_point}_sys_dn": f"extraInfo({payload_eff}_data_MC_uncertainty_sys_dn)",
f"weight_{pid_alias}_misid_pi_{working_point}_stat_up": f"extraInfo({payload_misid_pi}_data_MC_uncertainty_stat_up)",
f"weight_{pid_alias}_misid_pi_{working_point}_stat_dn": f"extraInfo({payload_misid_pi}_data_MC_uncertainty_stat_dn)",
f"weight_{pid_alias}_misid_pi_{working_point}_sys_up": f"extraInfo({payload_misid_pi}_data_MC_uncertainty_sys_up)",
f"weight_{pid_alias}_misid_pi_{working_point}_sys_dn": f"extraInfo({payload_misid_pi}_data_MC_uncertainty_sys_dn)",
# These aliases are *relative* variations, so they can be multiplied to the nominal
# to get the varied weight:
#
# w_rel_var_up = (1 + w_up/w_nominal)
# w_rel_var_dn = (1 - w_dn/w_nominal)
#
# w_var_up = w_nominal * w_rel_var_up
# w_var_dn = w_nominal * w_rel_var_dn
f"weight_{pid_alias}_eff_{working_point}_rel_stat_up":
f"formula(1+[extraInfo({payload_eff}_data_MC_uncertainty_stat_up)/extraInfo({payload_eff}_data_MC_ratio)])",
f"weight_{pid_alias}_eff_{working_point}_rel_stat_dn":
f"formula(1-[extraInfo({payload_eff}_data_MC_uncertainty_stat_dn)/extraInfo({payload_eff}_data_MC_ratio)])",
f"weight_{pid_alias}_eff_{working_point}_rel_sys_up":
f"formula(1+[extraInfo({payload_eff}_data_MC_uncertainty_sys_up)/extraInfo({payload_eff}_data_MC_ratio)])",
f"weight_{pid_alias}_eff_{working_point}_rel_sys_dn":
f"formula(1-[extraInfo({payload_eff}_data_MC_uncertainty_sys_dn)/extraInfo({payload_eff}_data_MC_ratio)])",
f"weight_{pid_alias}_misid_pi_{working_point}_rel_stat_up":
f"formula(1+[extraInfo({payload_misid_pi}_data_MC_uncertainty_stat_up)/extraInfo({payload_misid_pi}_data_MC_ratio)])",
f"weight_{pid_alias}_misid_pi_{working_point}_rel_stat_dn":
f"formula(1-[extraInfo({payload_misid_pi}_data_MC_uncertainty_stat_dn)/extraInfo({payload_misid_pi}_data_MC_ratio)])",
f"weight_{pid_alias}_misid_pi_{working_point}_rel_sys_up":
f"formula(1+[extraInfo({payload_misid_pi}_data_MC_uncertainty_sys_up)/extraInfo({payload_misid_pi}_data_MC_ratio)])",
f"weight_{pid_alias}_misid_pi_{working_point}_rel_sys_dn":
f"formula(1-[extraInfo({payload_misid_pi}_data_MC_uncertainty_sys_dn)/extraInfo({payload_misid_pi}_data_MC_ratio)])",
}
if classification == "global":
weight_aliases_to_var.update({
f"weight_{pid_alias}_misid_K_{working_point}": f"extraInfo({payload_misid_K}_data_MC_ratio)",
#
f"weight_{pid_alias}_misid_K_{working_point}_stat_up": f"extraInfo({payload_misid_K}_data_MC_uncertainty_stat_up)",
f"weight_{pid_alias}_misid_K_{working_point}_stat_dn": f"extraInfo({payload_misid_K}_data_MC_uncertainty_stat_dn)",
f"weight_{pid_alias}_misid_K_{working_point}_sys_up": f"extraInfo({payload_misid_K}_data_MC_uncertainty_sys_up)",
f"weight_{pid_alias}_misid_K_{working_point}_sys_dn": f"extraInfo({payload_misid_K}_data_MC_uncertainty_sys_dn)",
#
f"weight_{pid_alias}_misid_K_{working_point}_rel_stat_up":
f"formula(1+[extraInfo({payload_misid_K}_data_MC_uncertainty_stat_up)/extraInfo({payload_misid_K}_data_MC_ratio)])",
f"weight_{pid_alias}_misid_K_{working_point}_rel_stat_dn":
f"formula(1-[extraInfo({payload_misid_K}_data_MC_uncertainty_stat_dn)/extraInfo({payload_misid_K}_data_MC_ratio)])",
f"weight_{pid_alias}_misid_K_{working_point}_rel_sys_up":
f"formula(1+[extraInfo({payload_misid_K}_data_MC_uncertainty_sys_up)/extraInfo({payload_misid_K}_data_MC_ratio)])",
f"weight_{pid_alias}_misid_K_{working_point}_rel_sys_dn":
f"formula(1-[extraInfo({payload_misid_K}_data_MC_uncertainty_sys_dn)/extraInfo({payload_misid_K}_data_MC_ratio)])",
})
for alias, var in weight_aliases_to_var.items():
variables.addAlias(alias, var)
return pid_alias, list(weight_aliases_to_var.keys())
[docs]def stdE(listtype=_defaultlist,
method=None,
classification=None,
lid_weights_gt=None,
release=None,
channel_eff="combination",
channel_misid_pi="combination",
channel_misid_K="combination",
inputListName=None,
outputListLabel=None,
trainingModeMulticlass=_TrainingMode.c_Multiclass,
trainingModeBinary=_TrainingMode.c_Classification,
path=None):
""" Function to prepare one of several standardized types of electron lists.
See the documentation of `stdLep` for details.
It also accepts any of the legacy definitions
for the ``listtype`` parameter (aka ``working_point`` in `stdLep`) to fall back to the `stdCharged` behaviour:
* 'all'
* 'good'
* 'loosepid'
* 'loose'
* 'higheff'
* '95eff'
* '90eff'
* '85eff'
Returns:
tuple(str, list(str)): the alias for the electron ID variable, and the list of aliases for the weights.
"""
if listtype in _stdnames + _effnames:
stdCharged("e", listtype, path)
return _pidnames[_chargednames.index("e")], None
return stdLep(Const.electron.getPDGCode(), listtype, method, classification, lid_weights_gt,
release=release,
channel_eff=channel_eff,
channel_misid_pi=channel_misid_pi,
channel_misid_K=channel_misid_K,
inputListName=inputListName,
outputListLabel=outputListLabel,
trainingModeMulticlass=trainingModeMulticlass,
trainingModeBinary=trainingModeBinary,
path=path)
[docs]def stdMu(listtype=_defaultlist,
method=None,
classification=None,
lid_weights_gt=None,
release=None,
channel_eff="combination",
channel_misid_pi="combination",
channel_misid_K="combination",
inputListName=None,
outputListLabel=None,
trainingModeMulticlass=_TrainingMode.c_Multiclass,
trainingModeBinary=_TrainingMode.c_Classification,
path=None):
""" Function to prepare one of several standardized types of muon lists.
See the documentation of `stdLep` for details.
It also accepts any of the legacy definitions
for the ``listtype`` parameter (aka ``working_point`` in `stdLep`) to fall back to the `stdCharged` behaviour:
* 'all'
* 'good'
* 'loosepid'
* 'loose'
* 'higheff'
* '95eff'
* '90eff'
* '85eff'
Returns:
tuple(str, list(str)): the alias for the muon ID variable, and the list of aliases for the weights.
"""
if listtype in _stdnames + _effnames:
stdCharged("mu", listtype, path)
return _pidnames[_chargednames.index("mu")], None
return stdLep(Const.muon.getPDGCode(), listtype, method, classification, lid_weights_gt,
release=release,
channel_eff=channel_eff,
channel_misid_pi=channel_misid_pi,
channel_misid_K=channel_misid_K,
inputListName=inputListName,
outputListLabel=outputListLabel,
trainingModeMulticlass=trainingModeMulticlass,
trainingModeBinary=trainingModeBinary,
path=path)
[docs]def stdMostLikely(pidPriors=None, suffix='', custom_cuts='', path=None, writeOut=True):
"""
Function to prepare most likely particle lists according to PID likelihood, refer to stdCharged for details
@param pidPriors list of 6 float numbers used to reweight PID likelihoods, for e, mu, pi, K, p and d
@param suffix string added to the end of particle list names
@param custom_cuts custom selection cut string, if empty, standard track quality cuts will be applied
@param path modules are added to this path
@param writeOut whether RootOutput module should save the created ParticleList
"""
# Here we need basic track quality cuts to be applied,
# otherwise, we get a lot of badly reconstructed particles,
# which will end up filled as a random type
args = ''
if pidPriors is not None:
args = str(pidPriors)[1:-1] # remove brackets
trackQuality = 'thetaInCDCAcceptance and nCDCHits>20'
if custom_cuts != '':
trackQuality = custom_cuts
for name in _chargednames:
ma.fillParticleList(f'{name}+:{_mostLikelyList}{suffix}',
f'pidIsMostLikely({args}) > 0 and {trackQuality}', writeOut=writeOut, path=path)
