#include <TruthParticleBuilder.h>

Inheritance diagram for TruthParticleBuilder:

Collaboration diagram for TruthParticleBuilder:

Public Member Functions
	TruthParticleBuilder (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor with parameters:
virtual	~TruthParticleBuilder ()
	Destructor:
virtual StatusCode	initialize ()
	Athena Algorithm's Hooks.
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 Types
typedef ToolHandle< ITruthParticleFilterTool >	FilterTool_t
typedef ToolHandle< ITruthParticleCnvTool >	CnvTool_t

Protected Member Functions
	TruthParticleBuilder ()
	Default constructor:
void	setupFilterTool (Gaudi::Details::PropertyBase &doFiltering)
	Call-back method to configure the filter tool if needed (this is defined by the state of the "DoFiltering" property)
void	setupCnvTool (Gaudi::Details::PropertyBase &doTruthParticles)
	Call-back method to configure the converter tool if needed (this is defined by the state of the "DoTruthParticles" property)
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.

Protected Attributes
FilterTool_t	m_filterTool
	Pointer to the filter algtool (which will create the filtered McEventCollection)
CnvTool_t	m_cnvTool
	Pointer to the converter algtool which will create a TruthParticleContainer from the filtered McEventCollection.
BooleanProperty	m_doFiltering
	Switch to build or not a filtered McEventCollection.
BooleanProperty	m_doTruthParticles
	Switch to build or not the TruthParticleContainer from the filtered GenEvent.

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
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 25 of file TruthParticleBuilder.h.

Member Typedef Documentation

◆ CnvTool_t

typedef ToolHandle<ITruthParticleCnvTool> TruthParticleBuilder::CnvTool_t

protected

Definition at line 78 of file TruthParticleBuilder.h.

◆ FilterTool_t

typedef ToolHandle<ITruthParticleFilterTool> TruthParticleBuilder::FilterTool_t

protected

Definition at line 72 of file TruthParticleBuilder.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ TruthParticleBuilder() [1/2]

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

Constructor with parameters:

Public methods:

Constructors

Definition at line 30 of file TruthParticleBuilder.cxx.

                                                   : 
  AthAlgorithm ( name, pSvcLocator )
{
  //
  // Property declaration
  // 
  //declareProperty( "Property", m_nProperty );
 
  std::string descr = "";
//   descr += "Fully qualified name ('[class name]/[instance name]') of the ";
//   descr += "AlgTool to be ran to create a filtered McEventCollection\n";
//   descr += "ex: \"EtaPtFilterTool/EtaPtFilterTool\"";
//   declareProperty( "Filter", 
//         m_filterName = "EtaPtFilterTool",
//         descr );
//   m_filterName.declareUpdateHandler( &TruthParticleBuilder::setupFilterTool,
//                   this );
 
  descr  = "Pointer to the filter algtool (which will create the filtered ";
  descr += "McEventCollection)";
  declareProperty( "FilterTool",
           m_filterTool = FilterTool_t( "EtaPtFilterTool", 
                        this ),
           descr );
 
  descr  = "Pointer to the converter algtool which will create a ";
  descr += "TruthParticleContainer from the filtered McEventCollection";
  declareProperty( "CnvTool",
           m_cnvTool = CnvTool_t( "TruthParticleCnvTool", 
                      this ),
           descr );
 
  // switches
  descr  = "Switch to build or not a filtered McEventCollection";
  declareProperty( "DoFiltering", 
           m_doFiltering = true,
           descr );
  m_doFiltering.declareUpdateHandler( &TruthParticleBuilder::setupFilterTool,
                      this );
 
  descr  = "Switch to build or not the TruthParticleContainer from the ";
  descr += "filtered GenEvent";
  declareProperty( "DoTruthParticles", 
           m_doTruthParticles = true,
           descr );
  m_doTruthParticles.declareUpdateHandler( &TruthParticleBuilder::setupCnvTool,
                       this );
}

◆ ~TruthParticleBuilder()

TruthParticleBuilder::~TruthParticleBuilder ( )

virtual

Destructor:

Destructor.

Definition at line 82 of file TruthParticleBuilder.cxx.

83{}

◆ TruthParticleBuilder() [2/2]

TruthParticleBuilder::TruthParticleBuilder ( )

protected

Default constructor:

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.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

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

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode TruthParticleBuilder::execute ( )

virtual

Definition at line 106 of file TruthParticleBuilder.cxx.

{  
  ATH_MSG_DEBUG ("Executing " << name() << "...");
  
  // create a new McEventCollection (AOD) from an old one (ex:ESD)
  // apply some filtering criterion (if any)
  if ( m_doFiltering && 
       !m_filterTool->execute().isSuccess() ) {
    ATH_MSG_WARNING
      ("Could not build the AOD McEventCollection ! [algtool="
       << m_filterTool.type() << "]");
    return StatusCode::SUCCESS;
  }
  
  // create a TruthParticleContainer from a McEventCollection
  if ( m_doTruthParticles && 
       !m_cnvTool->execute().isSuccess() ) {
    ATH_MSG_WARNING 
      ("Could not convert the AOD McEventCollection into "\
       "a TruthParticleContainer !");
    return StatusCode::SUCCESS;
  }
 
  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 TruthParticleBuilder::finalize ( )

virtual

Definition at line 100 of file TruthParticleBuilder.cxx.

{
  ATH_MSG_INFO ("Finalizing " << name() << "...");
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode TruthParticleBuilder::initialize ( )

virtual

Athena Algorithm's Hooks.

Definition at line 87 of file TruthParticleBuilder.cxx.

{
  ATH_MSG_INFO ("Initializing " << name() << "...");
 
  // setup the filter tool
  setupFilterTool( m_doFiltering );
  
  // setup the converter tool
  setupCnvTool( m_doTruthParticles );
 
  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();
  }

◆ setupCnvTool()

void TruthParticleBuilder::setupCnvTool ( Gaudi::Details::PropertyBase & doTruthParticles )

protected

Call-back method to configure the converter tool if needed (this is defined by the state of the "DoTruthParticles" property)

Definition at line 174 of file TruthParticleBuilder.cxx.

{
  if ( m_doTruthParticles ) {
 
    if ( !m_cnvTool.retrieve().isSuccess() ) {
      ATH_MSG_ERROR
    ("Could not retrieve algTool ITruthParticleCnvTool ["
     << m_cnvTool.type() << "/" 
     //<< m_cnvTool.name() 
     << "] !!");
      throw std::runtime_error("Could not setup CnvTool property !");
    } else {
      ATH_MSG_DEBUG
    ("Retrieved and configured algTool [" << m_cnvTool.type() << "/" 
     //<< m_cnvTool.name() 
     << "]");
    }
 
  } else {
    if ( !m_cnvTool.release().isSuccess() ) {
      ATH_MSG_WARNING
    ("Could not release algTool ITruthParticleCnvTool ["
     << m_cnvTool.type() << "/" 
     //<< m_cnvTool.name() 
     << "] !!"
     << endmsg
     << "Memory won't be freed until ::finalize()...");
    } else {
      ATH_MSG_DEBUG
    ("Released algTool [" << m_cnvTool.type() << "/" 
     //<< m_cnvTool.name() 
     << "]");
    }
  }
 
  return;
}

◆ setupFilterTool()

void TruthParticleBuilder::setupFilterTool ( Gaudi::Details::PropertyBase & doFiltering )

protected

Call-back method to configure the filter tool if needed (this is defined by the state of the "DoFiltering" property)

Non-const methods:

Definition at line 136 of file TruthParticleBuilder.cxx.

{
  if ( m_doFiltering ) {
    
    if ( !m_filterTool.retrieve().isSuccess() ) {
      ATH_MSG_ERROR
    ("Could not retrieve algTool ITruthParticleFilterTool ["
     << m_filterTool.type() << "/" 
    //<< m_filterTool.name() 
     << "] !!");
      throw std::runtime_error("Could not setup FilterTool property !");
    } else {
      ATH_MSG_DEBUG
    ("Retrieved and configured algTool ["
     << m_filterTool.type() << "/" 
    //<< m_filterTool.name() 
     << "]");
    }
  } else {
    if ( !m_filterTool.release().isSuccess() ) {
      ATH_MSG_WARNING
    ("Could not release algTool ITruthParticleFilterTool ["
     << m_filterTool.type() << "/" 
    //<< m_filterTool.name() 
     << "] !!"
     << endmsg
     << "Memory won't be freed until ::finalize()...");
    } else {
      ATH_MSG_DEBUG
    ("Released algTool [" << m_filterTool.type() << "/" 
     //<< m_filterTool.name() 
     << "]");
    }
  }
 
  return;
}

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

CnvTool_t TruthParticleBuilder::m_cnvTool

protected

Pointer to the converter algtool which will create a TruthParticleContainer from the filtered McEventCollection.

Definition at line 82 of file TruthParticleBuilder.h.

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

BooleanProperty TruthParticleBuilder::m_doFiltering

protected

Switch to build or not a filtered McEventCollection.

Definition at line 86 of file TruthParticleBuilder.h.

◆ m_doTruthParticles

BooleanProperty TruthParticleBuilder::m_doTruthParticles

protected

Switch to build or not the TruthParticleContainer from the filtered GenEvent.

Definition at line 91 of file TruthParticleBuilder.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_filterTool

FilterTool_t TruthParticleBuilder::m_filterTool

protected

Pointer to the filter algtool (which will create the filtered McEventCollection)

Definition at line 76 of file TruthParticleBuilder.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:

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CnvTool_t

◆ FilterTool_t

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TruthParticleBuilder() [1/2]

◆ ~TruthParticleBuilder()

◆ TruthParticleBuilder() [2/2]

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setupCnvTool()

◆ setupFilterTool()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_cnvTool

◆ m_detStore

◆ m_doFiltering

◆ m_doTruthParticles

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_filterTool

◆ m_varHandleArraysDeclared

◆ m_vhka