stdPi0s.py

#!/usr/bin/env python3
 

 
import modularAnalysis as ma
from stdPhotons import stdPhotons
from vertex import kFit
from basf2 import B2WARNING
 
 
def stdPi0s(
            listtype="eff60_May2020",
            path=None,
            beamBackgroundMVAWeight="",
            fakePhotonMVAWeight="",
            biasCorrectionTable="",
            writeOut=True
        ):
    """
    Function to prepare one of several standardized types of pi0 lists.
 
    The following lists are **deprecated** and will be removed at the end of 2026:
 
    - 'all' using gamma:all, no cuts
    - 'eff10_May2020' gamma:pi0eff10_May2020, mass range selection, 10% pi0 efficiency list, optimized in May 2020
    - 'eff20_May2020' gamma:pi0eff20_May2020, mass range selection, 20% pi0 efficiency list, optimized in May 2020
    - 'eff30_May2020' gamma:pi0eff30_May2020, mass range selection, 30% pi0 efficiency list, optimized in May 2020
    - 'eff40_May2020' gamma:pi0eff40_May2020, mass range selection, 40% pi0 efficiency list, optimized in May 2020
    - 'eff50_May2020' gamma:pi0eff50_May2020, mass range selection, 50% pi0 efficiency list, optimized in May 2020
    - 'eff60_May2020' gamma:pi0eff60_May2020, mass range selection, 60% pi0 efficiency list, optimized in May 2020
 
    You can also append "Fit" to the effXX listtype which will run a mass fit and
    require that the fit did not fail. For example: "pi0:eff50_May2020Fit" is the 50%
    efficiency list plus a not-failing mass fit.
    These Fit variants are also deprecated, fits with mass constraint can be performed manually when necessary.
 
    .. deprecated:: light-2604-jellyfish
        All list types in this function are deprecated and will be removed at the end of 2026.
        Please use ``reconstructDecay`` directly with an appropriate selection optimised for your analysis.
        Refer to the :ref:`b2help-recommendation` tool
        (web version: `Performance Recommendations <https://belle2.pages.desy.de/performance/recommendations/>`_)
        for guidance. To provide feedback on the removal, see
        `work item #11641 <https://gitlab.desy.de/belle2/software/basf2/-/work_items/11641>`_.
 
    Parameters:
        listtype (str): name of standard list
        path (basf2.Path): modules are added to this path
        beamBackgroundMVAWeight (str): type of weight file for beam background MVA; if empty, beam background MVA will not be used
 
                          .. tip::
                              Please refer to the
                              `Performance Recommendations <https://belle2.pages.desy.de/performance/recommendations/>`_
                              for information on the beam background MVA.
 
        fakePhotonMVAWeight (str): type of weight file for fake photon MVA; if empty, fake photon MVA will not be used
 
                          .. tip::
                              Please refer to the
                              `Performance Recommendations <https://belle2.pages.desy.de/performance/recommendations/>`_
                              for information on the fake photon MVA.
 
        biasCorrectionTable (str): correction table for the photon energy bias correction (should only be applied to data)
 
                          .. tip::
                              Please refer to the
                              `Performance Recommendations <https://belle2.pages.desy.de/performance/recommendations/>`_
                              for information on the names of available correction tables.
 
        writeOut (bool): whether RootOutput module should save the created ParticleList
 
    """
 
    _deprecated_pi0_lists = {
        'all', 'allFit',
        'eff10_May2020', 'eff20_May2020', 'eff30_May2020',
        'eff40_May2020', 'eff50_May2020', 'eff60_May2020',
        'eff50_May2020_nomcmatch', 'eff60_May2020_nomcmatch',
        'eff10_May2020Fit', 'eff20_May2020Fit', 'eff30_May2020Fit',
        'eff40_May2020Fit', 'eff50_May2020Fit', 'eff60_May2020Fit',
    }
    if listtype in _deprecated_pi0_lists:
        B2WARNING(
            f"The standard pi0 list 'pi0:{listtype}' is deprecated "
            "and will be removed at the end of 2026. "
            "Please use reconstructDecay directly with an appropriate selection optimised for your analysis. "
            "To provide feedback on the removal, see "
            "https://gitlab.desy.de/belle2/software/basf2/-/work_items/11641"
        )
 
    if listtype == 'all':
        stdPhotons('all', path, beamBackgroundMVAWeight, fakePhotonMVAWeight, biasCorrectionTable)
        ma.reconstructDecay('pi0:all -> gamma:all gamma:all', '', 1, writeOut=writeOut, path=path)
        ma.matchMCTruth('pi0:all', path)
    elif 'eff10_May2020' == listtype:
        stdPhotons('pi0eff10_May2020', path, beamBackgroundMVAWeight, fakePhotonMVAWeight, biasCorrectionTable)
        ma.reconstructDecay('pi0:eff10_May2020 -> gamma:pi0eff10_May2020 gamma:pi0eff10_May2020',
                            '0.127<InvM<0.139 and -0.9<daughterDiffOf(0,1,phi)<0.9 and daughterAngle(0,1)<0.8',
                            1,
                            writeOut=writeOut,
                            path=path)
        ma.matchMCTruth('pi0:eff10_May2020', path)
    elif 'eff20_May2020' == listtype:
        stdPhotons('pi0eff20_May2020', path, beamBackgroundMVAWeight, fakePhotonMVAWeight, biasCorrectionTable)
        ma.reconstructDecay('pi0:eff20_May2020 -> gamma:pi0eff20_May2020 gamma:pi0eff20_May2020',
                            '0.121<InvM<0.142 and -1.0<daughterDiffOf(0,1,phi)<1.0 and daughterAngle(0,1)<0.9',
                            1,
                            writeOut=writeOut,
                            path=path)
        ma.matchMCTruth('pi0:eff20_May2020', path)
    elif 'eff30_May2020' == listtype:
        stdPhotons('pi0eff30_May2020', path, beamBackgroundMVAWeight, fakePhotonMVAWeight, biasCorrectionTable)
        ma.reconstructDecay('pi0:eff30_May2020 -> gamma:pi0eff30_May2020 gamma:pi0eff30_May2020',
                            '0.120<InvM<0.145 and -1.5<daughterDiffOf(0,1,phi)<1.5 and daughterAngle(0,1)<1.4',
                            1,
                            writeOut=writeOut,
                            path=path)
        ma.matchMCTruth('pi0:eff30_May2020', path)
    elif 'eff40_May2020' == listtype:
        stdPhotons('pi0eff40_May2020', path, beamBackgroundMVAWeight, fakePhotonMVAWeight, biasCorrectionTable)
        ma.reconstructDecay('pi0:eff40_May2020 -> gamma:pi0eff40_May2020 gamma:pi0eff40_May2020',
                            '0.120<InvM<0.145', 1, writeOut=writeOut, path=path)
        ma.matchMCTruth('pi0:eff40_May2020', path)
    elif 'eff50_May2020_nomcmatch' == listtype:
        stdPhotons('pi0eff50_May2020', path, beamBackgroundMVAWeight, fakePhotonMVAWeight, biasCorrectionTable)
        ma.reconstructDecay(
            'pi0:eff50_May2020_nomcmatch -> gamma:pi0eff50_May2020 gamma:pi0eff50_May2020',
            '0.105<InvM<0.150',
            1,
            writeOut=writeOut,
            path=path)
    elif 'eff50_May2020' == listtype:
        stdPi0s('eff50_May2020_nomcmatch', path, beamBackgroundMVAWeight, fakePhotonMVAWeight)
        ma.cutAndCopyList('pi0:eff50_May2020', 'pi0:eff50_May2020_nomcmatch', '', writeOut=writeOut, path=path)
        ma.matchMCTruth('pi0:eff50_May2020', path)
    elif 'eff60_May2020_nomcmatch' == listtype:
        stdPhotons('pi0eff60_May2020', path, beamBackgroundMVAWeight, fakePhotonMVAWeight, biasCorrectionTable)
        ma.reconstructDecay(
            'pi0:eff60_May2020_nomcmatch -> gamma:pi0eff60_May2020 gamma:pi0eff60_May2020',
            '0.03<InvM',
            1,
            writeOut=writeOut,
            path=path)
    elif 'eff60_May2020' == listtype:
        stdPi0s('eff60_May2020_nomcmatch', path, beamBackgroundMVAWeight, fakePhotonMVAWeight)
        ma.cutAndCopyList('pi0:eff60_May2020', 'pi0:eff60_May2020_nomcmatch', '', writeOut=writeOut, path=path)
        ma.matchMCTruth('pi0:eff60_May2020', path)
 
    # skim list(s)
    elif listtype == 'skim':
        stdPi0s('eff50_May2020_nomcmatch', path, beamBackgroundMVAWeight, fakePhotonMVAWeight)
        ma.cutAndCopyList('pi0:skim', 'pi0:eff50_May2020_nomcmatch', '', writeOut=writeOut, path=path)
        kFit('pi0:skim', 0.0, 'mass', path=path)
    elif listtype == 'SkimHighEff':
        stdPi0s('eff60_May2020_nomcmatch', path, beamBackgroundMVAWeight, fakePhotonMVAWeight)
        ma.cutAndCopyList('pi0:SkimHighEff', 'pi0:eff60_May2020_nomcmatch', '', writeOut=writeOut, path=path)
        kFit('pi0:SkimHighEff', 0.0, 'mass', path=path)
 
    # same lists with, but with  mass constraints fits
    elif listtype == 'allFit':
        stdPi0s('all', path, beamBackgroundMVAWeight, fakePhotonMVAWeight)
        ma.cutAndCopyList('pi0:allFit', 'pi0:all', '', writeOut=writeOut, path=path)
        kFit('pi0:allFit', 0.0, 'mass', path=path)
    elif listtype == 'eff10_May2020Fit':
        stdPi0s('eff10_May2020', path, beamBackgroundMVAWeight, fakePhotonMVAWeight)
        ma.cutAndCopyList('pi0:eff10_May2020Fit', 'pi0:eff10_May2020', '', writeOut=writeOut, path=path)
        kFit('pi0:eff10_May2020Fit', 0.0, 'mass', path=path)
    elif listtype == 'eff20_May2020Fit':
        stdPi0s('eff20_May2020', path, beamBackgroundMVAWeight, fakePhotonMVAWeight)
        ma.cutAndCopyList('pi0:eff20_May2020Fit', 'pi0:eff20_May2020', '', writeOut=writeOut, path=path)
        kFit('pi0:eff20_May2020Fit', 0.0, 'mass', path=path)
    elif listtype == 'eff30_May2020Fit':
        stdPi0s('eff30_May2020', path, beamBackgroundMVAWeight, fakePhotonMVAWeight)
        ma.cutAndCopyList('pi0:eff30_May2020Fit', 'pi0:eff30_May2020', '', writeOut=writeOut, path=path)
        kFit('pi0:eff30_May2020Fit', 0.0, 'mass', path=path)
    elif listtype == 'eff40_May2020Fit':
        stdPi0s('eff40_May2020', path, beamBackgroundMVAWeight, fakePhotonMVAWeight)
        ma.cutAndCopyList('pi0:eff40_May2020Fit', 'pi0:eff40_May2020', '', writeOut=writeOut, path=path)
        kFit('pi0:eff40_May2020Fit', 0.0, 'mass', path=path)
    elif listtype == 'eff50_May2020Fit':
        stdPi0s('eff50_May2020', path, beamBackgroundMVAWeight, fakePhotonMVAWeight)
        ma.cutAndCopyList('pi0:eff50_May2020Fit', 'pi0:eff50_May2020', '', writeOut=writeOut, path=path)
        kFit('pi0:eff50_May2020Fit', 0.0, 'mass', path=path)
    elif listtype == 'eff60_May2020Fit':
        stdPi0s('eff60_May2020', path, beamBackgroundMVAWeight, fakePhotonMVAWeight)
        ma.cutAndCopyList('pi0:eff60_May2020Fit', 'pi0:eff60_May2020', '', writeOut=writeOut, path=path)
        kFit('pi0:eff60_May2020Fit', 0.0, 'mass', path=path)
    else:
        raise ValueError(f"\"{listtype}\" is none of the allowed standardized types of pi0 lists!")
 
# pi0 list(s) for skims (and ONLY for skims)
 
 
def loadStdSkimPi0(path):
    """
    Function to prepare the skim pi0 lists.
 
    Warning:
        Should only be used by skims.
 
    Parameters:
        path (basf2.Path) modules are added to this path
 
    """
    stdPi0s('skim', path)
 
 
def loadStdSkimHighEffPi0(path):
    """
    Function to prepare the high-efficiency skim pi0 lists based on eff60_May2020 list.
 
    Warning:
        Should only be used by skims.
 
    Parameters:
        path (basf2.Path) modules are added to this path
 
    """
    stdPi0s('SkimHighEff', path)