#include <TruthParticlesInConeTool.h>

Inheritance diagram for xAOD::TruthParticlesInConeTool:

Collaboration diagram for xAOD::TruthParticlesInConeTool:

Public Types
typedef IParticlesLookUpTable< TruthParticle >	LookUpTable

Public Member Functions
	TruthParticlesInConeTool (const std::string &type, const std::string &name, const IInterface *parent)
	constructor
virtual	~TruthParticlesInConeTool ()=default
	destructor
virtual StatusCode	initialize () override final
	initialize
virtual bool	particlesInCone (const EventContext &ctx, float eta, float phi, float dr, std::vector< const TruthParticle * > &output) const override final
	ITruthParticlesInConeTool interface.
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 ()

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

Private Attributes
SG::ReadHandleKey< TruthParticleContainer >	m_truthParticleLocation
	Truth Particle collection name.
SG::ReadHandleKey< LookUpTable >	m_LookUpTableCacheRead { "LookUpTable" }
SG::WriteHandleKey< LookUpTable >	m_LookUpTableCacheWrite { "LookUpTable" }
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 19 of file TruthParticlesInConeTool.h.

Member Typedef Documentation

◆ LookUpTable

typedef IParticlesLookUpTable<TruthParticle> xAOD::TruthParticlesInConeTool::LookUpTable

Definition at line 43 of file TruthParticlesInConeTool.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ TruthParticlesInConeTool()

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

constructor

Definition at line 15 of file TruthParticlesInConeTool.cxx.

  : AthAlgTool(type, name, parent)
{
  declareInterface<ITruthParticlesInConeTool>(this);
}

◆ ~TruthParticlesInConeTool()

virtual xAOD::TruthParticlesInConeTool::~TruthParticlesInConeTool ( )

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.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ 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:390

◆ 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

◆ getTable()

const TruthParticlesInConeTool::LookUpTable * xAOD::TruthParticlesInConeTool::getTable ( const EventContext & ctx ) const

private

Definition at line 37 of file TruthParticlesInConeTool.cxx.

{
  SG::ReadHandle<LookUpTable> rh(m_LookUpTableCacheRead, ctx);
  if (rh.isValid()) {
    return &*rh;
  }
  SG::ReadHandle<TruthParticleContainer> truthParticles(m_truthParticleLocation,
                                                        ctx);
  if (!truthParticles.isValid()) {
    ATH_MSG_ERROR("Could not open a TruthParticle container with key "
                  << m_truthParticleLocation.key());
    return nullptr;
  }
  auto lut = std::make_unique<LookUpTable>();
  lut->init(*truthParticles);
  SG::WriteHandle<LookUpTable> wh(m_LookUpTableCacheWrite, ctx);
  return wh.put(std::move(lut), true);
}

◆ initialize()

StatusCode xAOD::TruthParticlesInConeTool::initialize ( )

finaloverridevirtual

initialize

Definition at line 25 of file TruthParticlesInConeTool.cxx.

{
  ATH_CHECK(m_truthParticleLocation.initialize());
  const std::string tableName = name() + "LookUpTable";
  m_LookUpTableCacheRead = tableName;
  m_LookUpTableCacheWrite = tableName;
  ATH_CHECK(m_LookUpTableCacheRead.initialize());
  ATH_CHECK(m_LookUpTableCacheWrite.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 & xAOD::ITruthParticlesInConeTool::interfaceID ( )

inlinestaticinherited

Definition at line 46 of file ITruthParticlesInConeTool.h.

{
  return IID_ITruthParticlesInConeTool;
}

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

◆ particlesInCone()

bool xAOD::TruthParticlesInConeTool::particlesInCone	(	const EventContext &	ctx,
		float	eta,
		float	phi,
		float	dr,
		std::vector< const TruthParticle * > &	output ) const

finaloverridevirtual

ITruthParticlesInConeTool interface.

initialize if needed

Implements xAOD::ITruthParticlesInConeTool.

Definition at line 57 of file TruthParticlesInConeTool.cxx.

{
  const LookUpTable* lut = getTable(ctx);
  return lut->iParticlesInCone(eta, phi, dr, output);
}

◆ 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_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_LookUpTableCacheRead

SG::ReadHandleKey<LookUpTable> xAOD::TruthParticlesInConeTool::m_LookUpTableCacheRead { "LookUpTable" }

private

Definition at line 56 of file TruthParticlesInConeTool.h.

56{ "LookUpTable" };

◆ m_LookUpTableCacheWrite

SG::WriteHandleKey<LookUpTable> xAOD::TruthParticlesInConeTool::m_LookUpTableCacheWrite { "LookUpTable" }

private

Definition at line 57 of file TruthParticlesInConeTool.h.

57{ "LookUpTable" };

◆ m_truthParticleLocation

SG::ReadHandleKey<TruthParticleContainer> xAOD::TruthParticlesInConeTool::m_truthParticleLocation

private

Initial value:

{
    this,
    "TruthParticleLocation",
    "TruthParticles"
  }

Truth Particle collection name.

Definition at line 50 of file TruthParticlesInConeTool.h.

                                                                 {
    this,
    "TruthParticleLocation",
    "TruthParticles"
  };

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ LookUpTable

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TruthParticlesInConeTool()

◆ ~TruthParticlesInConeTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getTable()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ particlesInCone()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_LookUpTableCacheRead

◆ m_LookUpTableCacheWrite

◆ m_truthParticleLocation

◆ m_varHandleArraysDeclared

◆ m_vhka