Retrieves the Electron objects (Electrons etc.). More...

#include <xAODElectronRetriever.h>

Inheritance diagram for JiveXML::xAODElectronRetriever:

Collaboration diagram for JiveXML::xAODElectronRetriever:

Public Member Functions
	xAODElectronRetriever (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Constructor.
virtual StatusCode	retrieve (ToolHandle< IFormatTool > &FormatTool)
	For each electron collection retrieve basic parameters.
virtual StatusCode	initialize ()
const DataMap	getData (const xAOD::ElectronContainer *)
	Puts the variables into a DataMap.
virtual std::string	dataTypeName () const
	Return the name of the data type that is generated by this retriever.
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Return the interface identifier.

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
const std::string	m_typeName = "Electron"
	The data type that is generated by this retriever.
SG::ReadHandleKeyArray< xAOD::ElectronContainer >	m_keys {this,"ElectronCollections", {"Electrons"}, "Name of the Electron containers that will be written out to the JiveXML file"}
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

Retrieves the Electron objects (Electrons etc.).

Properties
- ElectronCollections
Retrieved Data
- Usual four-vectors: phi, eta, et etc.
- Associations for clusters and tracks via ElementLink: key/index scheme

Definition at line 29 of file xAODElectronRetriever.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 376 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ xAODElectronRetriever()

JiveXML::xAODElectronRetriever::xAODElectronRetriever	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Standard Constructor.

This is the standard AthAlgTool constructor.

Parameters

type	AlgTool type name
name	AlgTool instance name
parent	AlgTools parent owning this tool

Definition at line 19 of file xAODElectronRetriever.cxx.

                                                                                                                  :
    AthAlgTool(type,name,parent)
  {}

Member Function Documentation

◆ dataTypeName()

virtual std::string JiveXML::xAODElectronRetriever::dataTypeName ( ) const

inlinevirtual

Return the name of the data type that is generated by this retriever.

Implements JiveXML::IDataRetriever.

Definition at line 42 of file xAODElectronRetriever.h.

42{ return m_typeName; };

JiveXML::xAODElectronRetriever::m_typeName

const std::string m_typeName

The data type that is generated by this retriever.

Definition xAODElectronRetriever.h:46

◆ 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.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:381

◆ 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.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:378

◆ 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

◆ getData()

const DataMap JiveXML::xAODElectronRetriever::getData ( const xAOD::ElectronContainer * elCont )

Puts the variables into a DataMap.

Retrieve basic parameters, mainly four-vectors, for each collection.

Also association with clusters and tracks (ElementLink).

Definition at line 59 of file xAODElectronRetriever.cxx.

                                                                                  {
 
    ATH_MSG_DEBUG("in getData()");
 
    DataMap DataMap;
 
    DataVect pt; pt.reserve(elCont->size());
    DataVect phi; phi.reserve(elCont->size());
    DataVect eta; eta.reserve(elCont->size());
    DataVect mass; mass.reserve(elCont->size());
    DataVect energy; energy.reserve(elCont->size());
    DataVect pdgId; energy.reserve(elCont->size());
 
    DataVect isEMString; isEMString.reserve(elCont->size());
    DataVect author; author.reserve(elCont->size());
    DataVect label; label.reserve(elCont->size());
 
    xAOD::ElectronContainer::const_iterator elItr  = elCont->begin();
    xAOD::ElectronContainer::const_iterator elItrE = elCont->end();
 
    int counter = 0;
    auto prefix = [](const std::string & root)->std::string {
      return '_' + root;
    };
    for (; elItr != elItrE; ++elItr) {
 
      std::string electronAuthor = "";
      std::string electronIsEMString = "none";
      std::string electronLabel = "";
      phi.emplace_back(DataType((*elItr)->phi()));
      eta.emplace_back(DataType((*elItr)->eta()));
      pt.emplace_back(DataType((*elItr)->pt()/GeV));
      mass.emplace_back(DataType((*elItr)->m()/GeV));
      energy.emplace_back( DataType((*elItr)->e()/GeV ));
 
      if ((*elItr)->trackParticle()){ // ForwardElectrons have no track !
    pdgId.emplace_back(DataType( -11.*(*elItr)->trackParticle()->charge() )); // pdgId not available anymore in xAOD
      }else{
    pdgId.emplace_back(DataType( 0. ) );
      }
 
      ATH_MSG_DEBUG("  Electron #" << counter++ << " : eta = "  << (*elItr)->eta() << ", phi = "
            << (*elItr)->phi()
            // << ", ntrk = " << (*elItr)->getNumberOfTrackParticles()
            << ", author = " << (*elItr)->author()
            // these don't work for ForwardElectrons !
            // << ", isEM/Tight: " << (*elItr)->passSelection(passesTight, "Tight")
            // << ", charge = " << (*elItr)->trackParticle()->charge()
            // << ", pdgId = " << -11.*(*elItr)->trackParticle()->charge()
            );
 
 
      bool passesTight(false);
      bool passesMedium(false);
      bool passesLoose(false);
      static const std::string tightStr{"Tight"};
      const bool tightSelectionExists = (*elItr)->passSelection(passesTight, tightStr);
      ATH_MSG_VERBOSE("tight exists " << tightSelectionExists
              << " and passes? " << passesTight);
          static const std::string mediumStr{"Medium"};
      const bool mediumSelectionExists = (*elItr)->passSelection(passesMedium, mediumStr);
      ATH_MSG_VERBOSE("medium exists " << mediumSelectionExists
              << " and passes? " << passesMedium);
          static const std::string looseStr{"Loose"};
      const bool looseSelectionExists = (*elItr)->passSelection(passesLoose, looseStr);
      ATH_MSG_VERBOSE("loose exists " << looseSelectionExists
              << " and passes? " << passesLoose);
 
      electronAuthor = "author"+DataType( (*elItr)->author() ).toString(); // for odd ones eg FWD
      electronLabel = electronAuthor;
      if (( (*elItr)->author()) == 0){ electronAuthor = "unknown"; electronLabel += "_unknown"; }
      if (( (*elItr)->author()) == 8){ electronAuthor = "forward"; electronLabel += "_forward"; }
      if (( (*elItr)->author()) == 2){ electronAuthor = "softe"; electronLabel += "_softe"; }
      if (( (*elItr)->author()) == 1){ electronAuthor = "egamma"; electronLabel += "_egamma"; }
 
      if ( passesLoose ){
    electronLabel += prefix(looseStr);
    electronIsEMString = looseStr; // assume that hierarchy is obeyed !
      }
      if ( passesMedium ){
    electronLabel += prefix(mediumStr);
    electronIsEMString = mediumStr; // assume that hierarchy is obeyed !
      }
      if ( passesTight ){
    electronLabel += prefix(tightStr);
    electronIsEMString = tightStr; // assume that hierarchy is obeyed !
      }
      author.emplace_back( DataType( electronAuthor ) );
      label.emplace_back( DataType( electronLabel ) );
      isEMString.emplace_back( DataType( electronIsEMString ) );
 
    } // end ElectronIterator
 
    // four-vectors
    std::size_t nEntries = phi.size();
    DataMap["phi"] = std::move(phi);
    DataMap["eta"] = std::move(eta);
    DataMap["pt"] = std::move(pt);
    DataMap["energy"] = std::move(energy);
    DataMap["mass"] = std::move(mass);
    DataMap["pdgId"] = std::move(pdgId);
    DataMap["isEMString"] = std::move(isEMString);
    DataMap["label"] = std::move(label);
    DataMap["author"] = std::move(author);
 
    ATH_MSG_DEBUG(dataTypeName() << " retrieved with " << nEntries << " entries");
 
    return DataMap;
  }

◆ initialize()

StatusCode JiveXML::xAODElectronRetriever::initialize ( )

virtual

Definition at line 24 of file xAODElectronRetriever.cxx.

                                              {
    ATH_CHECK(m_keys.initialize());
    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.

◆ interfaceID()

const InterfaceID & JiveXML::IDataRetriever::interfaceID ( )

inlinestaticinherited

Return the interface identifier.

Definition at line 40 of file IDataRetriever.h.

40{ return IID_IDataRetriever; }

JiveXML::IID_IDataRetriever

static const InterfaceID IID_IDataRetriever("JiveXML::IDataRetriever", 3, 0)

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ 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.

◆ 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 368 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 352 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ retrieve()

StatusCode JiveXML::xAODElectronRetriever::retrieve ( ToolHandle< IFormatTool > & FormatTool )

virtual

For each electron collection retrieve basic parameters.

Parameters

FormatTool the tool that will create formated output from the DataMap

Implements JiveXML::IDataRetriever.

Definition at line 33 of file xAODElectronRetriever.cxx.

                                                                                {
 
    ATH_MSG_DEBUG("in retrieve()");
 
    // Loop through the keys and retrieve the corresponding data
    for (const auto& key : m_keys) {
      SG::ReadHandle<xAOD::ElectronContainer> cont(key);
      if (cont.isValid()) {
    DataMap data = getData(&(*cont));
    if (FormatTool->AddToEvent(dataTypeName(), key.key() + "_xAOD", &data).isFailure()) {
      ATH_MSG_WARNING("Failed to add collection " << key.key());
    } else {
      ATH_MSG_DEBUG(" (" << key.key() << ") retrieved");
    }
      } else {
    ATH_MSG_WARNING("Collection " << key.key() << " not found in SG");
      }
    }
    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 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 298 of file AthCommonDataStore.h.

                                               {
    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< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 381 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 378 of file AthCommonDataStore.h.

◆ m_keys

SG::ReadHandleKeyArray<xAOD::ElectronContainer> JiveXML::xAODElectronRetriever::m_keys {this,"ElectronCollections", {"Electrons"}, "Name of the Electron containers that will be written out to the JiveXML file"}

private

Definition at line 48 of file xAODElectronRetriever.h.

48{this,"ElectronCollections", {"Electrons"}, "Name of the Electron containers that will be written out to the JiveXML file"};

◆ m_typeName

const std::string JiveXML::xAODElectronRetriever::m_typeName = "Electron"

private

The data type that is generated by this retriever.

Definition at line 46 of file xAODElectronRetriever.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 387 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 386 of file AthCommonDataStore.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ xAODElectronRetriever()

Member Function Documentation

◆ dataTypeName()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getData()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ retrieve()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_keys

◆ m_typeName

◆ m_varHandleArraysDeclared

◆ m_vhka