FSR::FsrPhotonTool Class Reference

Implementation for the "FSR" provider tool. More...

#include <FsrPhotonTool.h>

Inheritance diagram for FSR::FsrPhotonTool:

Collaboration diagram for FSR::FsrPhotonTool:

Public Member Functions
	FsrPhotonTool (const std::string &name)
	Create a proper constructor for Athena.
	~FsrPhotonTool ()
	Create a destructor.
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
Function(s) implementing the asg::IAsgTool interface
virtual StatusCode	initialize ()
	Function initialising the tool.
Function(s) implementing the IFsrPhotonTool interface
virtual CP::CorrectionCode	getFsrPhoton (const xAOD::IParticle *part, FsrCandidate &candidate, xAOD::PhotonContainer *photons, const xAOD::ElectronContainer *electrons)
	Get the "FSR candidate" as a return value for a muon (collinar and far FSR).
virtual std::vector< FsrCandidate > *	getFsrCandidateList (const xAOD::IParticle *part, xAOD::PhotonContainer *photons, const xAOD::ElectronContainer *electrons)
	Find ALL FSR candidates for a given particle (electron or muon) providing newly calibrated photon and electron containers.
virtual std::vector< FsrCandidate > *	getFarFsrCandidateList (const xAOD::IParticle *part, xAOD::PhotonContainer *photons_cont)
	Find and Return ALL FAR FSR candidates.
virtual std::vector< FsrCandidate > *	getNearFsrCandidateList (const xAOD::Muon *part, const xAOD::PhotonContainer *photons_cont, const xAOD::ElectronContainer *electrons_cont)
	Find and Return ALL NEAR FSR candidates.
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
std::vector< FsrCandidate > *	sortFsrCandidates (const std::vector< std::pair< const xAOD::IParticle *, double > > &FsrCandList, const std::string &option="ET")
	Need for the FSR search.
bool	isOverlap (const xAOD::Electron_v1 *electron, const std::vector< std::pair< const xAOD::IParticle *, double > > &phfsr, unsigned int nofPhFsr)
double	deltaR (float muonEta, float muonPhi, float phEta, float phPhi) const
double	deltaPhi (float phi1, float phi2) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Static Private Member Functions
static bool	compareEt (const FsrCandidate &c1, const FsrCandidate &c2)

Private Attributes
Gaudi::Property< double >	m_high_et_min {this, "high_et_min", 3500. , "Minimum Et cut for higg Et photons" }
Gaudi::Property< double >	m_overlap_el_ph {this, "overlap_el_ph", 0.01 , "Overlap dR for electrons and photons" }
Gaudi::Property< double >	m_overlap_el_mu {this, "overlap_el_mu", 0.001 , "Overlap dR for electrons and muons" }
Gaudi::Property< double >	m_far_fsr_drcut {this, "far_fsr_drcut", 0.15 , "Minimum dR cut for far fsr" }
Gaudi::Property< double >	m_far_fsr_etcut {this, "far_fsr_etcut", 10000.0 , "Minimum et cut for far fsr" }
Gaudi::Property< double >	m_drcut {this, "drcut", 0.15 , "Maximun dR cut to be near fsr" }
Gaudi::Property< double >	m_etcut {this, "etcut", 1000.0 , "Minimum Et cut for near fsr" }
Gaudi::Property< double >	m_f1cut {this, "f1cut", 0.1 , "f1 cut for high Et clusters" }
Gaudi::Property< double >	m_topo_drcut {this, "topo_drcut", 0.08 , "Maximum dR cut for low Et clusters" }
Gaudi::Property< double >	m_topo_f1cut {this, "topo_f1cut", 0.2 , "Minimum f1 cut for low Et clusters" }
Gaudi::Property< std::string >	m_far_fsr_isoWorkingPoint {this, "far_fsr_isoWorkingPoint", "FixedCutLoose", "Far fsr isolation working point" }
Gaudi::Property< std::string >	m_energyRescalerName {this, "egCalibToolName", "" , "EnergyRescale tool to calibrate photons as electrons" }
Gaudi::Property< bool >	m_suppresEnergyRescaling {this, "SuppressEnergyRescaling", false , "flag to suppress energy rescaling - should only be used for testing purposes, e.g. test w/o calib for PhysLite " }
Gaudi::Property< bool >	m_AFII_corr {this, "AFII_corr", false , "Is AFII for isolation correction" }
Gaudi::Property< bool >	m_is_mc {this, "IsMC", true , "Is MC" }
Gaudi::Property< bool >	m_doCloseByIso {this, "DoCloseByCorrection", true , "flag to use isolation variables with 'CloseByCorr' suffix " }
std::vector< FsrCandidate >	m_fsrPhotons
FsrCandidate::FsrType	m_fsr_type
ToolHandle< CP::IIsolationSelectionTool >	m_isoSelTool
ToolHandle< CP::IEgammaCalibrationAndSmearingTool >	m_energyRescaler
ToolHandle< IAsgSelectionTool >	m_elIsGoodOQSelectionTool
ToolHandle< IAsgSelectionTool >	m_phIsGoodOQSelectionTool
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

Implementation for the "FSR" provider tool.

Author

Tulay Cuhadar Donszelmann tcuha.nosp@m.dar@.nosp@m.cern..nosp@m.ch

RD Schaffer R.D.S.nosp@m.chaf.nosp@m.fer@c.nosp@m.ern..nosp@m.ch

Definition at line 32 of file FsrPhotonTool.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

FsrPhotonTool()

FSR::FsrPhotonTool::FsrPhotonTool

(

const std::string &

name

)

Create a proper constructor for Athena.

Create a constructor for standalone usage

Definition at line 21 of file FsrPhotonTool.cxx.

        : asg::AsgTool( name ),
          m_fsr_type(FsrCandidate::FsrUnknown),
          m_isoSelTool("", this),
          m_energyRescaler("", this),
          m_elIsGoodOQSelectionTool("", this),
          m_phIsGoodOQSelectionTool("", this)
    {}

~FsrPhotonTool()

FSR::FsrPhotonTool::~FsrPhotonTool

(

)

Create a destructor.

Definition at line 30 of file FsrPhotonTool.cxx.

    {}

Member Function Documentation

compareEt()

bool FSR::FsrPhotonTool::compareEt ( const FsrCandidate & c1, const FsrCandidate & c2 )

inlinestaticprivate

Definition at line 85 of file FsrPhotonTool.h.

{ return (c1.Et > c2.Et); }

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

deltaPhi()

double FSR::FsrPhotonTool::deltaPhi ( float phi1, float phi2 ) const

private

Definition at line 471 of file FsrPhotonTool.cxx.

                                                               {
        double dphi= fabs(phi1 - phi2);
        if (dphi > M_PI) dphi=2*M_PI-dphi;
        return dphi;
    }

deltaR()

double FSR::FsrPhotonTool::deltaR ( float muonEta, float muonPhi, float phEta, float phPhi ) const

private

Definition at line 478 of file FsrPhotonTool.cxx.

                                                                                     {
   
        double deta = fabs(meta - peta);
        double dphi = deltaPhi(mphi, pphi);
        double dR   = sqrt((dphi*dphi)+(deta*deta));
   
        return dR;
    }

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

getFarFsrCandidateList()

std::vector< FsrCandidate > * FSR::FsrPhotonTool::getFarFsrCandidateList ( const xAOD::IParticle * part, xAOD::PhotonContainer * photons_cont )

virtual

Find and Return ALL FAR FSR candidates.

Set FSR type to far

return sorted list

Implements FSR::IFsrPhotonTool.

Definition at line 185 of file FsrPhotonTool.cxx.

                                                                                                        {
 
 
        static const SG::AuxElement::Accessor<char>  DFCommonPhotonsIsEMTight ("DFCommonPhotonsIsEMTight");
        static const SG::AuxElement::Accessor<char>  DFCommonPhotonsCleaning  ("DFCommonPhotonsCleaning");
        static const SG::AuxElement::Accessor<float> topoetcone20             ("topoetcone20");

        m_fsr_type = FsrCandidate::FsrType::FsrFar;
        std::vector< std::pair <const xAOD::IParticle*, double> > farFsrCandList;
        farFsrCandList.clear();
        farFsrCandList.reserve(photons_cont->size());
 
        // Save muon or electron of overlap removal for isolation
        ConstDataVector<xAOD::IParticleContainer> parts(SG::VIEW_ELEMENTS);
        parts.push_back(part);
    
        ATH_MSG_DEBUG( "In getFarFsrCandidateList function : photon size = " << photons_cont->size());
    
        for (auto ph : *photons_cont) {
 
            // apply both object quality and photon cleaning
            bool oqIsOK = (bool) m_phIsGoodOQSelectionTool->accept(ph) && DFCommonPhotonsCleaning(*ph);
                
            bool is_tight_photon = DFCommonPhotonsIsEMTight(*ph);
            if ( oqIsOK && (ph->p4().Et() > m_far_fsr_etcut) && is_tight_photon) {
                // correct isolation leakage
 
                ATH_MSG_VERBOSE( "Far Fsr ph bef : pt   " << ph->pt() << " topoetcone20 = " << topoetcone20(*ph));
 
                // apply isolation selection
                bool farPhIsoOK = (bool) m_isoSelTool->accept(*ph);
 
                ATH_MSG_VERBOSE( "Far Fsr ph aft: pt   " << ph->pt() << " topoetcone20 = " << topoetcone20(*ph));
 
                bool far_fsr_drcut_isOK = false;
                if (farPhIsoOK) {
                    double dr = deltaR(part->eta(), part->phi(), ph->eta(), ph->phi());
                    far_fsr_drcut_isOK = (dr > m_far_fsr_drcut);
 
                    if (far_fsr_drcut_isOK && dr < 0.2) {
                        ATH_MSG_VERBOSE( "Far Fsr candidate kinematics : author  " << ph->author()
                                    << " Et = " << ph->p4().Et()
                                    << " dr = " << dr
                                    << " isoIsOK = " << farPhIsoOK );
                    }
 
                    if(far_fsr_drcut_isOK) farFsrCandList.push_back(std::make_pair(ph, dr));
                }
                    
                ATH_MSG_DEBUG( "Far Fsr candidate kinematics : author  " << ph->author()
                            << " Et = " << ph->p4().Et()
                            << " tight = " << is_tight_photon
                            << " farPhIsoOK = " << farPhIsoOK
                            << " far_fsr_drcut_isOK = " << far_fsr_drcut_isOK);
            }
        }
   
        return sortFsrCandidates(farFsrCandList);
    }

getFsrCandidateList()

std::vector< FsrCandidate > * FSR::FsrPhotonTool::getFsrCandidateList ( const xAOD::IParticle * part, xAOD::PhotonContainer * photons, const xAOD::ElectronContainer * electrons )

virtual

Find ALL FSR candidates for a given particle (electron or muon) providing newly calibrated photon and electron containers.

Search for far fsr for for electron and muon Electron : far fsr is the only option - return the result Muon : In case collinar fsr not found, check the far fsr

Set FSR type to far

Implements FSR::IFsrPhotonTool.

Definition at line 137 of file FsrPhotonTool.cxx.

                                                                               {
        xAOD::PhotonContainer* photons_cont = NULL;
        const xAOD::ElectronContainer* electrons_cont = NULL;
 
        // check for photon container
        if (0 == photons) {
            ATH_MSG_ERROR( "getFsrCandidateList: No Photon container provided" );
            return NULL;
        }
        else {
            // set the containers
            photons_cont   = photons;
        }
       
        // check for electron container
        if (0 == electrons) {
            ATH_MSG_ERROR( "getFsrCandidateList: No Electron container provided" );
            return NULL;
        }
        else {
            // set the containers
            electrons_cont = electrons;
        }

    
        m_fsr_type = FsrCandidate::FsrType::FsrUnknown;
    
        const xAOD::Electron* electron = dynamic_cast<const xAOD::Electron*>(part);
        if (electron) {
            return getFarFsrCandidateList(part, photons_cont);
        }
    
        const xAOD::Muon* muon = dynamic_cast<const xAOD::Muon*>(part);
        if (muon) {
            std::vector<FsrCandidate>* nearlist = getNearFsrCandidateList(muon, photons_cont, electrons_cont);
            return (nearlist->size() > 0) ? nearlist : getFarFsrCandidateList(part, photons_cont);
        }
    
        ATH_MSG_WARNING( "The FSR search not done !" );
        return NULL;
    }

getFsrPhoton()

CP::CorrectionCode FSR::FsrPhotonTool::getFsrPhoton ( const xAOD::IParticle * part, FsrCandidate & candidate, xAOD::PhotonContainer * photons, const xAOD::ElectronContainer * electrons )

virtual

Get the "FSR candidate" as a return value for a muon (collinar and far FSR).

Implements FSR::IFsrPhotonTool.

Definition at line 104 of file FsrPhotonTool.cxx.

                                                                                           {
 
        if (photons == 0 ||electrons == 0) {
            ATH_MSG_ERROR( "getFsrPhoton: You MUST provide photon AND electron containers" );
            candidate = FsrCandidate();
            return CP::CorrectionCode::Error;
        }
        
            
        std::vector<FsrCandidate>* cands = getFsrCandidateList(part, photons, electrons);
 
        ATH_MSG_DEBUG( "Fsr candidate size = " << cands->size() );
 
        // Return gracefully:
        if (cands->size() > 0) {
            candidate = cands->at(0);
            return CP::CorrectionCode::Ok;
        }
        candidate = FsrCandidate();
        ATH_MSG_DEBUG( "Fsr candidate  f1 = " << candidate.f1
                       << ", deltaR = " << candidate.deltaR
                       << ", Et = " << candidate.Et
                       << ", Eta = " << candidate.eta
                       << ", Phi = " << candidate.phi
                       << ", type = " <<candidate.type);
        return CP::CorrectionCode::Error;
 
    }

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::Event 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::Event, 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::Event 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::Event, 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
   }

getNearFsrCandidateList()

std::vector< FsrCandidate > * FSR::FsrPhotonTool::getNearFsrCandidateList ( const xAOD::Muon * part, const xAOD::PhotonContainer * photons_cont, const xAOD::ElectronContainer * electrons_cont )

virtual

Find and Return ALL NEAR FSR candidates.

Set FSR type to far

Start looking for collinar FSR for muons Loop over photon candidates and choose the FSR photons

Implements FSR::IFsrPhotonTool.

Definition at line 249 of file FsrPhotonTool.cxx.

                                                                                                                   {
 
        static const SG::AuxElement::Accessor<char>  DFCommonPhotonsCleaning  ("DFCommonPhotonsCleaning");

        m_fsr_type = FsrCandidate::FsrType::FsrNear;
        std::vector< std::pair <const xAOD::IParticle*, double> >  nearFsrCandList;
    
        nearFsrCandList.reserve(photons_cont->size()+electrons_cont->size());
        ATH_MSG_DEBUG( "In getNearFsrCandidateList function : photon size = " << photons_cont->size()
                        << ", electron size = " << electrons_cont->size());
    
        for (auto photon : *photons_cont) {
            float photon_f1;
            photon->showerShapeValue(photon_f1, xAOD::EgammaParameters::f1);
 
            bool oqIsOK = (bool) m_phIsGoodOQSelectionTool->accept(photon) && DFCommonPhotonsCleaning(*photon);
 
            // Selection is tighter for photons below high_et_min
            bool high_et_photon = (photon->p4().Et() > m_high_et_min);
            if(  ( oqIsOK && high_et_photon && (photon->p4().Et() > m_etcut) && (photon_f1 > m_f1cut) )
                 ||
                 ( oqIsOK && !high_et_photon && (photon_f1 > m_topo_f1cut)
                     && (m_etcut < photon->p4().Et())) ) {
   
                double dr = deltaR(muon->eta(), muon->phi(), photon->eta(), photon->phi());
   
                // ph_cl_eta/phi should be used in duplicate
                if (   (!high_et_photon && dr < m_topo_drcut)
                       || (high_et_photon && dr < m_drcut)  ) {
                    nearFsrCandList.push_back(std::make_pair(photon, dr));
                    ATH_MSG_DEBUG( "Near Fsr candidates ( photon ) kinematics ; author  "
                                   << photon->author()
                                   << " Et = " << photon->p4().Et()
                                   << " f1 = " << photon_f1
                                   << " dr = " << dr );
                }
            }
        }
   
        unsigned int nofPhFsr = nearFsrCandList.size();
   
        // look for fsr photons in electron container
        for (auto electron : *electrons_cont) {
            // remove overlap with fsr already found
            if ( (nearFsrCandList.size() > 0) && isOverlap(electron, nearFsrCandList, nofPhFsr) ) continue;
 
            // Check object quality
            // bool oqIsOK = electron->isGoodOQ(xAOD::EgammaParameters::BADCLUSELECTRON);
bool oqIsOK = (bool) m_elIsGoodOQSelectionTool->accept(electron);
   
            const xAOD::TrackParticle* electron_track = electron->trackParticle();
            const xAOD::TrackParticle* muon_track     = muon->trackParticle(xAOD::Muon::TrackParticleType::Primary);
 
            bool elmutrackmatch = ( (fabs(electron_track->theta()- muon_track->theta()) < m_overlap_el_mu) &&
                                    (deltaPhi(electron_track->phi(),  muon_track->phi())   < m_overlap_el_mu) );
            float electron_f1;
            electron->showerShapeValue(electron_f1, xAOD::EgammaParameters::f1);
 
            // Get the corrected cluster energy:
            //  if the electron energy has been calibrated, we apply the change applied to the
            //  electron four vector assuming that the uncorrected energy is
            //  Eclus/cosh(track_eta). This will not work if an e-p combination has also been
            //  applied, and so the following will have to change.  RDS 04/2015.
            float eCorr = electron->p4().Et()/(electron->caloCluster()->e()/cosh(electron->trackParticle()->eta()));
            float clEt  = eCorr*electron->caloCluster()->et();
 
            ATH_MSG_VERBOSE( "Near Fsr candidate ( electron ) Et = " << clEt << " eCorr " << eCorr << " OQ is ok: " << (int) oqIsOK  << ", pt,eta,phi " << electron->pt()/1000 << ", " << electron->eta() << ", " << electron->phi());
        
            // Allow topo-clusters to come in as electrons - apply f1 sliding window cut for Et
            // > 3.5 GeV and f1 topo cut for Et 1-3.5 GeV
            if( elmutrackmatch && oqIsOK &&
                ((clEt < m_high_et_min && m_etcut < clEt && electron_f1 > m_topo_f1cut ) ||
                    (m_high_et_min < clEt                   && electron_f1 > m_f1cut )) ) {
 
                double dr = deltaR(muon->eta(), muon->phi(), electron->caloCluster()->eta(), electron->caloCluster()->phi());
 
                if ( dr < m_drcut ) {
                    nearFsrCandList.push_back(std::make_pair(electron, dr));
                    ATH_MSG_DEBUG( "Near Fsr candidates ( electron ) kinematics : author  "
                                    << electron->author()
                                    << " Et = " << clEt
                                    << " f1 = " << electron_f1
                                    << " dr = " << dr );
                }
                else ATH_MSG_VERBOSE( "FAILED Near Fsr candidates ( electron ) kinematics : author  "
                                        << electron->author()
                                        << " Et = " << clEt
                                        << " f1 = " << electron_f1
                                        << " dr = " << dr );
            }
            else {
                double dr = deltaR(muon->eta(), muon->phi(), electron->caloCluster()->eta(), electron->caloCluster()->phi());
 
                if (elmutrackmatch && dr < m_drcut ) {
                ATH_MSG_DEBUG( "FAILED Near Fsr candidates ( electron ) kinematics : author  "
                                << electron->author()
                                << " Et = " << clEt
                                << " f1 = " << electron_f1
                                << " dr = " << deltaR(muon->eta(), muon->phi(), electron->caloCluster()->eta(), electron->caloCluster()->phi())
                                << " theta/phi el/mu " << electron_track->theta() << "/" << muon->p4().Theta()
                                << "/" << electron_track->phi() << "/" << muon->phi()
                                << " theta/phi mu trk " << muon_track->theta() << "/" << muon_track->phi()
                                );
                }
            }
        }
   
        return sortFsrCandidates(nearFsrCandList);
   
    }  // end of getFsrPhotons

getProperty()

template<class T>

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

inherited

Get one of the tool's properties.

initialize()

StatusCode FSR::FsrPhotonTool::initialize ( void )

virtual

Function initialising the tool.

Reimplemented from asg::AsgTool.

Definition at line 34 of file FsrPhotonTool.cxx.

                                         {
 
        // Greet the user:
        ATH_MSG_INFO( "Initialising..." );
 
        ATH_MSG_INFO( "initialize: high_et_min " << m_high_et_min);
        ATH_MSG_INFO( "initialize: overlap_el_ph " << m_overlap_el_ph);
        ATH_MSG_INFO( "initialize: overlap_el_mu " << m_overlap_el_mu);
        ATH_MSG_INFO( "initialize: far_fsr_drcut " << m_far_fsr_drcut);
        ATH_MSG_INFO( "initialize: far_fsr_etcut " << m_far_fsr_etcut);
        ATH_MSG_INFO( "initialize: far_fsr_isoWorkingPoint " << m_far_fsr_isoWorkingPoint);
        ATH_MSG_INFO( "initialize: drcut " << m_drcut);
        ATH_MSG_INFO( "initialize: etcut " << m_etcut);
        ATH_MSG_INFO( "initialize: f1cut " << m_f1cut);
        ATH_MSG_INFO( "initialize: topo_drcut " << m_topo_drcut);
        ATH_MSG_INFO( "initialize: topo_f1cut " << m_topo_f1cut);
        ATH_MSG_INFO( "initialize: egCalibToolName " << m_energyRescalerName);
        
        // Create IsolationSelectionTool for far fsr selection. 
        // Will use the closeBy corrected isolation variables if DoCloseByCorrection is set to true, which is default.
        asg::AsgToolConfig config ("CP::IsolationSelectionTool/isolationSelectionTool");
        RETURN_CHECK("initialize", config.setProperty( "PhotonWP", m_far_fsr_isoWorkingPoint));
 
        if (m_doCloseByIso) {
            RETURN_CHECK("initialize", config.setProperty("IsoDecSuffix", "CloseByCorr")); 
            if (msg().level() <= MSG::DEBUG) {
                RETURN_CHECK( "initialize", config.setProperty( "OutputLevel", MSG::DEBUG) );
            }
        }
        RETURN_CHECK("initialize", config.makePrivateTool (m_isoSelTool));  
        ATH_MSG_INFO("initialize - photon IsolationSelectionTool initialized " << m_isoSelTool->name());
 
        RETURN_CHECK("initialize", m_isoSelTool.retrieve());
 
        // get egamma calibration tool - needed to recalibrate electron as a photon
        if (m_energyRescalerName.size()) {
            m_energyRescaler = ToolHandle<CP::IEgammaCalibrationAndSmearingTool>(m_energyRescalerName);
            if (m_energyRescaler.empty()) {
                ATH_MSG_ERROR("initialize - unable to get IEgammaCalibrationAndSmearingTool with name: " << m_energyRescalerName);
                return StatusCode::FAILURE;
            }
 
            ATH_MSG_INFO("initialize - found  IEgammaCalibrationAndSmearingTool with name: " << m_energyRescalerName);
        }
        else {
            ATH_MSG_ERROR("initialize - CANNOT retrieve IEgammaCalibrationAndSmearingTool. Please set the property 'egCalibToolName' to be able to recalibrate fsr photon found as an electron ");
            return StatusCode::FAILURE;
        }
        
        // setup electron and photon object quality tools - checks object quality and Dead HV cell cuts
 
        // electron OQ
        asg::AsgToolConfig config1 ("CP::EgammaIsGoodOQSelectionTool/electronIsGoodOQSelectionTool");
        RETURN_CHECK("initialize", config1.setProperty( "Mask", xAOD::EgammaParameters::BADCLUSELECTRON));
        RETURN_CHECK("initialize", config1.makePrivateTool (m_elIsGoodOQSelectionTool));  
        RETURN_CHECK("initialize", m_elIsGoodOQSelectionTool.retrieve());      
        ATH_MSG_INFO("initialize - electronIsGoodOQSelectionTool initialized " << m_elIsGoodOQSelectionTool->name());
 
        // photon OQ
        asg::AsgToolConfig config2 ("CP::EgammaIsGoodOQSelectionTool/photonIsGoodOQSelectionTool");
        RETURN_CHECK("initialize", config2.setProperty( "Mask", xAOD::EgammaParameters::BADCLUSPHOTON));
        RETURN_CHECK("initialize", config2.makePrivateTool (m_phIsGoodOQSelectionTool));  
        RETURN_CHECK("initialize", m_phIsGoodOQSelectionTool.retrieve());      
        ATH_MSG_INFO("initialize - electronIsGoodOQSelectionTool initialized " << m_phIsGoodOQSelectionTool->name());
 
        // Return gracefully:
        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.

isOverlap()

bool FSR::FsrPhotonTool::isOverlap ( const xAOD::Electron_v1 * electron, const std::vector< std::pair< const xAOD::IParticle *, double > > & phfsr, unsigned int nofPhFsr )

private

Definition at line 454 of file FsrPhotonTool.cxx.

                                                         {
        for (unsigned int indx=0; indx < nofPhFsr; indx++ ) {
                const xAOD::Photon* ph = dynamic_cast<const xAOD::Photon*>(phfsr.at(indx).first);
                if (!ph) continue;
                const xAOD::CaloCluster* ph_cl = ph->caloCluster();
                const xAOD::CaloCluster* el_cl = electron->caloCluster();
                double dr = deltaR(el_cl->eta(), el_cl->phi(),
                                ph_cl->eta(), ph_cl->phi());
                ATH_MSG_VERBOSE( "isOverlap dr, ets " << (dr < m_overlap_el_ph) << "/" << dr << "/"
                                << ph_cl->et() << "/" << el_cl->et());
                if ( dr < m_overlap_el_ph ) return true;
        }
        return false;
    }

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

sortFsrCandidates()

std::vector< FsrCandidate > * FSR::FsrPhotonTool::sortFsrCandidates ( const std::vector< std::pair< const xAOD::IParticle *, double > > & FsrCandList, const std::string & option = "ET" )

private

Need for the FSR search.

Definition at line 366 of file FsrPhotonTool.cxx.

                                 {
   
        m_fsrPhotons.clear();
        m_fsrPhotons.reserve(FsrCandList.size());
   
        for (unsigned int i=0; i < FsrCandList.size(); i++ ) {
            FsrCandidate c;
            const xAOD::IParticle* particle = FsrCandList.at(i).first;
            const xAOD::Electron* electron = dynamic_cast<const xAOD::Electron*>(particle);
            const xAOD::Photon* photon = dynamic_cast<const xAOD::Photon*>(particle);
            float part_f1(-999);
            if ( electron ){
            c.container =   "electron" ;
 
                // If we have an energy rescaler, calibrate correctly the electron as a photon
                if (!m_energyRescaler.empty()) {
                    xAOD::Photon photon;
                     photon.Egamma_v1::operator=(*electron);
                    if (m_energyRescaler->applyCorrection(photon) != CP::CorrectionCode::Ok) {
                        ATH_MSG_ERROR("FsrPhotonTool::sortFsrCandidates: Unable to applyCorrection to photon ");
                    }
                    if ( photon.showerShapeValue(part_f1, xAOD::EgammaParameters::f1) ) c.f1 = part_f1; 
                    c.Et  = photon.pt();
                    c.eta = photon.caloCluster()->eta();
                    c.phi = photon.caloCluster()->phi();
 
                    ATH_MSG_DEBUG("FsrPhotonTool::sortFsrCandidates: el/ph et " << electron->pt() << "/"
                                  << electron->caloCluster()->eta() << "/" << electron->caloCluster()->phi() << " "
                                  << photon.pt() << "/"
                                  << photon.caloCluster()->eta() << "/" << photon.caloCluster()->phi());
                }
                else {
                    // Use the cluster pt/eta/phi when considering the electron to be an FSR photon
                    // setup accessor for electron cluster corrected energy
 
                    // Get the corrected cluster energy:
                    //  if the electron energy has been calibrated, we apply the change applied to the
                    //  electron four vector assuming that the uncorrected energy is
                    //  Eclus/cosh(track_eta). This will not work if an e-p combination has also been
                    //  applied, and so the following will have to change.  RDS 04/2015.
                    float eCorr = electron->p4().Et()/(electron->caloCluster()->e()/cosh(electron->trackParticle()->eta()));
                    float clEt  = eCorr*electron->caloCluster()->et();
                    if ( electron->showerShapeValue(part_f1, xAOD::EgammaParameters::f1) ) c.f1 = part_f1; 
                    c.Et  = clEt;
                    c.eta = electron->caloCluster()->eta();
                    c.phi = electron->caloCluster()->phi();
                }
 
            }
            else if ( photon ) {
                c.container =   "photon";
                if ( photon->showerShapeValue(part_f1, xAOD::EgammaParameters::f1) ) c.f1 = part_f1; 
                c.Et  = photon->p4().Et();
                c.eta = photon->eta();
                c.phi = photon->phi();
            }
            else {
                ATH_MSG_WARNING( "sortFsrCandidates: undefined particle - NOT electron nor photon. Should never get here!" );
            c.container =   "";
                c.Et  = 0;
                c.eta = 0;
                c.phi = 0;
            }
            c.particle     = particle;
            c.deltaR       = FsrCandList.at(i).second;
            if(c.deltaR < 0.05) c.Et -= 400./cosh(particle->eta());
            c.type         = (c.deltaR > m_far_fsr_drcut) ? FsrCandidate::FsrFar : FsrCandidate::FsrNear;
            m_fsrPhotons.push_back(c);
 
            ATH_MSG_DEBUG( "sortFsrCandidates: save fsr candidate  f1 = " << c.f1
                           << ", deltaR = " << c.deltaR
                           << ", Et = " << c.Et
                           << ", Eta = " << c.eta
                           << ", Phi = " << c.phi
                           << ", type = " <<c.type);
            
        }
   
        ATH_MSG_DEBUG( "sortFsrCandidates: found " << m_fsrPhotons.size() << " FSR photons" );
        
        // sort FSR candidates w.r.t min dR or ET
        if (option=="ET") std::sort(m_fsrPhotons.begin(), m_fsrPhotons.end(), compareEt);
        else std::sort(m_fsrPhotons.begin(), m_fsrPhotons.end());
        return &m_fsrPhotons;
    }

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 >, and AthCheckedComponent<::AthAlgTool >.

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_AFII_corr

Gaudi::Property<bool> FSR::FsrPhotonTool::m_AFII_corr {this, "AFII_corr", false , "Is AFII for isolation correction" }

private

Definition at line 103 of file FsrPhotonTool.h.

{this, "AFII_corr", false , "Is AFII for isolation correction" };

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_doCloseByIso

Gaudi::Property<bool> FSR::FsrPhotonTool::m_doCloseByIso {this, "DoCloseByCorrection", true , "flag to use isolation variables with 'CloseByCorr' suffix " }

private

Definition at line 106 of file FsrPhotonTool.h.

{this, "DoCloseByCorrection", true , "flag to use isolation variables with 'CloseByCorr' suffix " };

m_drcut

Gaudi::Property<double> FSR::FsrPhotonTool::m_drcut {this, "drcut", 0.15 , "Maximun dR cut to be near fsr" }

private

Definition at line 95 of file FsrPhotonTool.h.

{this, "drcut", 0.15 , "Maximun dR cut to be near fsr" };

m_elIsGoodOQSelectionTool

ToolHandle<IAsgSelectionTool> FSR::FsrPhotonTool::m_elIsGoodOQSelectionTool

private

Definition at line 113 of file FsrPhotonTool.h.

m_energyRescaler

ToolHandle<CP::IEgammaCalibrationAndSmearingTool> FSR::FsrPhotonTool::m_energyRescaler

private

Definition at line 112 of file FsrPhotonTool.h.

m_energyRescalerName

Gaudi::Property<std::string> FSR::FsrPhotonTool::m_energyRescalerName {this, "egCalibToolName", "" , "EnergyRescale tool to calibrate photons as electrons" }

private

Definition at line 101 of file FsrPhotonTool.h.

{this, "egCalibToolName", "" , "EnergyRescale tool to calibrate photons as electrons" };

m_etcut

Gaudi::Property<double> FSR::FsrPhotonTool::m_etcut {this, "etcut", 1000.0 , "Minimum Et cut for near fsr" }

private

Definition at line 96 of file FsrPhotonTool.h.

{this, "etcut", 1000.0 , "Minimum Et cut for near fsr" };

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_f1cut

Gaudi::Property<double> FSR::FsrPhotonTool::m_f1cut {this, "f1cut", 0.1 , "f1 cut for high Et clusters" }

private

Definition at line 97 of file FsrPhotonTool.h.

{this, "f1cut",  0.1 , "f1 cut for high Et clusters" };

m_far_fsr_drcut

Gaudi::Property<double> FSR::FsrPhotonTool::m_far_fsr_drcut {this, "far_fsr_drcut", 0.15 , "Minimum dR cut for far fsr" }

private

Definition at line 93 of file FsrPhotonTool.h.

{this, "far_fsr_drcut", 0.15 , "Minimum dR cut for far fsr" };

m_far_fsr_etcut

Gaudi::Property<double> FSR::FsrPhotonTool::m_far_fsr_etcut {this, "far_fsr_etcut", 10000.0 , "Minimum et cut for far fsr" }

private

Definition at line 94 of file FsrPhotonTool.h.

{this, "far_fsr_etcut", 10000.0 , "Minimum et cut for far fsr" };

m_far_fsr_isoWorkingPoint

Gaudi::Property<std::string> FSR::FsrPhotonTool::m_far_fsr_isoWorkingPoint {this, "far_fsr_isoWorkingPoint", "FixedCutLoose", "Far fsr isolation working point" }

private

Definition at line 100 of file FsrPhotonTool.h.

{this, "far_fsr_isoWorkingPoint", "FixedCutLoose", "Far fsr isolation working point" };

m_fsr_type

FsrCandidate::FsrType FSR::FsrPhotonTool::m_fsr_type

private

Definition at line 109 of file FsrPhotonTool.h.

m_fsrPhotons

std::vector<FsrCandidate> FSR::FsrPhotonTool::m_fsrPhotons

private

Definition at line 108 of file FsrPhotonTool.h.

m_high_et_min

Gaudi::Property<double> FSR::FsrPhotonTool::m_high_et_min {this, "high_et_min", 3500. , "Minimum Et cut for higg Et photons" }

private

Definition at line 90 of file FsrPhotonTool.h.

{this, "high_et_min", 3500. , "Minimum Et cut for higg Et photons" };

m_is_mc

Gaudi::Property<bool> FSR::FsrPhotonTool::m_is_mc {this, "IsMC", true , "Is MC" }

private

Definition at line 104 of file FsrPhotonTool.h.

{this, "IsMC", true , "Is MC" };

m_isoSelTool

ToolHandle<CP::IIsolationSelectionTool> FSR::FsrPhotonTool::m_isoSelTool

private

Definition at line 111 of file FsrPhotonTool.h.

m_overlap_el_mu

Gaudi::Property<double> FSR::FsrPhotonTool::m_overlap_el_mu {this, "overlap_el_mu", 0.001 , "Overlap dR for electrons and muons" }

private

Definition at line 92 of file FsrPhotonTool.h.

{this, "overlap_el_mu", 0.001 , "Overlap dR for electrons and muons" };

m_overlap_el_ph

Gaudi::Property<double> FSR::FsrPhotonTool::m_overlap_el_ph {this, "overlap_el_ph", 0.01 , "Overlap dR for electrons and photons" }

private

Definition at line 91 of file FsrPhotonTool.h.

{this, "overlap_el_ph", 0.01 , "Overlap dR for electrons and photons" };

m_phIsGoodOQSelectionTool

ToolHandle<IAsgSelectionTool> FSR::FsrPhotonTool::m_phIsGoodOQSelectionTool

private

Definition at line 114 of file FsrPhotonTool.h.

m_suppresEnergyRescaling

Gaudi::Property<bool> FSR::FsrPhotonTool::m_suppresEnergyRescaling {this, "SuppressEnergyRescaling", false , "flag to suppress energy rescaling - should only be used for testing purposes, e.g. test w/o calib for PhysLite " }

private

Definition at line 102 of file FsrPhotonTool.h.

{this, "SuppressEnergyRescaling", false , "flag to suppress energy rescaling - should only be used for testing purposes, e.g. test w/o calib for PhysLite " };

m_topo_drcut

Gaudi::Property<double> FSR::FsrPhotonTool::m_topo_drcut {this, "topo_drcut", 0.08 , "Maximum dR cut for low Et clusters" }

private

Definition at line 98 of file FsrPhotonTool.h.

{this, "topo_drcut",  0.08 , "Maximum dR cut for low Et clusters" };

m_topo_f1cut

Gaudi::Property<double> FSR::FsrPhotonTool::m_topo_f1cut {this, "topo_f1cut", 0.2 , "Minimum f1 cut for low Et clusters" }

private

Definition at line 99 of file FsrPhotonTool.h.

{this, "topo_f1cut", 0.2 , "Minimum f1 cut for low Et clusters" };

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:

• FsrPhotonTool.h
• FsrPhotonTool.cxx