CP::ApplyFakeFactor Class Reference

#include <ApplyFakeFactor.h>

Inheritance diagram for CP::ApplyFakeFactor:

Collaboration diagram for CP::ApplyFakeFactor:

Public Member Functions
	ApplyFakeFactor (const std::string &name)
	Standard constructor. More...
	~ApplyFakeFactor ()
	Standard destructor. More...
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function. More...
virtual StatusCode	getEventWeight (float &weight, const std::string &selection, const std::string &process) override final
	returns an event weight addEvent() must have been called before hand. More...
virtual StatusCode	getTotalYield (float &yield, float &statErrorUp, float &statErrorDown) override final
	returns the accumulated fake lepton background yield (or compute it, in the case of the likelihood matrix method), and fills the registered histograms (if any) The 'selection' and 'process' settings used for these operations can be chosen with the 'Selection' and 'Process' properties. More...
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 More...
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 More...
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 More...
StatusCode	assignYieldRange (TH1 *h)
virtual StatusCode	saveProgress (TDirectory *dir) override
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) More...
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) More...
virtual bool	isAffectedBySystematic (const CP::SystematicVariation &systematic) const override
	Declare the interface that this class provides. More...
virtual CP::SystematicSet	affectingSystematics () const override
	the list of all systematics this tool can be affected by More...
virtual CP::SystematicSet	recommendedSystematics () const override
	the list of all systematics this tool recommends to use More...
virtual StatusCode	applySystematicVariation (const CP::SystematicSet &systConfig) override
	effects: configure this tool for the given list of systematic variations. More...
virtual CP::SystematicSet	affectingSystematicsFor (const std::string &nuisanceParameter) const override
	These functions are slow, don't use them in the tools implementations. More...
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 More...
virtual void	printUncertaintyDescription (const CP::SystematicVariation &systematic) const override final
	prints a human-readable description of the source of systematic uncertainty specified as argument More...
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) More...
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) More...
virtual bool	affectsElectrons (const CP::SystematicVariation &systematic) const override final
	checks whether the specified source of uncertainty affects electrons More...
virtual bool	affectsMuons (const CP::SystematicVariation &systematic) const override final
	checks whether the specified source of uncertainty affects muons More...
virtual bool	affectsTaus (const CP::SystematicVariation &systematic) const override final
	checks whether the specified source of uncertainty affects taus More...
virtual bool	affectsRealEfficiencies (const CP::SystematicVariation &systematic) const override final
	checks whether the specified source of uncertainty affects real efficiencies More...
virtual bool	affectsFakeEfficiencies (const CP::SystematicVariation &systematic) const override final
	checks whether the specified source of uncertainty affects fake efficiencies More...
virtual bool	affectsFakeFactors (const CP::SystematicVariation &systematic) const override final
	checks whether the specified source of uncertainty affects fake factors More...
virtual const IFakeBkgSystDescriptor &	getSystDescriptor () const override
	retrieves an interface to various helper methods to identify what the different SystematicVariations correspond to More...
virtual void	print () const =0
	Print the state of the tool. More...
virtual void	print () const
	Print the state of the tool. More...
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static constexpr const char *	defaultSelection ()
	default value taken by the 'selection' argument of several methods or properties It indicates how the analysis selects leptons in the signal region The syntax supported for this arguments is described in the package documentation. More...
static constexpr const char *	defaultProcess ()
	default value taken by the 'process' argument of several methods or properties It indicates what should be treated as fake lepton background. More...

Protected Member Functions
virtual StatusCode	addEventCustom () override
virtual StatusCode	getEventWeightCustom (FakeBkgTools::Weight &weight, const FakeBkgTools::FinalState &fs) override
virtual FakeBkgTools::Client	clientForDB () override final
	This indicates which type of efficiencies/fake factor need to be filled. More...
StatusCode	incrementTotalYield ()
	be sure to only call this once per event! (typically at the end of addEvent()) More...
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)
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Protected Attributes
std::vector< FakeBkgTools::Yield >	m_yields
	accumulated yield for all events (and histogram bins with uncertainties) More...
std::map< FakeBkgTools::FinalState, FakeBkgTools::Weight >	m_cachedWeights
	cached weight+uncertainties for a single event Each tool derived from this base class MUST clear the map in addEventCustom()! More...
std::map< TH1 *, std::pair< uint32_t, uint32_t > >	m_histogramYieldsRange
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() More...
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 More...
std::string	m_process = defaultProcess()
	'process' settings used to compute the total yield / fill histograms More...
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 More...
bool	m_useDB = true
std::vector< std::string >	m_inputFiles
	property InputFiles More...
std::string	m_tightDecoNameAndType
	property TightDecoration More...
CP::ISelectionReadAccessor *	m_tightAccessor = nullptr
	this can't be a unique_ptr as this can cause issues with the dictionary in some particular circumstances More...
std::string	m_progressFileName
	property ProgressFileName More...
std::string	m_progressFileDirectory
	property ProgressFileDirectory More...
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. More...
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. More...
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() More...
bool	m_lockedSystematicVariations = false
	when m_unlimitedSystematicVariations=false, keeps track of prior calls to applySystematicVariation() / addEvent() More...
SG::ConstAccessor< float >	m_accRealEff
SG::ConstAccessor< float >	m_accFakeEff
	only used when m_useDB is false More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
bool	eventSatisfiesCriteria (const FakeBkgTools::FinalState &fs, unsigned long &expectedTightLeptonsBitset)
StatusCode	getEventWeightCommon (FakeBkgTools::Weight &weight, const std::string &selection, const std::string &process)
StatusCode	mergeSubjobs ()
template<class C >
StatusCode	addEventImpl (const C &iparticles, float mcWeight)
	only used when m_useDB is false More...
bool	importEfficiencies (bool resetDB=false)
	load the config file(s) storing efficiencies More...
std::pair< uint16_t, float >	identifyCpSystematicVariation (const CP::SystematicVariation &systematic) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 21 of file ApplyFakeFactor.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

ApplyFakeFactor()

ApplyFakeFactor::ApplyFakeFactor

(

const std::string &

name

)

Standard constructor.

Definition at line 15 of file ApplyFakeFactor.cxx.

                                                      :
  BaseLinearFakeBkgTool(name)
{
}

~ApplyFakeFactor()

ApplyFakeFactor::~ApplyFakeFactor

(

)

Standard destructor.

Definition at line 23 of file ApplyFakeFactor.cxx.

{
}

Member Function Documentation

addEvent() [1/2]

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

finaloverridevirtualinherited

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 243 of file BaseFakeBkgTool.cxx.

{
    return addEventImpl(iparticles, mcWeight);
}

addEvent() [2/2]

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

finaloverridevirtualinherited

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 238 of file BaseFakeBkgTool.cxx.

{
    return addEventImpl(iparticles, mcWeight);
}

addEventCustom()

StatusCode ApplyFakeFactor::addEventCustom ( )

overrideprotectedvirtual

Implements CP::BaseFakeBkgTool.

Definition at line 37 of file ApplyFakeFactor.cxx.

{
  m_cachedWeights.clear();
 
  return incrementTotalYield();
}

addEventImpl()

template<class C >

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

privateinherited

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 174 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

overridevirtualinherited

the list of all systematics this tool can be affected by

Implements CP::IReentrantSystematicsTool.

Definition at line 438 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

overridevirtualinherited

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

Implements CP::IFakeBkgSystDescriptor.

Definition at line 618 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

finaloverridevirtualinherited

checks whether the specified source of uncertainty affects electrons

Implements CP::IFakeBkgSystDescriptor.

Definition at line 576 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

finaloverridevirtualinherited

checks whether the specified source of uncertainty affects fake efficiencies

Implements CP::IFakeBkgSystDescriptor.

Definition at line 604 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

finaloverridevirtualinherited

checks whether the specified source of uncertainty affects fake factors

Implements CP::IFakeBkgSystDescriptor.

Definition at line 611 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

finaloverridevirtualinherited

checks whether the specified source of uncertainty affects muons

Implements CP::IFakeBkgSystDescriptor.

Definition at line 583 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

finaloverridevirtualinherited

checks whether the specified source of uncertainty affects real efficiencies

Implements CP::IFakeBkgSystDescriptor.

Definition at line 597 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

finaloverridevirtualinherited

checks whether the specified source of uncertainty affects taus

Implements CP::IFakeBkgSystDescriptor.

Definition at line 590 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 )

overridevirtualinherited

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 465 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;
}

assignYieldRange()

StatusCode BaseLinearFakeBkgTool::assignYieldRange ( TH1 *  h )

inherited

Definition at line 142 of file BaseLinearFakeBkgTool.cxx.

{
    const std::string histname = h->GetName();
    std::pair<uint32_t, uint32_t> range;
    for(auto itr=m_histogramYieldsRange.begin();itr!=m_histogramYieldsRange.end();++itr)
    {
        if(histname != itr->first->GetName()) continue;
        range = itr->second;
        m_histogramYieldsRange.erase(itr);
        m_histogramYieldsRange.emplace(h, range);
        return StatusCode::SUCCESS;
    }
    range.first = m_yields.size();
    m_yields.insert(m_yields.end(), std::max(1, h->GetNcells()), FakeBkgTools::Yield{});
    range.second = m_yields.size() - 1;
    m_histogramYieldsRange.emplace(h, range);
    return StatusCode::SUCCESS;
}

CheckHistogramCompatibility()

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

protectedinherited

Definition at line 359 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()

FakeBkgTools::Client ApplyFakeFactor::clientForDB ( )

finaloverrideprotectedvirtual

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

Implements CP::BaseFakeBkgTool.

Definition at line 27 of file ApplyFakeFactor.cxx.

{
    return FakeBkgTools::Client::FAKE_FACTOR;
}

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleKeyArrayType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleKeyType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
  }

declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t, const SG::NotHandleType &    )

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                 {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

defaultProcess()

static constexpr const char* CP::IFakeBkgTool::defaultProcess ( )

inlinestaticconstexprinherited

default value taken by the 'process' argument of several methods or properties It indicates what should be treated as fake lepton background.

The syntax supported for this arguments is described in the package documentation.

Definition at line 38 of file IFakeBkgTool.h.

{ return ">=1F[T]"; }

defaultSelection()

static constexpr const char* CP::IFakeBkgTool::defaultSelection ( )

inlinestaticconstexprinherited

default value taken by the 'selection' argument of several methods or properties It indicates how the analysis selects leptons in the signal region The syntax supported for this arguments is described in the package documentation.

Definition at line 33 of file IFakeBkgTool.h.

{ return "0!T"; }

detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

eventSatisfiesCriteria()

bool ApplyFakeFactor::eventSatisfiesCriteria ( const FakeBkgTools::FinalState &  fs, unsigned long &  expectedTightLeptonsBitset  )

private

Definition at line 133 of file ApplyFakeFactor.cxx.

                                                                                                                       {
  
  // fill bitset for tight leptons
  FakeBkgTools::FSBitset tights(0);
  unsigned int ipart = 0;
  for(FakeBkgTools::ParticleData& particle : m_particles){
 
    if(particle.tight){
      tights.set(ipart);
    }
 
    ++ipart;
  }
  
  // the logic is following: the event is accepted only if there's at least one "turn a loose lepton into tight" operation that gives the wanted final state
  FakeBkgTools::FSBitset charges = fs.retrieveCharges(m_particles); // could also use the code above instead, if it is need for other purposes
  unsigned int nValidCombinations = 0; // count the number of different possible+acceptable final states obtained by changing loose leptons into tight
  const unsigned long nc = (1<<m_particles.size());
  for(unsigned long c=0;c<nc;++c) // loop over all possible combinations for n leptons
  {
    auto newtights = FakeBkgTools::FSBitset(c);
    if(!fs.accept_selection(newtights, charges)){
      ATH_MSG_DEBUG("eventSatisfiesCriteria: failed selection");
      continue; // discard unwanted combinations (including charge requirements)
    }
    
    // if no loose lepton has been "upgraded", not a valid combination:
    if((newtights | tights) == tights){
      ATH_MSG_DEBUG("eventSatisfiesCriteria: newtights|tights == tights. newtights is " << newtights << " while tights is " << tights);
      continue;
    }
    // also, the combination can't have tight leptons "downgraded" to loose:
    if((newtights&tights) != tights){
      ATH_MSG_DEBUG("eventSatisfiesCriteria: newtights&tights != tights. newtights is " << newtights << " while tights is " << tights);
      continue;
    }
    ++nValidCombinations;
    expectedTightLeptonsBitset = c;
  }
 
  if(!nValidCombinations) return false;
  if(nValidCombinations > 1) // if > 1, would need to modify getEventWeight() to sum over all different combinations, I think
  {
    ATH_MSG_ERROR("this type of selection/process is currently not supported by the fake factor method");
    return false;
  }
  // process argument ignored for the moment. Should probably make sure that nothing exotic was requested. 
 
  return true;
}

evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase &  ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

getCachedFinalState()

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

protectedinherited

no longer fill cache if it becomes too large

Definition at line 248 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;
}

getEventWeight()

StatusCode BaseLinearFakeBkgTool::getEventWeight ( float &  weight, const std::string &  selection, const std::string &  process  )

finaloverridevirtualinherited

returns an event weight addEvent() must have been called before hand.

Can be called several times for the same event, possibly with different arguments. The 'selection' argument indicates how the analysis selects leptons in the signal region The 'process' argument indicates what should be treated as fake lepton background. The syntax supported for these two arguments is described in the package documentation. The extraWeight argument specified to addEvent() is NOT included in the returned weight.

Implements CP::ILinearFakeBkgTool.

Definition at line 39 of file BaseLinearFakeBkgTool.cxx.

{
    FakeBkgTools::Weight w;
    auto sc = getEventWeightCommon(w, selection, process);
    weight = w.value(this);
    return sc;
}

getEventWeightCommon()

StatusCode BaseLinearFakeBkgTool::getEventWeightCommon ( FakeBkgTools::Weight &  weight, const std::string &  selection, const std::string &  process  )

privateinherited

Definition at line 47 of file BaseLinearFakeBkgTool.cxx.

{
    if(!m_initialized)
    {
         ATH_MSG_WARNING("the tool hasn't been initialized");
        return StatusCode::FAILURE;
    }
    weight.uncertainties.clear();
    bool success = true;
    auto fs = getCachedFinalState(m_particles.size(), selection, process, success);
    if(!success) return StatusCode::FAILURE;
    auto itr = m_cachedWeights.find(fs);
    if(itr != m_cachedWeights.end())
    {
        weight = itr->second;
        return StatusCode::SUCCESS;
    }
    auto sc = getEventWeightCustom(weight, fs);
    if(sc != StatusCode::SUCCESS) return sc;
    m_cachedWeights.emplace(fs, weight);
    return StatusCode::SUCCESS;
}

getEventWeightCustom()

StatusCode ApplyFakeFactor::getEventWeightCustom ( FakeBkgTools::Weight &  weight, const FakeBkgTools::FinalState &  fs  )

overrideprotectedvirtual

Implements CP::BaseLinearFakeBkgTool.

Definition at line 44 of file ApplyFakeFactor.cxx.

                                                                             {
 
  ATH_MSG_DEBUG("entering getEventWeight");
 
  // for the FF, we can handle the following (e.g. for a 2L final state):
  // N_LT, N_TL, N_LL
  // but not N_RR, N_FR, etc. (other than via the MC for N_RR)
  // and not N_TT, since this is part of what we want to estimate
  //
  // in general, we want to compute N_TT^{RF,FR,FF} = N_TT - N_TT^{RR}
  // which might need to be coded up as its own string
  //
  // maybe we want to only allow strProc == ">=1F"
 
  // reset initial values since they will be multiplied by
  // each lepton's FF and rel uncertainty 
  outputEventWeight.nominal = 1;
  outputEventWeight.uncertainties.clear();
 
  // check if the event satisfies the selection of interest
  // e.g. LT vs. TL, SS events, etc.
  unsigned long expectedTightLeptonsBitset = 0;
  if(!eventSatisfiesCriteria(fs, expectedTightLeptonsBitset)){
 
    ATH_MSG_DEBUG("event failed eventSatisfiesCriteria");
 
    // for an inappropriate event for our desired selection, 
    // return a weight of 0 and uncertainties of 0
    outputEventWeight.nominal = 0;
 
    // quit now, since the event does not satisfy our selection
    return StatusCode::SUCCESS;
  }
 
  ATH_MSG_DEBUG("event passed eventSatisfiesCriteria!");
 
  // in principle m_particles may also include baseline, 
  // but we only want to have loose and tight at this stage!
  // User must *only* pass loose and tight leptons to the tool
  unsigned int nLooseLeps = 0;
  unsigned int ipart = 0;
  const FakeBkgTools::FSBitset newtights(expectedTightLeptonsBitset);
 
  for(FakeBkgTools::ParticleData& particle : m_particles){
 
    // only antiID (loose) leptons need an FF applied
    if(particle.tight) continue;
    if(!newtights[ipart++]) continue; // only multiply fake factors from loose leptons that are supposed to be tight in the wanted final state
 
    // FIXME when we load in the FFs, need to allow for e.g. pT, eta binning and arbitrary parameterizations
    float FF_value = particle.fake_factor.nominal;
    ATH_MSG_DEBUG("FF_value is " << FF_value);
    outputEventWeight.nominal *= FF_value;
    for(auto const& particleUncPair : particle.fake_factor.uncertainties){
 
      float FF_abs_err_up = particleUncPair.second.up;
      float FF_abs_err_down  = particleUncPair.second.down;
 
      float FF_rel_err_up = FF_abs_err_up / fabs(FF_value);
      float FF_rel_err_down = FF_abs_err_down / fabs(FF_value);
 
      // note that these are all relative uncertainties at this stage
      auto& unc =  outputEventWeight.uncertainties.emplace(particleUncPair.first, FakeBkgTools::Uncertainty{1.f, 1.f}).first->second;
      unc.up *= (1+FF_rel_err_up);
      unc.down *= (1-FF_rel_err_down);
    }
    ++nLooseLeps;
    // nLooseLeps will only count loose leptons "upgraded" to tight.
  }
 
  // Subtraction for double counting of events with two antiID leptons
  // which have had a FF applied, to "promote" them to a tight lepton.
  // It turns out this is true for all even multiplicities.
  if(nLooseLeps % 2 == 0){
    outputEventWeight.nominal *= -1;
  }
  
 
  for(auto& eventUncPair : outputEventWeight.uncertainties){
    eventUncPair.second.up = (eventUncPair.second.up - 1.f) * outputEventWeight.nominal;
    eventUncPair.second.down = (1.f - eventUncPair.second.down) * outputEventWeight.nominal;
  }
 
  ATH_MSG_DEBUG("outputEventWeight.nominal is " << outputEventWeight.nominal);
 
  return StatusCode::SUCCESS;
}

getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void *  ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

getListOfEfficienciesAffectedBy()

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

protectedinherited

Definition at line 385 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);
}

getName()

const std::string & asg::AsgTool::getName ( const void *  ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

getProperty()

template<class T >

const T* asg::AsgTool::getProperty ( const std::string &  name ) const

inherited

Get one of the tool's properties.

getSystDescriptor()

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

inlineoverridevirtualinherited

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; }

getTotalYield()

StatusCode BaseLinearFakeBkgTool::getTotalYield ( float &  yield, float &  statErrorUp, float &  statErrorDown  )

finaloverridevirtualinherited

returns the accumulated fake lepton background yield (or compute it, in the case of the likelihood matrix method), and fills the registered histograms (if any) The 'selection' and 'process' settings used for these operations can be chosen with the 'Selection' and 'Process' properties.

Only statistical uncertainties can be retrieved; use applySystematicVariation() to obtain uncertainties

Implements CP::IFakeBkgTool.

Definition at line 70 of file BaseLinearFakeBkgTool.cxx.

{
    if(!m_initialized)
    {
         ATH_MSG_WARNING("the tool hasn't been initialized");
        return StatusCode::FAILURE;
    }
    if(m_progressFileName.length() && m_progressFileName != "none")
    {
        ATH_CHECK( mergeSubjobs() );
    }
    auto& total = m_yields.at(0);
    yield = total.value(this);
    yieldStatErrorUp = sqrt(total.stat2.up);
    yieldStatErrorDown = sqrt(total.stat2.down);
    for(auto& kv : m_histogramYieldsRange)
    {
        for(int i=0;i<kv.first->GetNcells();++i)
        {
            auto& thisYield = m_yields.at(kv.second.first + i);
            kv.first->SetBinContent(i, thisYield.value(this));
            kv.first->SetBinError(i, thisYield.stat());
        }
    }
    return StatusCode::SUCCESS;
}

getUncertaintyDescription()

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

finaloverridevirtualinherited

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 519 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 "";
    }
    
    if(UID == 0)
    {
        return "Total statistical uncertainty in the event yield";
    }
    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

privateinherited

Definition at line 417 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 )

privateinherited

load the config file(s) storing efficiencies

XML parsing error

ROOT histograms importing error, or unknown error

Definition at line 127 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();
}

incrementTotalYield()

StatusCode BaseLinearFakeBkgTool::incrementTotalYield ( )

protectedinherited

be sure to only call this once per event! (typically at the end of addEvent())

note: we multiply by m_externalWeight which means that it is NOT included in m_eventWeight

Definition at line 97 of file BaseLinearFakeBkgTool.cxx.

{
    FakeBkgTools::Weight eventWeight;
    ATH_CHECK( getEventWeightCommon(eventWeight, m_selection, m_process) );
    m_yields.at(0).add(eventWeight, m_externalWeight);
    for(auto& kv : m_values_1dhisto_map)
    {
        unsigned index = m_histogramYieldsRange.at(kv.first).first + kv.first->FindBin(*kv.second);
        m_yields.at(index).add(eventWeight, m_externalWeight);
    }
    for(auto& kv : m_values_2dhisto_map)
    {
        unsigned index = m_histogramYieldsRange.at(kv.first).first + kv.first->FindBin(*kv.second.first, *kv.second.second);
        m_yields.at(index).add(eventWeight, m_externalWeight);
    }
    for(auto& kv : m_values_3dhisto_map)
    {
      unsigned index = m_histogramYieldsRange.at(kv.first).first + kv.first->FindBin(*std::get<0>(kv.second), *std::get<1>(kv.second), *std::get<2>(kv.second));
        m_yields.at(index).add(eventWeight, m_externalWeight);
    }
    return StatusCode::SUCCESS;
}

initialize()

StatusCode ApplyFakeFactor::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 CP::BaseLinearFakeBkgTool.

Definition at line 32 of file ApplyFakeFactor.cxx.

{
  return BaseLinearFakeBkgTool::initialize();
}

inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

isAffectedBySystematic()

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

overridevirtualinherited

Declare the interface that this class provides.

returns: whether this tool is affected by the given systematics

Implements CP::ISystematicsTool.

Definition at line 433 of file BaseFakeBkgTool.cxx.

{
    return identifyCpSystematicVariation(systematic).first;
}

isStatisticalUncertainty()

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

finaloverridevirtualinherited

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 569 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

finaloverridevirtualinherited

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 562 of file BaseFakeBkgTool.cxx.

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

mergeSubjobs()

StatusCode BaseLinearFakeBkgTool::mergeSubjobs ( )

privateinherited

To do: check that the registered histograms are compatible with the saved ones for that, will just need to list the histograms in the directory and call register1/2DHistogram(), where the checks are made.

histogram not registered? don't load the data

Definition at line 222 of file BaseLinearFakeBkgTool.cxx.

{
    std::string filename = PathResolverFindDataFile(m_progressFileName);
 
    auto file = std::unique_ptr<TFile>(TFile::Open(filename.c_str(), "READ"));
    if(!file)
    {
        ATH_MSG_ERROR("Unable to open the file specified for the \"ProgressFileName\" property: " << m_progressFileName);
        return StatusCode::FAILURE;
    }
    std::string path = ::savedYieldsKey;
    if(m_progressFileDirectory.length())
    {
       path = m_progressFileDirectory + "/" + path;
    }
    auto tree = static_cast<TTree*>(file->Get(path.c_str()));
    if(!tree)
    {
        ATH_MSG_ERROR("Unable to find the tree \"" << path << "\" in the input file " << m_progressFileName);
        return StatusCode::FAILURE;
    }
    
    
    std::hash<std::string> hasher;
    std::map<std::size_t, decltype(m_histogramYieldsRange.cbegin())> dictionary;
    for(auto itr=m_histogramYieldsRange.cbegin();itr!=m_histogramYieldsRange.cend();++itr)
    {
        dictionary[hasher(itr->first->GetName())] = itr;
    }
    
    ULong64_t histname = 0;
    UInt_t bin=0, n=0;
    float nominal, stat2Up, stat2Down;
    const std::size_t maxSize = m_database->numberOfStats() + m_database->numberOfSysts();
    std::unique_ptr<UShort_t[]> systUID(new UShort_t[maxSize]);
    std::unique_ptr<float[]> systUp(new float[maxSize]), systDown(new float[maxSize]);
    tree->SetBranchStatus("*", kTRUE);
    tree->SetBranchAddress("Name", &histname);
    tree->SetBranchAddress("Bin", &bin);
    tree->SetBranchAddress("nominal", &nominal);
    tree->SetBranchAddress("stat2Up", &stat2Up);
    tree->SetBranchAddress("stat2Down", &stat2Down);
    tree->SetBranchAddress("N", &n);
    TBranch* branch = tree->FindBranch("N");
    tree->SetBranchAddress("systUID", systUID.get());    
    tree->SetBranchAddress("systUp", systUp.get());
    tree->SetBranchAddress("systDown", systDown.get());
    
    std::set<std::size_t> filledHistograms;
    const long entries = tree->GetEntries();
    for(long entry=0;entry<entries;++entry)
    {
        branch->GetEntry(entry);
        if(n > maxSize)
        {
            ATH_MSG_ERROR("the tool configuration seems to have changed (number of systematics)!");
            return StatusCode::FAILURE;
        }
        tree->GetEntry(entry);
        
        long index;
        if(histname != 0)
        {
            auto itr = dictionary.find(histname);
            if(itr == dictionary.end()) continue; 
            filledHistograms.emplace(histname);
            const TH1* h = itr->second->first;
            const auto& range = itr->second->second;
            if(bin > (range.second - range.first))
            {
                ATH_MSG_ERROR("inconsistent binnings found for histogram " << h->GetName());
                return StatusCode::FAILURE;
            }
            index = range.first + bin;
        }
        else
        {
            index = 0;
        }
        
        FakeBkgTools::Yield yield;
        yield.nominal = nominal;
        yield.stat2.up = stat2Up;
        yield.stat2.down = stat2Down;
        for(unsigned j=0;j<n;++j)
        {
            FakeBkgTools::Uncertainty u;
            u.up = systUp[j];
            u.down= systDown[j];
            auto emplaced = yield.uncertainties.emplace(systUID[j], u);
            if(!emplaced.second) emplaced.first->second += u;
        }
        m_yields.at(index).add(yield);
    }
    
    if(filledHistograms.size() != m_histogramYieldsRange.size())
    {
        ATH_MSG_ERROR("some of the registered histogram were not found in the input file " << m_progressFileName);
        return StatusCode::FAILURE;
    }
    
    m_progressFileName.clear();
    return StatusCode::SUCCESS;
}

msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns

The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

print() [1/2]

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

print() [2/2]

virtual void asg::IAsgTool::print ( ) const

pure virtualinherited

Print the state of the tool.

Implemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, asg::AsgTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

printUncertaintyDescription()

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

finaloverridevirtualinherited

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

Implements CP::IFakeBkgSystDescriptor.

Definition at line 513 of file BaseFakeBkgTool.cxx.

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

recommendedSystematics()

CP::SystematicSet BaseFakeBkgTool::recommendedSystematics ( ) const

overridevirtualinherited

the list of all systematics this tool recommends to use

Implements CP::IReentrantSystematicsTool.

Definition at line 460 of file BaseFakeBkgTool.cxx.

{
    return affectingSystematics();
}

register1DHistogram()

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

overridevirtualinherited

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

Reimplemented from CP::BaseFakeBkgTool.

Definition at line 121 of file BaseLinearFakeBkgTool.cxx.

{
    auto sc = BaseFakeBkgTool::register1DHistogram(h1, val);
    if(sc != StatusCode::SUCCESS) return sc;
    return assignYieldRange(h1);
}

register2DHistogram()

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

overridevirtualinherited

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

Reimplemented from CP::BaseFakeBkgTool.

Definition at line 128 of file BaseLinearFakeBkgTool.cxx.

{
    auto sc = BaseFakeBkgTool::register2DHistogram(h2, xval, yval);
    if(sc != StatusCode::SUCCESS) return sc;
    return assignYieldRange(h2);
}

register3DHistogram()

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

overridevirtualinherited

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

Reimplemented from CP::BaseFakeBkgTool.

Definition at line 135 of file BaseLinearFakeBkgTool.cxx.

{
  auto sc = BaseFakeBkgTool::register3DHistogram(h3, xval, yval, zval);
    if(sc != StatusCode::SUCCESS) return sc;
    return assignYieldRange(h3);
}

renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T &  h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray &  handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

saveProgress()

StatusCode BaseLinearFakeBkgTool::saveProgress ( TDirectory *  dir )

overridevirtualinherited

Implements CP::IFakeBkgTool.

Definition at line 161 of file BaseLinearFakeBkgTool.cxx.

{
    TTree tree(::savedYieldsKey, "binned yields saved by BaseLinearFakeBkgTool");
    TObjArray histograms;
    
    ULong64_t histname = 0;
    UInt_t bin=0, n=0;
    float nominal, stat2Up, stat2Down;
    const std::size_t maxSize = m_database->numberOfStats() + m_database->numberOfSysts();
    std::unique_ptr<UShort_t[]> systUID(new UShort_t[maxSize]);
    std::unique_ptr<float[]> systUp(new float[maxSize]), systDown(new float[maxSize]);
    tree.Branch("Name", &histname, "Name/l");
    tree.Branch("Bin", &bin, "Bin/i");
    tree.Branch("nominal", &nominal, "nominal/F");
    tree.Branch("stat2Up", &stat2Up, "stat2Up/F");
    tree.Branch("stat2Down", &stat2Down, "stat2Down/F");
    tree.Branch("N", &n, "N/i");
    tree.Branch("systUID", systUID.get(), "systUID[N]/s");    
    tree.Branch("systUp", systUp.get(), "systUp[N]/F");
    tree.Branch("systDown", systDown.get(), "systDown[N]/F");
    
    auto fillTree = [&](const auto& yield)
    {
        nominal = yield.nominal;
        stat2Up = yield.stat2.up;
        stat2Down = yield.stat2.down;
        n = yield.uncertainties.size();
        auto itr = yield.uncertainties.begin();
        for(uint32_t j=0;j<n;++j)
        {
            systUID[j] = itr->first;
            systUp[j] = itr->second.up;
            systDown[j] = itr->second.down;
            ++itr;
        }
        tree.Fill();
    };
    
    fillTree(m_yields.at(0));
 
    std::hash<std::string> hasher;
    for(auto& kv : m_histogramYieldsRange)
    {
        histograms.AddLast(kv.first);
        histname = hasher(kv.first->GetName());
        for(uint32_t i=kv.second.first;i<=kv.second.second;++i)
        {
            bin = i - kv.second.first;
            fillTree(m_yields.at(i));
        }
    }
    
    dir->cd();
    tree.Write();
    dir->mkdir(::savedHistogramsKey);
    dir->cd(::savedHistogramsKey);
    histograms.Write();
    dir->cd("..");    
    return StatusCode::SUCCESS;
}

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase &  )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_accFakeEff

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

protectedinherited

only used when m_useDB is false

Definition at line 177 of file BaseFakeBkgTool.h.

m_accRealEff

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

protectedinherited

Definition at line 175 of file BaseFakeBkgTool.h.

m_cachedFinalStates

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

protectedinherited

Definition at line 99 of file BaseFakeBkgTool.h.

m_cachedWeights

std::map<FakeBkgTools::FinalState, FakeBkgTools::Weight> CP::BaseLinearFakeBkgTool::m_cachedWeights

protectedinherited

cached weight+uncertainties for a single event Each tool derived from this base class MUST clear the map in addEventCustom()!

Definition at line 67 of file BaseLinearFakeBkgTool.h.

m_convertWhenMissing

bool CP::BaseFakeBkgTool::m_convertWhenMissing = false

protectedinherited

Definition at line 80 of file BaseFakeBkgTool.h.

m_database

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

protectedinherited

Definition at line 91 of file BaseFakeBkgTool.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_energyUnit

std::string CP::BaseFakeBkgTool::m_energyUnit

protectedinherited

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_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_externalWeight

float CP::BaseFakeBkgTool::m_externalWeight

protectedinherited

Definition at line 95 of file BaseFakeBkgTool.h.

m_hasher

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

protectedinherited

comes from Event passed to addEvent()

Definition at line 97 of file BaseFakeBkgTool.h.

m_histogramYieldsRange

std::map<TH1*, std::pair<uint32_t, uint32_t> > CP::BaseLinearFakeBkgTool::m_histogramYieldsRange

protectedinherited

Definition at line 73 of file BaseLinearFakeBkgTool.h.

m_initialized

bool CP::BaseFakeBkgTool::m_initialized = false

protectedinherited

Definition at line 78 of file BaseFakeBkgTool.h.

m_inputFiles

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

protectedinherited

property InputFiles

Definition at line 127 of file BaseFakeBkgTool.h.

m_lockedSystematicVariations

bool CP::BaseFakeBkgTool::m_lockedSystematicVariations = false

protectedinherited

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

protectedinherited

Definition at line 79 of file BaseFakeBkgTool.h.

m_particles

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

protectedinherited

Definition at line 85 of file BaseFakeBkgTool.h.

m_process

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

protectedinherited

'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

protectedinherited

property ProgressFileDirectory

Definition at line 139 of file BaseFakeBkgTool.h.

m_progressFileName

std::string CP::BaseFakeBkgTool::m_progressFileName

protectedinherited

property ProgressFileName

Definition at line 136 of file BaseFakeBkgTool.h.

m_selectedUncertainties

UncertaintyList* CP::BaseFakeBkgTool::m_selectedUncertainties = nullptr

protectedinherited

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()

protectedinherited

'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

protectedinherited

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

protectedinherited

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

protectedinherited

property TightDecoration

Definition at line 130 of file BaseFakeBkgTool.h.

m_unlimitedSystematicVariations

bool CP::BaseFakeBkgTool::m_unlimitedSystematicVariations = true

protectedinherited

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

protectedinherited

Definition at line 124 of file BaseFakeBkgTool.h.

m_values_1dhisto_map

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

protectedinherited

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

protectedinherited

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

protectedinherited

Definition at line 110 of file BaseFakeBkgTool.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

m_yields

std::vector<FakeBkgTools::Yield> CP::BaseLinearFakeBkgTool::m_yields

protectedinherited

accumulated yield for all events (and histogram bins with uncertainties)

Definition at line 63 of file BaseLinearFakeBkgTool.h.

---

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

• ApplyFakeFactor.h
• ApplyFakeFactor.cxx