EMPIDBuilder Class Reference

egamma tool to add selector outputs to the egamma objects Note: Subject to change after the PAT selectors evolve More...

#include <EMPIDBuilder.h>

Inheritance diagram for EMPIDBuilder:

Collaboration diagram for EMPIDBuilder:

Public Member Functions
	EMPIDBuilder (const std::string &type, const std::string &name, const IInterface *parent)
	Default constructor.
virtual	~EMPIDBuilder ()=default
	Destructor.
virtual StatusCode	initialize () override final
	initialize method
virtual StatusCode	execute (const EventContext &ctx, xAOD::Egamma *) const override final
	standard execute method
virtual StatusCode	finalize () override
	finalize method
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 ()
	AthAlgTool interface methods.

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
ToolHandleArray< IAsgElectronIsEMSelector >	m_electronIsEMselectors
	Handle to the selectors.
Gaudi::Property< std::vector< std::string > >	m_electronIsEMselectorResultNames
ToolHandleArray< IAsgElectronLikelihoodTool >	m_electronLHselectors
Gaudi::Property< std::vector< std::string > >	m_electronLHselectorResultNames
ToolHandleArray< IAsgSelectionTool >	m_genericIsEMselectors
Gaudi::Property< std::vector< std::string > >	m_genericIsEMselectorResultNames
ToolHandleArray< IAsgPhotonIsEMSelector >	m_photonIsEMselectors
Gaudi::Property< std::vector< std::string > >	m_photonIsEMselectorResultNames
ToolHandle< ILumiBlockMuTool >	m_lumiBlockMuTool
Gaudi::Property< std::string >	m_LHValueName
Gaudi::Property< bool >	m_UselumiBlockMuTool
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

egamma tool to add selector outputs to the egamma objects Note: Subject to change after the PAT selectors evolve

Author

Jovan Mitrevski Jovan.nosp@m..Mit.nosp@m.revsk.nosp@m.i@ce.nosp@m.rn.ch

Definition at line 28 of file EMPIDBuilder.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

EMPIDBuilder()

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

Default constructor.

Definition at line 14 of file EMPIDBuilder.cxx.

  : egammaBaseTool(type, name, parent)
{
  // declare interface
  declareInterface<IegammaBaseTool>(this);
}

~EMPIDBuilder()

virtual EMPIDBuilder::~EMPIDBuilder ( )

virtualdefault

Destructor.

Member Function Documentation

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

execute()

StatusCode EMPIDBuilder::execute ( const EventContext & ctx, xAOD::Egamma * eg ) const

finaloverridevirtual

standard execute method

Implements IegammaBaseTool.

Definition at line 75 of file EMPIDBuilder.cxx.

{
 
  ATH_MSG_DEBUG("Executing EMPIDBuilder::execute");
 
  // Protection against bad pointers
  if (eg == nullptr) {
    ATH_MSG_WARNING("NULL egamma object given to execute function");
    return StatusCode::SUCCESS;
  }
 
  size_t size = m_electronIsEMselectors.size();
 
  for (size_t i = 0; i < size; ++i) {
    asg::AcceptData accept = m_electronIsEMselectors[i]->accept(ctx, eg);
    // save the bool result
    eg->setPassSelection(static_cast<bool>(accept),
                         m_electronIsEMselectorResultNames[i]);
    // save the isem
    unsigned int isEM = (~0);
    if (m_electronIsEMselectors[i]->execute(ctx, eg, isEM).isFailure()) {
      ATH_MSG_ERROR("problem to get isEM for "
                    << m_electronIsEMselectorResultNames[i]);
      return StatusCode::FAILURE;
    }
    eg->setSelectionisEM(isEM, "isEM" + m_electronIsEMselectorResultNames[i]);
  }
 
  size_t sizePh = m_photonIsEMselectors.size();
 
  for (size_t i = 0; i < sizePh; ++i) {
    asg::AcceptData accept = m_photonIsEMselectors[i]->accept(ctx, eg);
    // save the bool result
    eg->setPassSelection(static_cast<bool>(accept),
                         m_photonIsEMselectorResultNames[i]);
    // save the isem
    unsigned int isEM = ~0;
    if (m_photonIsEMselectors[i]->execute(ctx, eg, isEM).isFailure()) {
      ATH_MSG_ERROR("problem to get isEM for "
                    << m_photonIsEMselectorResultNames[i]);
      return StatusCode::FAILURE;
    }
    eg->setSelectionisEM(isEM, "isEM" + m_photonIsEMselectorResultNames[i]);
  }
 
  size_t sizeLH = m_electronLHselectors.size();
 
  // negative mu means the default behaviour --> retrieve the one in xAOD
  double mu = -99.;
  double avg_mu = -99.;
  if (m_UselumiBlockMuTool) { //
    mu = m_lumiBlockMuTool->actualInteractionsPerCrossing(ctx);
    avg_mu = m_lumiBlockMuTool->averageInteractionsPerCrossing(ctx);
    ATH_MSG_DEBUG("REGTEST: Retrieved Mu Value : " << mu);
    ATH_MSG_DEBUG("REGTEST: Average Mu Value   : " << avg_mu);
  }
 
  for (size_t i = 0; i < sizeLH; ++i) {
    asg::AcceptData accept = m_electronLHselectors[i]->accept(ctx, eg, avg_mu);
    // save the bool result
    eg->setPassSelection(static_cast<bool>(accept),
                         m_electronLHselectorResultNames[i]);
    // save the isem
    eg->setSelectionisEM(
      static_cast<unsigned int>(accept.getCutResultInverted()),
      "isEM" + m_electronLHselectorResultNames[i]);
 
    // save the LHValue only once
    if (i == 0) {
      accLH(*eg) = static_cast<float>(
        m_electronLHselectors[i]->calculate(ctx, eg, avg_mu));
    }
  }
 
  size_t sizeGen = m_genericIsEMselectors.size();
  for (size_t i = 0; i < sizeGen; ++i) {
    asg::AcceptData accept = m_genericIsEMselectors[i]->accept(eg);
    // save the bool result
    eg->setPassSelection(static_cast<bool>(accept),
                         m_genericIsEMselectorResultNames[i]);
    // save the isem
    eg->setSelectionisEM(
      static_cast<unsigned int>(accept.getCutResultInverted()),
      "isEM" + m_genericIsEMselectorResultNames[i]);
  }
 
  return StatusCode::SUCCESS;
}

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 egammaBaseTool::finalize ( )

overridevirtualinherited

finalize method

Implements IegammaBaseTool.

Definition at line 22 of file egammaBaseTool.cxx.

{
  return StatusCode::SUCCESS;
}

initialize()

StatusCode EMPIDBuilder::initialize ( )

finaloverridevirtual

initialize method

Reimplemented from egammaBaseTool.

Definition at line 24 of file EMPIDBuilder.cxx.

{
  ATH_MSG_DEBUG(" Initializing EMPIDBuilder");
 
  ATH_CHECK(m_electronIsEMselectors.retrieve());
 
  if (m_electronIsEMselectors.size() !=
      m_electronIsEMselectorResultNames.size()) {
    ATH_MSG_ERROR("The number of selectors does not match the number of given "
                  "electronIsEMselector names");
    return StatusCode::FAILURE;
  }
 
  ATH_CHECK(m_electronLHselectors.retrieve());
 
  if (m_electronLHselectors.size() != m_electronLHselectorResultNames.size()) {
    ATH_MSG_ERROR("The number of selectors does not match the number of given "
                  "electron LH selector names");
    return StatusCode::FAILURE;
  }
 
  ATH_CHECK(m_genericIsEMselectors.retrieve());
 
  if (m_genericIsEMselectors.size() !=
      m_genericIsEMselectorResultNames.size()) {
    ATH_MSG_ERROR("The number of selectors does not match the number of given "
                  "generic selector names");
    return StatusCode::FAILURE;
  }
 
  ATH_CHECK(m_photonIsEMselectors.retrieve());
 
  if (m_photonIsEMselectors.size() != m_photonIsEMselectorResultNames.size()) {
    ATH_MSG_ERROR("The number of selectors does not match the number of given "
                  "photon selector names");
    return StatusCode::FAILURE;
  }
 
  if (m_UselumiBlockMuTool) {
    if (m_lumiBlockMuTool.retrieve().isFailure()) {
      ATH_MSG_FATAL("Unable to retrieve Luminosity Tool");
      return StatusCode::FAILURE;
    }
    ATH_MSG_DEBUG("Successfully retrieved Luminosity Tool");
  } else {
    m_lumiBlockMuTool.disable();
  }
  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 & IegammaBaseTool::interfaceID ( )

inlinestaticinherited

AthAlgTool interface methods.

Definition at line 48 of file IegammaBaseTool.h.

{
  return IID_IegammaBaseTool;
}

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

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_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_electronIsEMselectorResultNames

Gaudi::Property<std::vector<std::string> > EMPIDBuilder::m_electronIsEMselectorResultNames

private

Initial value:

{
    this,
    "electronIsEMselectorResultNames",
    {},
    "The selector result names"
  }

Definition at line 53 of file EMPIDBuilder.h.

                                                                       {
    this,
    "electronIsEMselectorResultNames",
    {},
    "The selector result names"
  };

m_electronIsEMselectors

ToolHandleArray<IAsgElectronIsEMSelector> EMPIDBuilder::m_electronIsEMselectors

private

Initial value:

{
    this,
    "electronIsEMselectors",
    {},
    "The selectors that we need to apply to the Electron object"
  }

Handle to the selectors.

Definition at line 47 of file EMPIDBuilder.h.

                                                                   {
    this,
    "electronIsEMselectors",
    {},
    "The selectors that we need to apply to the Electron object"
  };

m_electronLHselectorResultNames

Gaudi::Property<std::vector<std::string> > EMPIDBuilder::m_electronLHselectorResultNames

private

Initial value:

{
    this,
    "electronLHselectorResultNames",
    {},
    "The selector result names"
  }

Definition at line 66 of file EMPIDBuilder.h.

                                                                     {
    this,
    "electronLHselectorResultNames",
    {},
    "The selector result names"
  };

m_electronLHselectors

ToolHandleArray<IAsgElectronLikelihoodTool> EMPIDBuilder::m_electronLHselectors

private

Initial value:

{
    this,
    "electronLHselectors",
    {},
    "The selectors that we need to apply to the LH electron object"
  }

Definition at line 60 of file EMPIDBuilder.h.

                                                                   {
    this,
    "electronLHselectors",
    {},
    "The selectors that we need to apply to the LH electron object"
  };

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_genericIsEMselectorResultNames

Gaudi::Property<std::vector<std::string> > EMPIDBuilder::m_genericIsEMselectorResultNames

private

Initial value:

{
    this,
    "genericIsEMselectorResultNames",
    {},
    "The selector result names"
  }

Definition at line 80 of file EMPIDBuilder.h.

                                                                      {
    this,
    "genericIsEMselectorResultNames",
    {},
    "The selector result names"
  };

m_genericIsEMselectors

ToolHandleArray<IAsgSelectionTool> EMPIDBuilder::m_genericIsEMselectors

private

Initial value:

{
    this,
    "genericIsEMselectors",
    {},
    "The selectors that we need to apply to the generic object"
  }

Definition at line 73 of file EMPIDBuilder.h.

                                                           {
    this,
    "genericIsEMselectors",
    {},
    "The selectors that we need to apply to the generic object"
  };

m_LHValueName

Gaudi::Property<std::string> EMPIDBuilder::m_LHValueName

private

Initial value:

{ this,
                                              "LHValueName",
                                              "LHValue",
                                              "The LH Value name" }

Definition at line 107 of file EMPIDBuilder.h.

                                        { this,
                                              "LHValueName",
                                              "LHValue",
                                              "The LH Value name" };

m_lumiBlockMuTool

ToolHandle<ILumiBlockMuTool> EMPIDBuilder::m_lumiBlockMuTool

private

Initial value:

{
    this,
    "LuminosityTool",
    "LumiBlockMuTool/LumiBlockMuTool",
    "Luminosity Tool"
  }

Definition at line 100 of file EMPIDBuilder.h.

                                                {
    this,
    "LuminosityTool",
    "LumiBlockMuTool/LumiBlockMuTool",
    "Luminosity Tool"
  };

m_photonIsEMselectorResultNames

Gaudi::Property<std::vector<std::string> > EMPIDBuilder::m_photonIsEMselectorResultNames

private

Initial value:

{
    this,
    "photonIsEMselectorResultNames",
    {},
    "The selector result names"
  }

Definition at line 93 of file EMPIDBuilder.h.

                                                                     {
    this,
    "photonIsEMselectorResultNames",
    {},
    "The selector result names"
  };

m_photonIsEMselectors

ToolHandleArray<IAsgPhotonIsEMSelector> EMPIDBuilder::m_photonIsEMselectors

private

Initial value:

{
    this,
    "photonIsEMselectors",
    {},
    "The selectors that we need to apply to the pothon object"
  }

Definition at line 87 of file EMPIDBuilder.h.

                                                               {
    this,
    "photonIsEMselectors",
    {},
    "The selectors that we need to apply to the pothon object"
  };

m_UselumiBlockMuTool

Gaudi::Property<bool> EMPIDBuilder::m_UselumiBlockMuTool

private

Initial value:

{
    this,
    "UseLuminosityTool",
    false,
    "Use Luminosity Tool instead of value stored in xAOD"
  }

Definition at line 112 of file EMPIDBuilder.h.

                                          {
    this,
    "UseLuminosityTool",
    false,
    "Use Luminosity Tool instead of value stored in xAOD"
  };

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:

• EMPIDBuilder.h
• EMPIDBuilder.cxx