CP::IsolationHelper Class Reference

#include <IsolationHelper.h>

Inheritance diagram for CP::IsolationHelper:

Collaboration diagram for CP::IsolationHelper:

Public Member Functions
	IsolationHelper (const std::string &name)
	Create a constructor for Athena.
virtual	~IsolationHelper ()
virtual StatusCode	initialize ()
	initialize
virtual StatusCode	finalize ()
	finalize
bool	isolation (float &value, const xAOD::IParticle &par, xAOD::Iso::IsolationType type) const
bool	isolation (float &value, const xAOD::IParticle &par, xAOD::Iso::IsolationType type, const xAOD::Iso::IsolationCaloCorrectionBitset &corrMask) const
bool	correctionBitset (xAOD::Iso::IsolationCaloCorrectionBitset &mask, const xAOD::IParticle &par, xAOD::Iso::IsolationType type) const
bool	isolation (float &value, const xAOD::IParticle &par, xAOD::Iso::IsolationType type, const std::vector< xAOD::Iso::IsolationCaloCorrection > &corrs) const
bool	correction (float &value, const xAOD::IParticle &par, xAOD::Iso::IsolationType type, const xAOD::Iso::IsolationCaloCorrectionBitset &corrMask) const
bool	getPileupCorrection (float &value, const xAOD::IParticle &par, xAOD::Iso::IsolationType type, xAOD::Iso::IsolationCaloCorrectionBitset corrMask) const
bool	getPileupCorrection (float &value, const xAOD::IParticle &par, xAOD::Iso::IsolationType type, float coreArea) const
bool	updateIsolation (xAOD::MuonContainer *&copy, xAOD::ShallowAuxContainer *&copyaux, std::vector< xAOD::Iso::IsolationType > &types, xAOD::Iso::IsolationCaloCorrectionBitset corrMask, std::string muonkey, bool recordSG) const
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
bool	correction (float &value, const xAOD::IParticle &par, xAOD::Iso::IsolationType type, xAOD::Iso::IsolationCaloCorrection corr, const xAOD::Iso::IsolationCaloCorrectionBitset &corrMask) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

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

Detailed Description

Definition at line 20 of file IsolationHelper.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

IsolationHelper()

CP::IsolationHelper::IsolationHelper

(

const std::string &

name

)

Create a constructor for Athena.

Definition at line 18 of file IsolationHelper.cxx.

                                                         :
    asg::AsgTool( name )
    {
#ifndef XAOD_ANALYSIS
        declareInterface<IIsolationHelper>(this);
#endif // XAOD_ANALYSIS
//      declareProperty("CoreCone", m_coreCone = 0.1);
//      declareProperty("OverlapCone", m_overlapCone = 0.05);
        declareProperty("CoreCone", m_coreCone = 0.05);
    }

~IsolationHelper()

virtual CP::IsolationHelper::~IsolationHelper ( )

inlinevirtual

Definition at line 27 of file IsolationHelper.h.

{};

Member Function Documentation

correction() [1/2]

bool CP::IsolationHelper::correction ( float & value, const xAOD::IParticle & par, xAOD::Iso::IsolationType type, const xAOD::Iso::IsolationCaloCorrectionBitset & corrMask ) const

virtual

Implements CP::IIsolationHelper.

Definition at line 74 of file IsolationHelper.cxx.

                                                                                                                                                                  {
        value = 0;
        std::vector<xAOD::Iso::IsolationCaloCorrection> results;
        xAOD::Iso::IsolationCaloCorrectionBitsetHelper::decode(corrMask, results);
        for(auto c: results){
            float temp = 0;
            if(correction(temp, par, type, c, corrMask)) {
                value+=temp;
            } else {
                return false;
            }
        }
 
        return true;
    }

correction() [2/2]

bool CP::IsolationHelper::correction ( float & value, const xAOD::IParticle & par, xAOD::Iso::IsolationType type, xAOD::Iso::IsolationCaloCorrection corr, const xAOD::Iso::IsolationCaloCorrectionBitset & corrMask ) const

private

Definition at line 60 of file IsolationHelper.cxx.

                                                                                                                                                                                                       {
        if(corr == xAOD::Iso::pileupCorrection){
            return getPileupCorrection(value, par, type, corrMask);
        } else {
            auto acc = (corr == xAOD::Iso::ptCorrection)? xAOD::getIsolationCorrectionAccessor(type, corr) : xAOD::getIsolationCorrectionAccessor(xAOD::Iso::isolationFlavour(type), corr, xAOD::Iso::coreEnergy);
            if(acc.isAvailable(par)) {
                value = acc(par);
            } else {
                return false;
            }
        }
        return true;
    }

correctionBitset()

bool CP::IsolationHelper::correctionBitset ( xAOD::Iso::IsolationCaloCorrectionBitset & mask, const xAOD::IParticle & par, xAOD::Iso::IsolationType type ) const

virtual

Implements CP::IIsolationHelper.

Definition at line 49 of file IsolationHelper.cxx.

                                                                                                                                                {
        auto acc = xAOD::getIsolationCorrectionBitsetAccessor(xAOD::Iso::isolationFlavour(type));
        if(acc.isAvailable(par)) {
            mask = acc(par);
        } else {
            return false;
        }
 
        return true;
    }

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & 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());
 
  }

declareProperty()

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

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

evtStore()

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

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

finalize()

StatusCode CP::IsolationHelper::finalize ( )

virtual

finalize

Definition at line 33 of file IsolationHelper.cxx.

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

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
   }

getPileupCorrection() [1/2]

bool CP::IsolationHelper::getPileupCorrection ( float & value, const xAOD::IParticle & par, xAOD::Iso::IsolationType type, float coreArea ) const

virtual

container name

get desity

get correction

Implements CP::IIsolationHelper.

Definition at line 165 of file IsolationHelper.cxx.

                                                                                                                                     {
        xAOD::Iso::IsolationFlavour flavor = xAOD::Iso::isolationFlavour(type);

        bool isCentral = fabs(par.eta())<1.5;
        std::string esName = isCentral ? "TopoClusterIsoCentralEventShape" : "TopoClusterIsoForwardEventShape";
        if (flavor == xAOD::Iso::neflowisol) {
            esName = isCentral ? "ParticleFlowIsoCentralEventShape" : "ParticleFlowIsoForwardEventShape";
        }

        const xAOD::EventShape* edShape = nullptr;
        if (evtStore()->retrieve(edShape,esName).isFailure()) {
            ATH_MSG_ERROR("Cannot retrieve density container " + esName + " for isolation correction. No ED correction");
            return false;
        } 
 
        double rho = 0;
        bool gotDensity = edShape->getDensity(xAOD::EventShape::Density,rho);
        if (!gotDensity) {
            ATH_MSG_ERROR("Cannot retrieve density " + esName + " for isolation correction. No ED correction");
            return false;
        }

        float dR = xAOD::Iso::coneSize(type);
        // ATH_MSG_INFO("rho =" << rho << " dR=" << dR);
        value = rho*(dR*dR*M_PI - coreArea);
 
        return true;
    }

getPileupCorrection() [2/2]

bool CP::IsolationHelper::getPileupCorrection ( float & value, const xAOD::IParticle & par, xAOD::Iso::IsolationType type, xAOD::Iso::IsolationCaloCorrectionBitset corrMask ) const

virtual

Implements CP::IIsolationHelper.

Definition at line 149 of file IsolationHelper.cxx.

                                                                                                                                                                    {
        // Get the core size
        if(corrMask == 0){
            auto acc = xAOD::getIsolationCorrectionBitsetAccessor(xAOD::Iso::isolationFlavour(type));
            if(acc.isAvailable(par)) corrMask = acc(par);
        }
        float areacore = 0;
        if(corrMask.test(static_cast<unsigned int>(xAOD::Iso::core57cells))){
            areacore = 5*0.025*7*M_PI/128;
        }else if(corrMask.test(static_cast<unsigned int>(xAOD::Iso::coreCone))){
            areacore = m_coreCone*m_coreCone*M_PI;
        }
 
        return getPileupCorrection(value, par, type, areacore);
    }

getProperty()

template<class T>

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

inherited

Get one of the tool's properties.

initialize()

StatusCode CP::IsolationHelper::initialize ( void )

virtual

initialize

Reimplemented from asg::AsgTool.

Definition at line 29 of file IsolationHelper.cxx.

                                           {
        return StatusCode::SUCCESS;
    }

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.

isolation() [1/3]

bool CP::IsolationHelper::isolation ( float & value, const xAOD::IParticle & par, xAOD::Iso::IsolationType type ) const

virtual

Implements CP::IIsolationHelper.

Definition at line 38 of file IsolationHelper.cxx.

                                                                                                           {
        const auto *acc = xAOD::getIsolationAccessor( type );
        if(acc) {
            value = (*acc)(par);
        } else {
            return false;
        }
 
        return true;
    }

isolation() [2/3]

bool CP::IsolationHelper::isolation ( float & value, const xAOD::IParticle & par, xAOD::Iso::IsolationType type, const std::vector< xAOD::Iso::IsolationCaloCorrection > & corrs ) const

virtual

Implements CP::IIsolationHelper.

Definition at line 90 of file IsolationHelper.cxx.

                                                                                                                                                                   {
        xAOD::Iso::IsolationCaloCorrectionBitset mask = 0;
        xAOD::Iso::IsolationCaloCorrectionBitsetHelper::encode(corrs, mask);
 
        return isolation(value, par, type, mask); 
    }

isolation() [3/3]

bool CP::IsolationHelper::isolation ( float & value, const xAOD::IParticle & par, xAOD::Iso::IsolationType type, const xAOD::Iso::IsolationCaloCorrectionBitset & corrMask ) const

virtual

get orinial values

Implements CP::IIsolationHelper.

Definition at line 97 of file IsolationHelper.cxx.

                                                                                                                                                                 {
        float origValue = 0;
        if(!isolation(origValue, par, type)) return false;
        xAOD::Iso::IsolationCaloCorrectionBitset origMask = 0;
        if(!correctionBitset(origMask, par, type)) return false;
 
        if(origMask == corrMask) { 
            value=origValue;
        } else{
            float origCorr = 0;
            if(!correction(origCorr, par, type, origMask)) return false;
            float newCorr = 0;
            if(!correction(newCorr, par, type, corrMask)) return false;
 
            value = origValue+origCorr-newCorr;
        }
 
        return true;
    }

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

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

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

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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

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.

updateIsolation()

bool CP::IsolationHelper::updateIsolation ( xAOD::MuonContainer *& copy, xAOD::ShallowAuxContainer *& copyaux, std::vector< xAOD::Iso::IsolationType > & types, xAOD::Iso::IsolationCaloCorrectionBitset corrMask, std::string muonkey, bool recordSG ) const

virtual

Implements CP::IIsolationHelper.

Definition at line 118 of file IsolationHelper.cxx.

                                                                                                                                                                                                                                   {
        const xAOD::MuonContainer* muons(nullptr);
        ATH_CHECK( evtStore()->retrieve(muons,muonkey), false );
                std::pair<std::unique_ptr<xAOD::MuonContainer>,
                          std::unique_ptr<xAOD::ShallowAuxContainer> >  shallowcopy =
                  xAOD::shallowCopyContainer(*muons, Gaudi::Hive::currentContext());
        copy = shallowcopy.first.get();
        copyaux = shallowcopy.second.get();
 
        for(auto par: *copy){
            for(auto type: types){
                float value = 0;
                    if(!isolation(value, *par, type, corrMask)) return false;
                    const auto *acc = xAOD::getIsolationAccessor( type );
                    if(acc){
                      (*acc)(*par) = value;
                    } else {
                      return false;
                    }
                    auto acc2 = xAOD::getIsolationCorrectionBitsetAccessor(xAOD::Iso::isolationFlavour(type));
                    acc2(*par) = corrMask.to_ulong();
            }
        }
 
            if(recordSG) {
                          ATH_CHECK( evtStore()->record(std::move(shallowcopy.first), "IsoFixed_"+muonkey), false );
                          ATH_CHECK( evtStore()->record(std::move(shallowcopy.second),"IsoFixed_"+muonkey+"Aux."), false );
        }
        return true;
    }

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_coreCone

float CP::IsolationHelper::m_coreCone

private

Definition at line 47 of file IsolationHelper.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_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_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.

---

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

• IsolationHelper.h
• IsolationHelper.cxx