testAthenaPhotonAlg Class Reference

#include <testAthenaPhotonAlg.h>

Inheritance diagram for testAthenaPhotonAlg:

Collaboration diagram for testAthenaPhotonAlg:

Public Member Functions
	testAthenaPhotonAlg (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~testAthenaPhotonAlg ()
virtual StatusCode	initialize ()
virtual StatusCode	execute ()
virtual StatusCode	finalize ()
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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	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

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
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< IAsgPhotonEfficiencyCorrectionTool >	m_photonSF
	The tool handle to our photon efficiency correction.
DataObjIDColl	m_extendedExtraObjects
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 14 of file testAthenaPhotonAlg.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

testAthenaPhotonAlg()

testAthenaPhotonAlg::testAthenaPhotonAlg	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 15 of file testAthenaPhotonAlg.cxx.

                                                                                          : AthAlgorithm( name, pSvcLocator ),  m_photonSF("AsgPhotonEfficiencyCorrectionTool/AsgPhotonEfficiencyCorrectionTool",this){
 
  //declareProperty( "Property", m_nProperty ); //example property declaration
  declareProperty( "PhotonEfficiencyCorrectionTool", m_photonSF );
}

~testAthenaPhotonAlg()

testAthenaPhotonAlg::~testAthenaPhotonAlg ( )

virtualdefault

Member Function Documentation

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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; }

execute()

StatusCode testAthenaPhotonAlg::execute ( )

virtual

Definition at line 38 of file testAthenaPhotonAlg.cxx.

                                        {  
  ATH_MSG_DEBUG ("Executing " << name() << "...");
 
//----------------------------
 // Event information
 //--------------------------- 
 const xAOD::EventInfo* eventInfo = nullptr; //NOTE: Everything that comes from the storegate direct from the input files is const!
 
 // ask the event store to retrieve the xAOD EventInfo container
 //ATH_CHECK( evtStore()->retrieve( eventInfo, "EventInfo") );  // the second argument ("EventInfo") is the key name
 ATH_CHECK( evtStore()->retrieve( eventInfo) );
 // if there is only one container of that type in the xAOD (as with the EventInfo container), you do not need to pass
 // the key name, the default will be taken as the only key name in the xAOD 
 
 // check if data or MC
 bool isMC = true;
 if(!eventInfo->eventType(xAOD::EventInfo::IS_SIMULATION ) ){
   isMC = false;
 }
 if(!isMC) ATH_MSG_ERROR("This is data, no scale factors should be used on the data!");
 
 //---------
 // photons
 //---------
 const xAOD::PhotonContainer* photons = nullptr;
 ATH_CHECK( evtStore()->retrieve( photons, "Photons") );
 ATH_MSG_DEBUG("Found "<<photons->size() <<" photons in event, itterate....");
 
// Let's create a shallow copy of the const photon container, and decorate it with the obtained SF
auto inContShallowCopy = xAOD::shallowCopyContainer( *photons );
 
//creates a new photon container to hold the subset as well as the needed auxiliary container
  xAOD::PhotonContainer* myphotons = new xAOD::PhotonContainer;
  xAOD::PhotonAuxContainer* myphotonsAux = new xAOD::PhotonAuxContainer;
  // You need to tell the photon container in which auxiliary container it should write its member variables
  myphotons->setStore( myphotonsAux ); //gives it a new associated aux container
 
  // Also record to storegate: you must record both the container and the auxcontainer.
  // Note that storegate takes ownership of these objects, i.e., you must not try to delete them yourself.
  ATH_CHECK( evtStore()->record(myphotons,  "MyPhotons" ) );
  ATH_CHECK( evtStore()->record(myphotonsAux, "MyPhotonsAux" ) );
 
// Loop over all Photons in the shallow-copy container, decorate it with SF, and store in new xAOD file, in addition print out all SF (with get* function)
for ( xAOD::Photon* ph : *(inContShallowCopy.first) ) {
 
  //if ( std::abs(ph->eta()) > 2.37 || ph->pt()<15000. ) continue;
  //if (std::abs(ph->eta())>=1.37 && std::abs(ph->eta())<=1.52) continue;
  ATH_MSG_DEBUG( "  photon pt = " << ph->pt() <<", photon eta = " << ph->eta() );
 
  double SF, SFerr; // for photon SF and the apropriate error
  if(!m_photonSF->getEfficiencyScaleFactor(*ph,SF)){
    ATH_MSG_WARNING( "Couldn't get photon scale factor!" );
    continue;
  }
  if(!m_photonSF->getEfficiencyScaleFactorError(*ph,SFerr)){
    ATH_MSG_WARNING( "Couldn't get photon scale factor uncertainty!" );
    continue;
  }
  ATH_MSG_DEBUG( "  photon SF = " << SF <<", photon SF sys error = " << SFerr );
  
  // applyEfficiencyScaleFactor - decorate the object (*photon)
  if ( m_photonSF->applyEfficiencyScaleFactor(*ph) == CP::CorrectionCode::Error ) {
    ATH_MSG_ERROR("PhotonEfficiencyCorrectionTool reported a CP::CorrectionCode::Error");
    return StatusCode::FAILURE;
  }
 
  myphotons->push_back(ph); // add it to a new photon container which will be writed to a new file
} // and loop on photons
 
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

finalize()

StatusCode testAthenaPhotonAlg::finalize ( )

virtual

Definition at line 31 of file testAthenaPhotonAlg.cxx.

                                         {
  ATH_MSG_INFO ("Finalizing " << name() << "...");
  // Clean up
  ATH_CHECK( m_photonSF.release() );
  return StatusCode::SUCCESS;
}

initialize()

StatusCode testAthenaPhotonAlg::initialize ( )

virtual

Definition at line 24 of file testAthenaPhotonAlg.cxx.

                                           {
  ATH_MSG_INFO ("Initializing " << name() << "...");
  // Retrieve the tool
  ATH_CHECK( m_photonSF.retrieve() );
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::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.

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Algorithm >::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< Algorithm > >::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.

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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

m_photonSF

ToolHandle< IAsgPhotonEfficiencyCorrectionTool > testAthenaPhotonAlg::m_photonSF

private

The tool handle to our photon efficiency correction.

Definition at line 25 of file testAthenaPhotonAlg.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• testAthenaPhotonAlg.h
• testAthenaPhotonAlg.cxx