BaseFakeBkgTool Class Reference

#include <BaseFakeBkgTool.h>

Inheritance diagram for BaseFakeBkgTool:

Classes
struct	UncertaintyList
	List of systematic variations (UID + sigma) to be considered This is implemented as a basic linked list, since unless in very rare cases it should only contain a single entry. More...

Public Member Functions
	BaseFakeBkgTool (const std::string &toolname)
virtual	~BaseFakeBkgTool ()
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual StatusCode	addEvent (const xAOD::IParticleContainer &particles, float extraWeight=1.f) override final
	supply list of leptons / global variables, internal counters incremented Does not return anything; event weight(s) must be retrieved by subsequent call(s) to getEventWeight() (for tools inheriting from ILinearFakeBkgTool)
virtual StatusCode	addEvent (const ConstDataVector< xAOD::IParticleContainer > &particles, float extraWeight=1.f) override final
	supply list of leptons / global variables, internal counters incremented Does not return anything; event weight(s) must be retrieved by subsequent call(s) to getEventWeight() (for tools inheriting from ILinearFakeBkgTool)
virtual StatusCode	register1DHistogram (TH1 *h1, const float *val) override
	associates a 1D histogram to the tool, to obtain a binned estimate of the fake lepton background the 'val' argument points to a variable corresponding to the X axis of the histogram and that needs to be updated before each call to addEvent() undefined behaviour if the pointers are invalidated during the tool's lifetime
virtual StatusCode	register2DHistogram (TH2 *h2, const float *xval, const float *yval) override
	associates a 2D histogram to the tool, to obtain a binned estimate of the fake lepton background the 'xval' / 'yval' arguments point to variables corresponding to the X/Y axis of the histogram and that need to be updated before each call to addEvent() undefined behaviour if the pointers are invalidated during the tool's lifetime
virtual StatusCode	register3DHistogram (TH3 *h3, const float *xval, const float *yval, const float *zval) override
	associates a 3D histogram to the tool, to obtain a binned estimate of the fake lepton background the 'xval' / 'yval' / 'zval' arguments point to variables corresponding to the X/Y/Z axis of the histogram and that need to be updated before each call to addEvent() undefined behaviour if the pointers are invalidated during the tool's lifetime
virtual bool	isAffectedBySystematic (const CP::SystematicVariation &systematic) const override
	Declare the interface that this class provides.
virtual CP::SystematicSet	affectingSystematics () const override
	the list of all systematics this tool can be affected by
virtual CP::SystematicSet	recommendedSystematics () const override
	the list of all systematics this tool recommends to use
virtual StatusCode	applySystematicVariation (const CP::SystematicSet &systConfig) override
	effects: configure this tool for the given list of systematic variations.
virtual CP::SystematicSet	affectingSystematicsFor (const std::string &nuisanceParameter) const override
	These functions are slow, don't use them in the tools implementations.
virtual std::string	getUncertaintyDescription (const CP::SystematicVariation &systematic) const override final
	returns a human-readable description of the source of systematic uncertainty specified as argument
virtual void	printUncertaintyDescription (const CP::SystematicVariation &systematic) const override final
	prints a human-readable description of the source of systematic uncertainty specified as argument
virtual bool	isSystematicUncertainty (const CP::SystematicVariation &systematic) const override final
	checks whether the specified source of uncertainty originates from a systematic uncertainty in the efficiencies (as opposed to statistical)
virtual bool	isStatisticalUncertainty (const CP::SystematicVariation &systematic) const override final
	checks whether the specified source of uncertainty originates from a statistical uncertainty in the efficiencies (as opposed to systematic)
virtual bool	affectsElectrons (const CP::SystematicVariation &systematic) const override final
	checks whether the specified source of uncertainty affects electrons
virtual bool	affectsMuons (const CP::SystematicVariation &systematic) const override final
	checks whether the specified source of uncertainty affects muons
virtual bool	affectsTaus (const CP::SystematicVariation &systematic) const override final
	checks whether the specified source of uncertainty affects taus
virtual bool	affectsRealEfficiencies (const CP::SystematicVariation &systematic) const override final
	checks whether the specified source of uncertainty affects real efficiencies
virtual bool	affectsFakeEfficiencies (const CP::SystematicVariation &systematic) const override final
	checks whether the specified source of uncertainty affects fake efficiencies
virtual bool	affectsFakeFactors (const CP::SystematicVariation &systematic) const override final
	checks whether the specified source of uncertainty affects fake factors
virtual const IFakeBkgSystDescriptor &	getSystDescriptor () const override
	retrieves an interface to various helper methods to identify what the different SystematicVariations correspond to

Protected Member Functions
virtual FakeBkgTools::Client	clientForDB ()=0
	This indicates which type of efficiencies/fake factor need to be filled.
virtual StatusCode	addEventCustom ()=0
FakeBkgTools::FinalState	getCachedFinalState (uint8_t nparticles, const std::string &strPID, const std::string &strProc, bool &success)
std::string	getListOfEfficienciesAffectedBy (uint16_t uid) const
StatusCode	CheckHistogramCompatibility (const TH1 *lhs, const TH1 *rhs)

Protected Attributes
bool	m_initialized = false
bool	m_needEventInfo = true
bool	m_convertWhenMissing = false
std::vector< FakeBkgTools::ParticleData >	m_particles
std::unique_ptr< FakeBkgTools::Database >	m_database
float	m_externalWeight {}
std::hash< std::string >	m_hasher
	comes from Event passed to addEvent()
std::set< FakeBkgTools::FinalState >	m_cachedFinalStates
std::map< TH1 *, const float * >	m_values_1dhisto_map
std::map< TH2 *, std::pair< const float *, const float * > >	m_values_2dhisto_map
std::map< TH3 *, std::tuple< const float *, const float *, const float * > >	m_values_3dhisto_map
std::string	m_selection = defaultSelection()
	'selection' settings used to compute the total yield / fill histograms
std::string	m_process = defaultProcess()
	'process' settings used to compute the total yield / fill histograms
std::string	m_energyUnit
	property EnergyUnit user can choose between MeV or GeV to indicate the unit of the pT parametrization of efficiencies in the input files
bool	m_useDB = true
std::vector< std::string >	m_inputFiles
	property InputFiles
std::string	m_tightDecoNameAndType
	property TightDecoration
CP::ISelectionReadAccessor *	m_tightAccessor = nullptr
	this can't be a unique_ptr as this can cause issues with the dictionary in some particular circumstances
std::string	m_progressFileName
	property ProgressFileName
std::string	m_progressFileDirectory
	property ProgressFileDirectory
UncertaintyList *	m_selectedUncertainties = nullptr
	Pointer to a value of the 'm_systSetDict' map it must be invalidated each time the map is updated in principle only applySystematicVariation() needs to do that.
std::unordered_map< CP::SystematicSet, UncertaintyList >	m_systSetDict
	List of uncertainties in internal format, associated with a particular SystematicSet the m_selectedUncertainties pointer must be invalidated each time this map is updated in principle only applySystematicVariation() needs to do that.
bool	m_unlimitedSystematicVariations = true
	used to prevent multiple calls to applySystematicVariation() when unsupported set to true in a particular tool's constructor to disable the possibility of calling applySystematicVariation() more than once / after the first call to addEvent()
bool	m_lockedSystematicVariations = false
	when m_unlimitedSystematicVariations=false, keeps track of prior calls to applySystematicVariation() / addEvent()
SG::ConstAccessor< float >	m_accRealEff
SG::ConstAccessor< float >	m_accFakeEff
	only used when m_useDB is false

Private Member Functions
template<class C>
StatusCode	addEventImpl (const C &iparticles, float mcWeight)
	only used when m_useDB is false
bool	importEfficiencies (bool resetDB=false)
	load the config file(s) storing efficiencies
std::pair< uint16_t, float >	identifyCpSystematicVariation (const CP::SystematicVariation &systematic) const

Friends
struct	FakeBkgTools::Efficiency

Detailed Description

Definition at line 40 of file BaseFakeBkgTool.h.

Constructor & Destructor Documentation

BaseFakeBkgTool()

BaseFakeBkgTool::BaseFakeBkgTool

(

const std::string &

toolname

)

Definition at line 23 of file BaseFakeBkgTool.cxx.

                                                         :
    AsgTool(toolname),
    m_initialized(false),
    m_database(nullptr),
    m_energyUnit("MeV"),
    m_tightDecoNameAndType("Tight,as_char"),
    m_progressFileName("none"),
    m_progressFileDirectory(""),
    m_accRealEff("real_eff"),
    m_accFakeEff("fake_eff")
{
    declareProperty("InputFiles",
                    m_inputFiles,
                    "list of XML/ROOT files storing the efficiencies [default = {}]. If left empty, the tool "
                    "assumes that efficiencies are provided by the user as decorations (xAOD) or class "
                    "members (standalone) of the lepton objects");
    declareProperty("Selection",
                    m_selection = IFakeBkgTool::defaultSelection(),
                    "Selection used to increment total yield / fill histograms [default = \""
                        + m_selection +"\"]");
    declareProperty("Process",
                    m_process = IFakeBkgTool::defaultProcess(),
                    "Process used to increment total yield / fill histograms [default = \""
                        + m_process +"\"]");
    declareProperty("EnergyUnit",
                    m_energyUnit,
                    "MeV or GeV -- keep consistent between the input (IParticle decorations/members) "
                    "and the configuration files! [default = \"MeV\"]");
    declareProperty("ConvertWhenMissing",
                    m_convertWhenMissing,
                    "set to 'true' to compute fake factors from fake efficiencies if only the latter "
                    "are provided in the config files (and vice-versa) [default = false]");
    declareProperty("TightDecoration",
                    m_tightDecoNameAndType,
                    "Name (and type) of the decoration used to indicate whether leptons pass the 'tight' "
                    "requirements or not [default = \"Tight,as_char\"]");
    declareProperty("ProgressFileName",
                    m_progressFileName,
                    "Name of ntuple file with results from a subset of the data");
    declareProperty("ProgressFileDirectory",
                    m_progressFileDirectory,
                    "complementary to ProgressFileName, specifies the directory inside the file where the "
                    "results are stored [default = \"\"]");
}

~BaseFakeBkgTool()

BaseFakeBkgTool::~BaseFakeBkgTool ( )

virtual

Definition at line 68 of file BaseFakeBkgTool.cxx.

{
    delete m_tightAccessor;
}

Member Function Documentation

addEvent() [1/2]

StatusCode BaseFakeBkgTool::addEvent ( const ConstDataVector< xAOD::IParticleContainer > & particles, float extraWeight = 1.f )

finaloverridevirtual

supply list of leptons / global variables, internal counters incremented Does not return anything; event weight(s) must be retrieved by subsequent call(s) to getEventWeight() (for tools inheriting from ILinearFakeBkgTool)

Implements CP::IFakeBkgTool.

Definition at line 241 of file BaseFakeBkgTool.cxx.

{
    return addEventImpl(iparticles, mcWeight);
}

addEvent() [2/2]

StatusCode BaseFakeBkgTool::addEvent ( const xAOD::IParticleContainer & particles, float extraWeight = 1.f )

finaloverridevirtual

supply list of leptons / global variables, internal counters incremented Does not return anything; event weight(s) must be retrieved by subsequent call(s) to getEventWeight() (for tools inheriting from ILinearFakeBkgTool)

Implements CP::IFakeBkgTool.

Definition at line 236 of file BaseFakeBkgTool.cxx.

{
    return addEventImpl(iparticles, mcWeight);
}

addEventCustom()

virtual StatusCode CP::BaseFakeBkgTool::addEventCustom ( )

protectedpure virtual

addEventImpl()

template<class C>

StatusCode BaseFakeBkgTool::addEventImpl ( const C & iparticles, float mcWeight )

private

only used when m_useDB is false

prevent further calls to applySystematicVariation() if not allowed

only retrieved if some of the efficiency parameters are event-level!

for standalone compilation, pp is already a reference and the * operator is redefined to a no-op so that this works

Definition at line 172 of file BaseFakeBkgTool.cxx.

{
    if(!m_initialized)
    {
         ATH_MSG_WARNING("the tool hasn't been initialized");
        return StatusCode::FAILURE;
    }
    m_particles.clear();
    if(!m_unlimitedSystematicVariations) m_lockedSystematicVariations = true; 
 
    const xAOD::EventInfo* eventInfo = nullptr; 
    if(m_needEventInfo)
    {
      #ifdef FAKEBKGTOOLS_ATLAS_ENVIRONMENT
        ATH_CHECK( evtStore()->retrieve(eventInfo, "EventInfo") );
      #else
        eventInfo = &iparticles.eventInfo;
      #endif
    }
    
    for(const auto& pp : iparticles)
    {
        const auto& p = *pp; 
        m_particles.emplace_back();
        auto& d = m_particles.back();
        d.tight = m_tightAccessor->getBool(p);
        d.type = p.type();
        switch(p.type())
        {
            case xAOD::Type::Electron: d.charge = static_cast<const xAOD::Electron&>(p).charge(); break;
            case xAOD::Type::Muon: d.charge = static_cast<const xAOD::Muon&>(p).charge(); break;
            case xAOD::Type::Tau: d.charge = static_cast<const xAOD::TauJet&>(p).charge(); break;
            case xAOD::Type::Photon: d.charge = 0; break;
            default:
                ATH_MSG_WARNING("unknown particle type, setting charge to 0");
                d.charge = 0;
        }
        if(m_useDB)
        {
            std::string error;
            if(!m_database->fillEfficiencies(d, p, eventInfo, error))
            {
                ATH_MSG_ERROR("unable to retrieve efficiencies: " << error);
                return StatusCode::FAILURE;
            }
            ATH_MSG_DEBUG("particle has fake fact. = " << d.fake_factor.value(this) <<", fake eff. = " << d.fake_efficiency.value(this) <<", real eff. = " << d.real_efficiency.value(this));
        }
        else
        {
            d.real_efficiency.nominal = m_accRealEff(p);
            d.fake_efficiency.nominal = m_accFakeEff(p);
        }
    }
    if(m_particles.size() > maxParticles())
    {
        ATH_MSG_WARNING( "the input contains " << m_particles.size() << " particles but the maximum allowed is " << maxParticles()
            << "; the last " << (m_particles.size()-maxParticles()) << " will be ignored");
        m_particles.erase(m_particles.begin() + maxParticles(), m_particles.end());
    }
    m_externalWeight = mcWeight;
    ATH_MSG_DEBUG("calling addEventCustom() with #particles = " << m_particles.size());
    return addEventCustom();
}

affectingSystematics()

CP::SystematicSet BaseFakeBkgTool::affectingSystematics ( ) const

overridevirtual

the list of all systematics this tool can be affected by

Implements CP::IReentrantSystematicsTool.

Definition at line 436 of file BaseFakeBkgTool.cxx.

{
    if(!m_initialized || !m_database)
    {
        ATH_MSG_ERROR("This function can be called only once the tool has been initialized, since the number of systematic variations depends on the configuration...");
        throw std::logic_error("BaseFakeBkgTool::affectingSystematics() called before initialization");
    }
    CP::SystematicSet affecting;
    for(int step=0;step<2;++step)
    {
        std::string type = step? "STAT" : "SYST";
        const int imax = step? m_database->numberOfStats() : m_database->numberOfSysts();
        for(int i=0;i<imax;++i)
        {
            std::string name = "FAKEBKG_" + type + "_VAR" + std::to_string(i);
            affecting.insert(CP::SystematicVariation(name, 1.f));
            affecting.insert(CP::SystematicVariation(name, -1.f));
        }
    }
    return affecting;
}

affectingSystematicsFor()

CP::SystematicSet BaseFakeBkgTool::affectingSystematicsFor ( const std::string & nuisanceParameter ) const

overridevirtual

These functions are slow, don't use them in the tools implementations.

Implements CP::IFakeBkgSystDescriptor.

Definition at line 613 of file BaseFakeBkgTool.cxx.

{
    CP::SystematicSet affecting;
    if(!m_initialized || !m_database)
    {
        ATH_MSG_ERROR("This function can be called only once the tool has been initialized, since the number of systematic variations depends on the configuration...");
        return {};
    }
    bool up=true, down=true;
    auto pos1=nuisanceParameter.find("__up"), pos2=nuisanceParameter.find("__down");
    if(pos1!=std::string::npos && pos1+4==nuisanceParameter.length()) down = false;
    else if(pos2!=std::string::npos && pos2+6==nuisanceParameter.length()) up = false;
    std::string np = nuisanceParameter.substr(0, std::min(pos1, pos2));
    for(unsigned i=0;i<m_database->numberOfSysts();++i)
    {
        auto syst = m_database->findSyst(m_database->systIndexToUID(i));
        if(syst && syst->name==np)
        {
            std::string name = "FAKEBKG_SYST_VAR" + std::to_string(i);
            if(up) affecting.insert(CP::SystematicVariation(name, 1.f));
            if(down) affecting.insert(CP::SystematicVariation(name, -1.f));
        }
    }
    return affecting;
}

affectsElectrons()

bool BaseFakeBkgTool::affectsElectrons ( const CP::SystematicVariation & systematic ) const

finaloverridevirtual

checks whether the specified source of uncertainty affects electrons

Implements CP::IFakeBkgSystDescriptor.

Definition at line 571 of file BaseFakeBkgTool.cxx.

{
    uint16_t UID = identifyCpSystematicVariation(systematic).first;
    if(UID) return getListOfEfficienciesAffectedBy(UID).find("electron") != std::string::npos;
    return false;
}

affectsFakeEfficiencies()

bool BaseFakeBkgTool::affectsFakeEfficiencies ( const CP::SystematicVariation & systematic ) const

finaloverridevirtual

checks whether the specified source of uncertainty affects fake efficiencies

Implements CP::IFakeBkgSystDescriptor.

Definition at line 599 of file BaseFakeBkgTool.cxx.

{
    uint16_t UID = identifyCpSystematicVariation(systematic).first;
    if(UID) return getListOfEfficienciesAffectedBy(UID).find("fake eff") != std::string::npos;
    return false;
}

affectsFakeFactors()

bool BaseFakeBkgTool::affectsFakeFactors ( const CP::SystematicVariation & systematic ) const

finaloverridevirtual

checks whether the specified source of uncertainty affects fake factors

Implements CP::IFakeBkgSystDescriptor.

Definition at line 606 of file BaseFakeBkgTool.cxx.

{
    uint16_t UID = identifyCpSystematicVariation(systematic).first;
    if(UID) return getListOfEfficienciesAffectedBy(UID).find("fake factor") != std::string::npos;
    return false;
}

affectsMuons()

bool BaseFakeBkgTool::affectsMuons ( const CP::SystematicVariation & systematic ) const

finaloverridevirtual

checks whether the specified source of uncertainty affects muons

Implements CP::IFakeBkgSystDescriptor.

Definition at line 578 of file BaseFakeBkgTool.cxx.

{
    uint16_t UID = identifyCpSystematicVariation(systematic).first;
    if(UID) return getListOfEfficienciesAffectedBy(UID).find("muon") != std::string::npos;
    return false;
}

affectsRealEfficiencies()

bool BaseFakeBkgTool::affectsRealEfficiencies ( const CP::SystematicVariation & systematic ) const

finaloverridevirtual

checks whether the specified source of uncertainty affects real efficiencies

Implements CP::IFakeBkgSystDescriptor.

Definition at line 592 of file BaseFakeBkgTool.cxx.

{
    uint16_t UID = identifyCpSystematicVariation(systematic).first;
    if(UID) return getListOfEfficienciesAffectedBy(UID).find("real eff") != std::string::npos;
    return false;
}

affectsTaus()

bool BaseFakeBkgTool::affectsTaus ( const CP::SystematicVariation & systematic ) const

finaloverridevirtual

checks whether the specified source of uncertainty affects taus

Implements CP::IFakeBkgSystDescriptor.

Definition at line 585 of file BaseFakeBkgTool.cxx.

{
    uint16_t UID = identifyCpSystematicVariation(systematic).first;
    if(UID) return getListOfEfficienciesAffectedBy(UID).find("tau") != std::string::npos;
    return false;
}

applySystematicVariation()

StatusCode BaseFakeBkgTool::applySystematicVariation ( const CP::SystematicSet & systConfig )

overridevirtual

effects: configure this tool for the given list of systematic variations.

any requested systematics that are not affecting this tool will be silently ignored (unless they cause other errors). failures: systematic unknown failures: requesting multiple variations on the same systematic (e.g. up & down) failures: requesting an unsupported variation on an otherwise supported systematic (e.g. a 2 sigma variation and the tool only supports 1 sigma variations) failures: unsupported combination of supported systematic failures: other tool specific errors

prevent further calls to applySystematicVariation() if not allowed

Implements CP::ISystematicsTool.

Definition at line 463 of file BaseFakeBkgTool.cxx.

{
    if(!m_initialized || !m_database)
    {
        ATH_MSG_ERROR("This function can be called only once the tool has been initialized");
        throw std::logic_error("BaseFakeBkgTool::applySystematicVariation() called before initialization");
    }
    if(m_lockedSystematicVariations)
    {
        ATH_MSG_ERROR("this particular method doesn't support multiple calls to applySystematicVariation(), or after the first call to addEvent(). Please use a separate instance of the tool for each variation.");
        throw std::logic_error("BaseFakeBkgTool::applySystematicVariation() called at a wrong time");
    }
    else if(!m_unlimitedSystematicVariations) m_lockedSystematicVariations = true; 
    if(!systConfig.size())
    {
        m_selectedUncertainties = nullptr;    
        return StatusCode::SUCCESS;
    }
    auto itr = m_systSetDict.find(systConfig);
    if(itr != m_systSetDict.end())
    {
        m_selectedUncertainties = &itr->second;
        return StatusCode::SUCCESS;
    }
    CP::SystematicSet mysys;
    auto sc = CP::SystematicSet::filterForAffectingSystematics(systConfig, affectingSystematics(), mysys);
    if(sc != StatusCode::SUCCESS) return sc;
    std::unique_ptr<UncertaintyList> uncertainties;
    for(auto& sysvar : mysys)
    {
        auto var = identifyCpSystematicVariation(sysvar);
        if(!var.first)
        {
            ATH_MSG_ERROR("The systematic variation " << sysvar.name() << " is not recognized, despite being present in affectingSystematics()...");
            return StatusCode::FAILURE;
        }
        if(!uncertainties) uncertainties.reset(new UncertaintyList(var.first, var.second));
        else uncertainties->extraVariation(var.first, var.second);
    }
    if(uncertainties)
    {
        auto emplaced = m_systSetDict.emplace(systConfig, std::move(*uncertainties));
        m_selectedUncertainties = &emplaced.first->second;
    }
    else m_selectedUncertainties = nullptr;
    return StatusCode::SUCCESS;
}

CheckHistogramCompatibility()

StatusCode BaseFakeBkgTool::CheckHistogramCompatibility ( const TH1 * lhs, const TH1 * rhs )

protected

Definition at line 357 of file BaseFakeBkgTool.cxx.

{
    std::string error;
    if(std::string(lhs->GetName()) != rhs->GetName()) error = "names";
    else if(lhs->GetDimension() != rhs->GetDimension()) error = "dimensions";
    else if(lhs->GetNbinsX()!=rhs->GetNbinsX() || lhs->GetNbinsY()!=rhs->GetNbinsY() || lhs->GetNbinsZ()!=rhs->GetNbinsZ()) error = "number of bins";
    else
    {
        for(auto getAxis : std::initializer_list<const TAxis*(TH1::*)()const>{&TH1::GetXaxis, &TH1::GetYaxis, &TH1::GetZaxis})
        {
            auto lhsAxis=(lhs->*getAxis)(), rhsAxis=(rhs->*getAxis)();
            for(int i=0;i<=lhsAxis->GetNbins();++i)
            {
                auto x=lhsAxis->GetBinUpEdge(i), y=rhsAxis->GetBinUpEdge(i), width=lhsAxis->GetBinWidth(i?i:1);
                if(std::fabs(x-y) > 0.01*width) error = "bin edges";
            }
        }
    }
    if(error.length())
    {
        ATH_MSG_ERROR("the registered histogram \"" << lhs->GetName() << "\" is not compatible with the one saved in the in-progress ROOT file (mismatching " << error << "). Or, you tried registering two different histograms with the same name.");
        return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
}

clientForDB()

Client BaseFakeBkgTool::clientForDB ( )

protectedpure virtual

This indicates which type of efficiencies/fake factor need to be filled.

Definition at line 73 of file BaseFakeBkgTool.cxx.

{
    return Client::NONE;
}

getCachedFinalState()

FinalState BaseFakeBkgTool::getCachedFinalState ( uint8_t nparticles, const std::string & strPID, const std::string & strProc, bool & success )

protected

no longer fill cache if it becomes too large

Definition at line 246 of file BaseFakeBkgTool.cxx.

{
    success = true;
    size_t hFS = m_hasher(strProc) ^ m_hasher(strPID) ^ nparticles;
    auto itrFS = m_cachedFinalStates.find(FinalState(hFS));
    if(itrFS != m_cachedFinalStates.end()) return *itrFS;
    std::string error;
    FinalState fs(hFS, nparticles, strPID, strProc, error);
    if(error.length())
    {
        ATH_MSG_ERROR(error);
        success = false;
        return FinalState(0);
    }
    if(m_cachedFinalStates.size() < 1024) 
    {
        m_cachedFinalStates.emplace(fs);
    }
    return fs;
}

getListOfEfficienciesAffectedBy()

std::string BaseFakeBkgTool::getListOfEfficienciesAffectedBy ( uint16_t uid ) const

protected

Definition at line 383 of file BaseFakeBkgTool.cxx.

{
    if(!m_initialized || !m_database)
    {
        ATH_MSG_ERROR("This function can be called only once the tool has been initialized");
        return "";
    }
    std::bitset<Database::N_EFFICIENCY_TYPES> affects;
    auto stat = m_database->findStat(uid);
    if(stat) affects = stat->affects;
    else
    {
        auto syst = m_database->findSyst(uid);
        if(syst) affects = syst->affects;
        else
        {
            ATH_MSG_ERROR("uncertainty with UID " << std::hex << uid << std::dec << " not found in database");
            return "";
        }
    }
    std::string info;
    if(affects[Database::ELECTRON_REAL_EFFICIENCY]) info += "electron real efficiencies, ";
    if(affects[Database::ELECTRON_FAKE_EFFICIENCY]) info += "electron fake efficiencies, ";
    if(affects[Database::ELECTRON_FAKE_FACTOR]) info += "electron fake factors, ";
    if(affects[Database::MUON_REAL_EFFICIENCY]) info += "muon real efficiencies, ";
    if(affects[Database::MUON_FAKE_EFFICIENCY]) info += "muon fake efficiencies, ";
    if(affects[Database::MUON_FAKE_FACTOR]) info += "muon fake factors, ";
    if(affects[Database::PHOTON_ELE_FAKE_FACTOR]) info += "electron->photon fake rate, ";
    if(affects[Database::PHOTON_ELE_FAKE_FACTOR_SF]) info += "electron->photon fake rate scale factor, ";
    return info.substr(0, info.size()-2);
}

getSystDescriptor()

virtual const IFakeBkgSystDescriptor & CP::BaseFakeBkgTool::getSystDescriptor ( ) const

inlineoverridevirtual

retrieves an interface to various helper methods to identify what the different SystematicVariations correspond to

Implements CP::IFakeBkgTool.

Definition at line 74 of file BaseFakeBkgTool.h.

{return *this; }

getUncertaintyDescription()

std::string BaseFakeBkgTool::getUncertaintyDescription ( const CP::SystematicVariation & systematic ) const

finaloverridevirtual

returns a human-readable description of the source of systematic uncertainty specified as argument

need to add more info (bin index, etc)

Implements CP::IFakeBkgSystDescriptor.

Definition at line 517 of file BaseFakeBkgTool.cxx.

{
    if(!m_initialized || !m_database)
    {
        ATH_MSG_ERROR("This function can be called only once the tool has been initialized");
        return "";
    }
    
    auto UID = identifyCpSystematicVariation(systematic).first;
    if(!UID) 
    {
        ATH_MSG_WARNING("Systematic variation " + systematic.name() + " is not recognized by BaseFakeBkgTool");
        return "";
    }
    
    //UID cannot be zero here
    std::string info;
    auto stat = m_database->findStat(UID);
    if(stat)
    {
        info = "Statistical uncertainty affecting ";
    }
    else
    {
        auto syst = m_database->findSyst(UID);
        if(syst)
        {
            info = "Systematic uncertainty \"" + syst->name + "\" affecting ";
        }
        else
        {
            ATH_MSG_ERROR("uncertainty with UID " << std::hex << UID << std::dec << " not found in database");
            return "";
        }
    }
    info += getListOfEfficienciesAffectedBy(UID);
    return info;
}

identifyCpSystematicVariation()

std::pair< uint16_t, float > BaseFakeBkgTool::identifyCpSystematicVariation ( const CP::SystematicVariation & systematic ) const

private

Definition at line 415 of file BaseFakeBkgTool.cxx.

{
    if(!m_initialized || !m_database)
    {
        ATH_MSG_ERROR("This function can be called only once the tool has been initialized, since the number of systematic variations depends on the configuration...");
        throw std::logic_error("BaseFakeBkgTool::identifyCpSystematicVariation() called before initialization");
    }
    std::smatch smr;
    auto bn = systematic.basename();
    if(!std::regex_match(bn, smr, std::regex("FAKEBKG_(STAT|SYST)_VAR(\\d+)")))  return {{0}, 0.f};
    unsigned index = std::stol(smr[2].str());
    float sigma = systematic.parameter();
    if(smr[1].str() == "SYST") return {m_database->systIndexToUID(index), sigma};
    else return {m_database->statIndexToUID(index), sigma};
}

importEfficiencies()

bool BaseFakeBkgTool::importEfficiencies ( bool resetDB = false )

private

load the config file(s) storing efficiencies

XML parsing error

ROOT histograms importing error, or unknown error

Definition at line 125 of file BaseFakeBkgTool.cxx.

{
    if(resetDB) m_database->reset();
    std::string filename;
    try
    {
        for(const auto& fn : m_inputFiles)
        {
            filename = PathResolverFindDataFile(fn);
            auto pos = filename.rfind(".xml");
            if(pos == filename.length()-4)
            {
                m_database->importXML(filename);
                continue;
            }
            pos = filename.rfind(".root");
            if(pos == filename.length()-5)
            {
                m_database->importDefaultROOT(fn);
                continue;
            }
            ATH_MSG_ERROR("File extension not supported for " << filename);
            return false;
        }
    }
    catch(const Database::XmlError& err) 
    {
        unsigned line1 = m_database->getXmlLineNumber(err.location.ptr);
        unsigned line2 = m_database->getXmlLineNumber(err.location.endptr);
        ATH_MSG_INFO("Exception caught while reading file " << filename << ", details follow");
        std::string fullmsg = "(while parsing XML, line";
        if(line2 != line1) fullmsg += "s " + std::to_string(line1) + " - " + std::to_string(line2);
        else fullmsg += " " + std::to_string(line1);
        fullmsg +=  "): " +  err.reason;
        ATH_MSG_ERROR(fullmsg);
        return false;
    }
    catch(const Database::GenericError& err) 
    {
        ATH_MSG_INFO("Exception caught while reading file " << filename << ", details follow");
        ATH_MSG_ERROR(err.reason);
        return false;
    }
    return m_database->ready();
}

initialize()

StatusCode BaseFakeBkgTool::initialize ( )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 78 of file BaseFakeBkgTool.cxx.

{
    if(m_initialized)
    {
        ATH_MSG_WARNING("the tool has already been initialized successfully");
        return StatusCode::FAILURE;
    }
    
    m_useDB = m_inputFiles.size();
 
    
    bool useGeV;
    if(m_energyUnit == "MeV" || m_energyUnit == "MEV") useGeV = false;
    else if(m_energyUnit == "GeV" || m_energyUnit == "GEV" ) useGeV = true;
    else
    {
        ATH_MSG_ERROR("unrecognized energy unit \"" << m_energyUnit << '"');
        return StatusCode::FAILURE;
    }
    
    std::unique_ptr<CP::ISelectionReadAccessor> tightAccessor;
    ATH_CHECK(CP::makeSelectionReadAccessor(m_tightDecoNameAndType, tightAccessor));
    m_tightAccessor = tightAccessor.release();
    
    if(!m_useDB)
    {
        ATH_MSG_WARNING("no input file(s) provided with the reference efficiencies, will try reading the efficiencies directly from the IParticle");
    }
    
    if(m_useDB && clientForDB()!=Client::NONE)
    {
        auto db = new Database(clientForDB(), useGeV, m_convertWhenMissing);
        if(!db) return StatusCode::FAILURE;
        m_database = std::unique_ptr<Database>(db);
        if(!importEfficiencies(true)){
          ATH_MSG_ERROR("importEfficiencies failed!");
          return StatusCode::FAILURE;
        }
        m_needEventInfo = db->needEventInfo();
    }
    else m_needEventInfo = false;
    
    m_initialized = true;
    
    return StatusCode::SUCCESS;
}

isAffectedBySystematic()

bool BaseFakeBkgTool::isAffectedBySystematic ( const CP::SystematicVariation & systematic ) const

overridevirtual

Declare the interface that this class provides.

returns: whether this tool is affected by the given systematics

Implements CP::ISystematicsTool.

Definition at line 431 of file BaseFakeBkgTool.cxx.

{
    return identifyCpSystematicVariation(systematic).first;
}

isStatisticalUncertainty()

bool BaseFakeBkgTool::isStatisticalUncertainty ( const CP::SystematicVariation & systematic ) const

finaloverridevirtual

checks whether the specified source of uncertainty originates from a statistical uncertainty in the efficiencies (as opposed to systematic)

Implements CP::IFakeBkgSystDescriptor.

Definition at line 564 of file BaseFakeBkgTool.cxx.

{
    uint16_t UID = identifyCpSystematicVariation(systematic).first;
    if(UID) return Database::isStatUID(UID);
    return false;
}

isSystematicUncertainty()

bool BaseFakeBkgTool::isSystematicUncertainty ( const CP::SystematicVariation & systematic ) const

finaloverridevirtual

checks whether the specified source of uncertainty originates from a systematic uncertainty in the efficiencies (as opposed to statistical)

Implements CP::IFakeBkgSystDescriptor.

Definition at line 557 of file BaseFakeBkgTool.cxx.

{
    uint16_t UID = identifyCpSystematicVariation(systematic).first;
    if(UID) return Database::isSystUID(UID);
    return false;
}

printUncertaintyDescription()

void BaseFakeBkgTool::printUncertaintyDescription ( const CP::SystematicVariation & systematic ) const

finaloverridevirtual

prints a human-readable description of the source of systematic uncertainty specified as argument

Implements CP::IFakeBkgSystDescriptor.

Definition at line 511 of file BaseFakeBkgTool.cxx.

{
    auto info = getUncertaintyDescription(systematic);
    if(info.length()) ATH_MSG_INFO(info);
}

recommendedSystematics()

CP::SystematicSet BaseFakeBkgTool::recommendedSystematics ( ) const

overridevirtual

the list of all systematics this tool recommends to use

Implements CP::IReentrantSystematicsTool.

Definition at line 458 of file BaseFakeBkgTool.cxx.

{
    return affectingSystematics();
}

register1DHistogram()

StatusCode BaseFakeBkgTool::register1DHistogram ( TH1 * h1, const float * val )

overridevirtual

associates a 1D histogram to the tool, to obtain a binned estimate of the fake lepton background the 'val' argument points to a variable corresponding to the X axis of the histogram and that needs to be updated before each call to addEvent() undefined behaviour if the pointers are invalidated during the tool's lifetime

Implements CP::IFakeBkgTool.

Definition at line 267 of file BaseFakeBkgTool.cxx.

                                                                         {
 
    if(!h1)
    {
        ATH_MSG_ERROR("invalid histogram pointer");
        return StatusCode::FAILURE;
    }
    const std::string name = h1->GetName();
    auto itr = m_values_1dhisto_map.begin();
    const auto enditr = m_values_1dhisto_map.end(); 
    for(;itr!=enditr;++itr)
    {
        if(itr->first == h1)
        {
            ATH_MSG_ERROR("the histogram \"" << name << "\" has already been registered");
            return StatusCode::FAILURE;
        }
        if(name == itr->first->GetName()) break;
    }
    if(itr == enditr)
    {
      m_values_1dhisto_map.emplace(h1, val);
    }
    else
    {
        ATH_CHECK( CheckHistogramCompatibility(h1, itr->first) );
    }
    return StatusCode::SUCCESS;
}

register2DHistogram()

StatusCode BaseFakeBkgTool::register2DHistogram ( TH2 * h2, const float * xval, const float * yval )

overridevirtual

associates a 2D histogram to the tool, to obtain a binned estimate of the fake lepton background the 'xval' / 'yval' arguments point to variables corresponding to the X/Y axis of the histogram and that need to be updated before each call to addEvent() undefined behaviour if the pointers are invalidated during the tool's lifetime

Implements CP::IFakeBkgTool.

Definition at line 297 of file BaseFakeBkgTool.cxx.

                                                                                             {
 
    if(!h2)
    {
        ATH_MSG_ERROR("invalid histogram pointer");
        return StatusCode::FAILURE;
    }
    const std::string name = h2->GetName();
    auto itr = m_values_2dhisto_map.begin();
    const auto enditr = m_values_2dhisto_map.end(); 
    for(;itr!=enditr;++itr)
    {
        if(itr->first == h2)
        {
            ATH_MSG_ERROR("the histogram \"" << name << "\" has already been registered");
            return StatusCode::FAILURE;
        }
        if(name == itr->first->GetName()) break;
    }
    if(itr == enditr)
    {
      m_values_2dhisto_map.emplace(h2, std::make_pair(xval, yval));
    }
    else
    {
        ATH_CHECK( CheckHistogramCompatibility(h2, itr->first) );
    }
    return StatusCode::SUCCESS;
}

register3DHistogram()

StatusCode BaseFakeBkgTool::register3DHistogram ( TH3 * h3, const float * xval, const float * yval, const float * zval )

overridevirtual

associates a 3D histogram to the tool, to obtain a binned estimate of the fake lepton background the 'xval' / 'yval' / 'zval' arguments point to variables corresponding to the X/Y/Z axis of the histogram and that need to be updated before each call to addEvent() undefined behaviour if the pointers are invalidated during the tool's lifetime

Implements CP::IFakeBkgTool.

Definition at line 327 of file BaseFakeBkgTool.cxx.

                                                                                                                                {
 
    if(!h3)
    {
        ATH_MSG_ERROR("invalid histogram pointer");
        return StatusCode::FAILURE;
    }
    const std::string name = h3->GetName();
    auto itr = m_values_3dhisto_map.begin();
    const auto enditr = m_values_3dhisto_map.end(); 
    for(;itr!=enditr;++itr)
    {
        if(itr->first == h3)
        {
            ATH_MSG_ERROR("the histogram \"" << name << "\" has already been registered");
            return StatusCode::FAILURE;
        }
        if(name == itr->first->GetName()) break;
    }
    if(itr == enditr)
    {
m_values_3dhisto_map.emplace(h3, std::make_tuple(xval, yval, zval));
    }
    else
    {
        ATH_CHECK( CheckHistogramCompatibility(h3, itr->first) );
    }
    return StatusCode::SUCCESS;
}

Friends And Related Symbol Documentation

FakeBkgTools::Efficiency

friend struct FakeBkgTools::Efficiency

friend

Definition at line 187 of file BaseFakeBkgTool.h.

Member Data Documentation

m_accFakeEff

SG::ConstAccessor<float> CP::BaseFakeBkgTool::m_accFakeEff

protected

only used when m_useDB is false

Definition at line 177 of file BaseFakeBkgTool.h.

m_accRealEff

SG::ConstAccessor<float> CP::BaseFakeBkgTool::m_accRealEff

protected

Definition at line 175 of file BaseFakeBkgTool.h.

m_cachedFinalStates

std::set<FakeBkgTools::FinalState> CP::BaseFakeBkgTool::m_cachedFinalStates

protected

Definition at line 99 of file BaseFakeBkgTool.h.

m_convertWhenMissing

bool CP::BaseFakeBkgTool::m_convertWhenMissing = false

protected

Definition at line 80 of file BaseFakeBkgTool.h.

m_database

std::unique_ptr<FakeBkgTools::Database> CP::BaseFakeBkgTool::m_database

protected

Definition at line 91 of file BaseFakeBkgTool.h.

m_energyUnit

std::string CP::BaseFakeBkgTool::m_energyUnit

protected

property EnergyUnit user can choose between MeV or GeV to indicate the unit of the pT parametrization of efficiencies in the input files

Definition at line 122 of file BaseFakeBkgTool.h.

m_externalWeight

float CP::BaseFakeBkgTool::m_externalWeight {}

protected

Definition at line 95 of file BaseFakeBkgTool.h.

{}; 

m_hasher

std::hash<std::string> CP::BaseFakeBkgTool::m_hasher

protected

comes from Event passed to addEvent()

Definition at line 97 of file BaseFakeBkgTool.h.

m_initialized

bool CP::BaseFakeBkgTool::m_initialized = false

protected

Definition at line 78 of file BaseFakeBkgTool.h.

m_inputFiles

std::vector<std::string> CP::BaseFakeBkgTool::m_inputFiles

protected

property InputFiles

Definition at line 127 of file BaseFakeBkgTool.h.

m_lockedSystematicVariations

bool CP::BaseFakeBkgTool::m_lockedSystematicVariations = false

protected

when m_unlimitedSystematicVariations=false, keeps track of prior calls to applySystematicVariation() / addEvent()

Definition at line 173 of file BaseFakeBkgTool.h.

m_needEventInfo

bool CP::BaseFakeBkgTool::m_needEventInfo = true

protected

Definition at line 79 of file BaseFakeBkgTool.h.

m_particles

std::vector<FakeBkgTools::ParticleData> CP::BaseFakeBkgTool::m_particles

protected

Definition at line 85 of file BaseFakeBkgTool.h.

m_process

std::string CP::BaseFakeBkgTool::m_process = defaultProcess()

protected

'process' settings used to compute the total yield / fill histograms

Definition at line 118 of file BaseFakeBkgTool.h.

m_progressFileDirectory

std::string CP::BaseFakeBkgTool::m_progressFileDirectory

protected

property ProgressFileDirectory

Definition at line 139 of file BaseFakeBkgTool.h.

m_progressFileName

std::string CP::BaseFakeBkgTool::m_progressFileName

protected

property ProgressFileName

Definition at line 136 of file BaseFakeBkgTool.h.

m_selectedUncertainties

UncertaintyList* CP::BaseFakeBkgTool::m_selectedUncertainties = nullptr

protected

Pointer to a value of the 'm_systSetDict' map it must be invalidated each time the map is updated in principle only applySystematicVariation() needs to do that.

Definition at line 161 of file BaseFakeBkgTool.h.

m_selection

std::string CP::BaseFakeBkgTool::m_selection = defaultSelection()

protected

'selection' settings used to compute the total yield / fill histograms

Definition at line 115 of file BaseFakeBkgTool.h.

m_systSetDict

std::unordered_map<CP::SystematicSet, UncertaintyList> CP::BaseFakeBkgTool::m_systSetDict

protected

List of uncertainties in internal format, associated with a particular SystematicSet the m_selectedUncertainties pointer must be invalidated each time this map is updated in principle only applySystematicVariation() needs to do that.

Definition at line 166 of file BaseFakeBkgTool.h.

m_tightAccessor

CP::ISelectionReadAccessor* CP::BaseFakeBkgTool::m_tightAccessor = nullptr

protected

this can't be a unique_ptr as this can cause issues with the dictionary in some particular circumstances

Definition at line 133 of file BaseFakeBkgTool.h.

m_tightDecoNameAndType

std::string CP::BaseFakeBkgTool::m_tightDecoNameAndType

protected

property TightDecoration

Definition at line 130 of file BaseFakeBkgTool.h.

m_unlimitedSystematicVariations

bool CP::BaseFakeBkgTool::m_unlimitedSystematicVariations = true

protected

used to prevent multiple calls to applySystematicVariation() when unsupported set to true in a particular tool's constructor to disable the possibility of calling applySystematicVariation() more than once / after the first call to addEvent()

Definition at line 170 of file BaseFakeBkgTool.h.

m_useDB

bool CP::BaseFakeBkgTool::m_useDB = true

protected

Definition at line 124 of file BaseFakeBkgTool.h.

m_values_1dhisto_map

std::map<TH1*, const float*> CP::BaseFakeBkgTool::m_values_1dhisto_map

protected

Definition at line 108 of file BaseFakeBkgTool.h.

m_values_2dhisto_map

std::map<TH2*, std::pair<const float*, const float*> > CP::BaseFakeBkgTool::m_values_2dhisto_map

protected

Definition at line 109 of file BaseFakeBkgTool.h.

m_values_3dhisto_map

std::map<TH3*, std::tuple<const float*, const float*, const float*> > CP::BaseFakeBkgTool::m_values_3dhisto_map

protected

Definition at line 110 of file BaseFakeBkgTool.h.

---

The documentation for this class was generated from the following files:

• BaseFakeBkgTool.h
• BaseFakeBkgTool.cxx