McAodFilter Class Reference

This is an Algorithm which exercises the use of McVtxFilterTool and TruthParticleCnvTool. More...

#include <McAodFilter.h>

Inheritance diagram for McAodFilter:

Collaboration diagram for McAodFilter:

Public Member Functions
	McAodFilter (const std::string &name, ISvcLocator *pSvcLocator)
	Public methods:
virtual	~McAodFilter ()
	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< IMcVtxFilterTool >	IMcVtxFilterTool_t
typedef ToolHandle< ITruthParticleCnvTool >	CnvTool_t

Protected Member Functions
	McAodFilter ()
	Default constructor:
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
BooleanProperty	m_doGenAod
	Switch to build or not the filtered GenEvent.
IMcVtxFilterTool_t	m_mcVtxFilterTool
	Tool to filter an McEventCollection according to some DecayPattern.
BooleanProperty	m_doTruthParticles
	Switch to build or not the TruthParticleContainer from the filtered GenEvent.
CnvTool_t	m_truthParticleCnvTool
	Tool to convert a GenEvent into a TruthParticleContainer.

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

This is an Algorithm which exercises the use of McVtxFilterTool and TruthParticleCnvTool.

It does more or less the same job of SpclMCAodBuilder but has a slightly different philosophy : where SpclMCAodBuilder takes a new McEventCollection and removes the particles which are not "special", McAodFilter builds a McEventCollection from scratch with the particles previously flagged "special" by McVtxFilterTool (so it merely records particles connected to "special" vertices). Eventually it calls (or not, depending on a property switch) the TruthParticleCnvTool to create a TruthParticleContainer from this filtered McEventCollection.

Definition at line 43 of file McAodFilter.h.

Member Typedef Documentation

CnvTool_t

typedef ToolHandle<ITruthParticleCnvTool> McAodFilter::CnvTool_t

protected

Definition at line 93 of file McAodFilter.h.

IMcVtxFilterTool_t

typedef ToolHandle<IMcVtxFilterTool> McAodFilter::IMcVtxFilterTool_t

protected

Definition at line 83 of file McAodFilter.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

McAodFilter() [1/2]

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

Public methods:

Constructors

Definition at line 34 of file McAodFilter.cxx.

                                         : 
  AthAlgorithm( name, pSvcLocator )
{
  //
  // Property declaration
  // 
 
  declareProperty( "DoGenAod",
           m_doGenAod = false,
           "Switch to build or not the filtered GenEvent" );
 
  std::string descr = "";
  descr += "Switch to build or not the TruthParticleContainer ";
  descr += "from the filtered GenEvent";
  declareProperty( "DoTruthParticles", 
           m_doTruthParticles = false,
           descr );
  
  descr = "Tool to filter an McEventCollection according to some DecayPattern";
  declareProperty( "McVtxFilterTool",
           m_mcVtxFilterTool = IMcVtxFilterTool_t( "McVtxFilterTool",
                               this ),
           descr );
 
  descr = "Tool to convert a GenEvent into a TruthParticleContainer";
  declareProperty( "TruthParticleCnvTool",
           m_truthParticleCnvTool = CnvTool_t( "TruthParticleCnvTool",
                               this ),
           descr );
}

~McAodFilter()

McAodFilter::~McAodFilter ( )

virtual

Destructor.

Definition at line 68 of file McAodFilter.cxx.

{}

McAodFilter() [2/2]

McAodFilter::McAodFilter ( )

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.

{ 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 McAodFilter::execute ( )

virtual

Now create an AOD-compliant container from a McEventCollection

Definition at line 99 of file McAodFilter.cxx.

{  
  StatusCode sc = StatusCode::SUCCESS;
 
  ATH_MSG_DEBUG ("Executing " << name() << "...");
 
  if ( m_doGenAod ) {
    sc = m_mcVtxFilterTool->execute();
    if ( !sc.isSuccess() ) {
      ATH_MSG_WARNING ("Problem filtering the McEventCollection !!");
    }
  }

  if ( m_doTruthParticles ) {
    if ( sc.isSuccess() ) {
      sc = m_truthParticleCnvTool->execute();
      if ( !sc.isSuccess() ) {
    ATH_MSG_WARNING
      ("Could not convert McEventCollection ==> TruthParticles !!");
      }
    } else {
      ATH_MSG_WARNING
    ("Could not convert McEventCollection ==> TruthParticles because"\
     " McEventCollection filtering failed");
    }
  }
 
  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 McAodFilter::finalize ( )

virtual

Definition at line 92 of file McAodFilter.cxx.

{
  ATH_MSG_INFO ("Finalizing " << name() << "...");
  m_mcVtxFilterTool->stats();
  return StatusCode::SUCCESS;
}

initialize()

StatusCode McAodFilter::initialize ( )

virtual

Athena Algorithm's Hooks.

Retrieves a private AlgTool to filter a McEventCollection

Retrieves a private AlgTool to convert GenEvent to TruthParticleContainer

Definition at line 73 of file McAodFilter.cxx.

{
  ATH_MSG_INFO ("Initializing " << name() << "...");

  if ( !m_mcVtxFilterTool.retrieve().isSuccess() ) {
    ATH_MSG_ERROR ("Creation of algTool McVtxFilterTool FAILED !");
    return StatusCode::FAILURE;
  }
  
  if ( !m_truthParticleCnvTool.retrieve().isSuccess() ) {
    ATH_MSG_ERROR ("Creation of algTool TruthParticleCnvTool FAILED !");
    return StatusCode::FAILURE;
  }
  
  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_doGenAod

BooleanProperty McAodFilter::m_doGenAod

protected

Switch to build or not the filtered GenEvent.

Definition at line 81 of file McAodFilter.h.

m_doTruthParticles

BooleanProperty McAodFilter::m_doTruthParticles

protected

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

Definition at line 91 of file McAodFilter.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_mcVtxFilterTool

IMcVtxFilterTool_t McAodFilter::m_mcVtxFilterTool

protected

Tool to filter an McEventCollection according to some DecayPattern.

Definition at line 86 of file McAodFilter.h.

m_truthParticleCnvTool

CnvTool_t McAodFilter::m_truthParticleCnvTool

protected

Tool to convert a GenEvent into a TruthParticleContainer.

Definition at line 96 of file McAodFilter.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:

• McAodFilter.h
• McAodFilter.cxx