an IAsgSelectionTool that select particles based on the allowed decay chain More...

#include <PMGDecayProductsSelectionTool.h>

Inheritance diagram for PMGTools::PMGDecayProductsSelectionTool:

Collaboration diagram for PMGTools::PMGDecayProductsSelectionTool:

Public Member Functions
	PMGDecayProductsSelectionTool (const std::string &name)
	standard constructor
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual const asg::AcceptInfo &	getAcceptInfo () const override
	Declare the interface ID for this pure-virtual interface class to the Athena framework.
virtual asg::AcceptData	accept (const xAOD::IParticle *) const override
	The main accept method: the actual cuts are applied here.
virtual void	print () const
	Print the state of the tool.
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
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

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
asg::AcceptData	hasRequiredInitialParent (const xAOD::TruthParticle *truthParticle, asg::AcceptData &acceptData) const
	Helper function to check for required parent particles.
size_t	getNParents (const xAOD::TruthParticle *truthParticle) const
	Helper function to get the number of parent particles.
const xAOD::TruthParticle *	getParent (const xAOD::TruthParticle *truthParticle, size_t index) const
	Helper function get a parent by index.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
int	m_truthParticleIndex { -1 }
	Index for the truth particle link.
int	m_requiredParentIndex { -1 }
	Index for the required parent particles.
asg::AcceptInfo	m_accept
	the AcceptInfo we are using
std::unique_ptr< const SG::AuxElement::Accessor< std::vector< ElementLink< xAOD::TruthParticleContainer > > > >	m_parentsAccessor {}
	common parents accessor
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

std::vector< int >	m_requiredParentPDGIDs
	tool properties
std::vector< int >	m_allowedIntermediatePDGIDs

Detailed Description

an IAsgSelectionTool that select particles based on the allowed decay chain

Definition at line 23 of file PMGDecayProductsSelectionTool.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

◆ PMGDecayProductsSelectionTool()

PMGTools::PMGDecayProductsSelectionTool::PMGDecayProductsSelectionTool ( const std::string & name )

standard constructor

Definition at line 26 of file PMGDecayProductsSelectionTool.cxx.

    : AsgTool (name)
  {
    declareProperty ("requiredParentPDGIDs", m_requiredParentPDGIDs, "required parent particle PDG IDs (positive only)");
    declareProperty ("allowedIntermediatePDGIDs", m_allowedIntermediatePDGIDs, "allowed intermediate particles PDG IDs (positive only)");
  }

Member Function Documentation

◆ accept()

asg::AcceptData PMGTools::PMGDecayProductsSelectionTool::accept ( const xAOD::IParticle * ) const

overridevirtual

The main accept method: the actual cuts are applied here.

Implements IAsgSelectionTool.

Definition at line 80 of file PMGDecayProductsSelectionTool.cxx.

  {
    asg::AcceptData acceptData (&m_accept);
 
    // Check if xAOD::TruthParticle or if not if it has the TruthParticleLink
    const xAOD::TruthParticle *truthParticle
      = dynamic_cast<const xAOD::TruthParticle *> (particle);
    if (truthParticle == nullptr)
    {
      // need to find the truth particle
      truthParticle = xAOD::TruthHelpers::getTruthParticle(*particle);
      if (truthParticle == nullptr)
      {
        acceptData.setCutResult (m_truthParticleIndex, false);
        return acceptData;
      }
    }
    acceptData.setCutResult (m_truthParticleIndex, true);
 
    return hasRequiredInitialParent(truthParticle, acceptData);
  }

◆ 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

◆ getAcceptInfo()

const asg::AcceptInfo & PMGTools::PMGDecayProductsSelectionTool::getAcceptInfo ( ) const

overridevirtual

Declare the interface ID for this pure-virtual interface class to the Athena framework.

Method to get the AcceptInfo to query what cuts are defined.

Implements IAsgSelectionTool.

Definition at line 72 of file PMGDecayProductsSelectionTool.cxx.

  {
    return m_accept;
  }

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

◆ getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

◆ getNParents()

size_t PMGTools::PMGDecayProductsSelectionTool::getNParents ( const xAOD::TruthParticle * truthParticle ) const

private

Helper function to get the number of parent particles.

Definition at line 147 of file PMGDecayProductsSelectionTool.cxx.

  {
    if (m_parentsAccessor->isAvailable (*truthParticle))
    {
      return (*m_parentsAccessor)(*truthParticle).size();
    }
    else
    {
      return truthParticle->nParents();
    }
  }

◆ getParent()

const xAOD::TruthParticle * PMGTools::PMGDecayProductsSelectionTool::getParent	(	const xAOD::TruthParticle *	truthParticle,
		size_t	index ) const

private

Helper function get a parent by index.

Definition at line 162 of file PMGDecayProductsSelectionTool.cxx.

  {
    if (m_parentsAccessor->isAvailable (*truthParticle))
    {
      ElementLink<xAOD::TruthParticleContainer> parentElementLink
        = (*m_parentsAccessor)(*truthParticle).at(index);
      return parentElementLink.isValid() ? *parentElementLink : nullptr;
    }
    else
    {
      return truthParticle->parent(index);
    }
  }

◆ getProperty()

template<class T>

const T * asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

◆ hasRequiredInitialParent()

asg::AcceptData PMGTools::PMGDecayProductsSelectionTool::hasRequiredInitialParent	(	const xAOD::TruthParticle *	truthParticle,
		asg::AcceptData &	acceptData ) const

private

Helper function to check for required parent particles.

Definition at line 105 of file PMGDecayProductsSelectionTool.cxx.

  {
    size_t nParents = getNParents (truthParticle);
    for (size_t i = 0; i < nParents; i++)
    {
      const xAOD::TruthParticle *parent = getParent(truthParticle, i);
      if (parent)
      {
        if (std::find(m_requiredParentPDGIDs.begin(), m_requiredParentPDGIDs.end(), std::abs(parent->pdgId())) != m_requiredParentPDGIDs.end())
        {
          acceptData.setCutResult (m_requiredParentIndex, true);
          return acceptData;
        }
        else if (m_allowedIntermediatePDGIDs.empty() || std::find(m_allowedIntermediatePDGIDs.begin(), m_allowedIntermediatePDGIDs.end(), std::abs(parent->pdgId())) != m_allowedIntermediatePDGIDs.end())
        {
          return hasRequiredInitialParent(parent, acceptData);
        }
        else
        {
          ATH_MSG_VERBOSE("Removing particle as parent is not allowed: " << parent->pdgId());
          return acceptData;
        }
      }
      else
      {
        ATH_MSG_WARNING("Particle parent is not valid");
        return acceptData;
      }
    }
 
    if (std::find(m_requiredParentPDGIDs.begin(), m_requiredParentPDGIDs.end(), std::abs(truthParticle->pdgId())) != m_requiredParentPDGIDs.end())
    {
      acceptData.setCutResult (m_requiredParentIndex, true);
      return acceptData;
    }
 
    return acceptData;
  }

◆ initialize()

StatusCode PMGTools::PMGDecayProductsSelectionTool::initialize ( void )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 36 of file PMGDecayProductsSelectionTool.cxx.

  {
    if (m_requiredParentPDGIDs.empty())
    {
      ATH_MSG_ERROR ("required parent particles need to be set");
      return StatusCode::FAILURE;
    }
 
    m_truthParticleIndex = m_accept.addCut ("truthParticle", "has truth particle cut");
 
    std::ostringstream particles;
    for (int pdgId : m_requiredParentPDGIDs)
    {
      particles << " " << pdgId;
    }
    ATH_MSG_DEBUG ("Performing required parent particle selection with parent PDG IDs:" << particles.str());
    m_requiredParentIndex = m_accept.addCut ("requiredParents", "required parent particles cut");
 
    if (!m_allowedIntermediatePDGIDs.empty())
    {
      std::ostringstream particles;
      for (int pdgId : m_allowedIntermediatePDGIDs)
      {
        particles << " " << pdgId;
      }
      ATH_MSG_DEBUG ("Performing allowed intermediate particle selection with allowed PDG IDs:" << particles.str());
    }
 
    m_parentsAccessor = std::make_unique<const SG::AuxElement::Accessor<std::vector<ElementLink<xAOD::TruthParticleContainer>>>>("parentLinks");
 
    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.

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns: The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

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

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

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

asg::AcceptInfo PMGTools::PMGDecayProductsSelectionTool::m_accept

private

the AcceptInfo we are using

Definition at line 83 of file PMGDecayProductsSelectionTool.h.

◆ m_allowedIntermediatePDGIDs

std::vector<int> PMGTools::PMGDecayProductsSelectionTool::m_allowedIntermediatePDGIDs

private

Definition at line 71 of file PMGDecayProductsSelectionTool.h.

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

std::unique_ptr<const SG::AuxElement::Accessor<std::vector<ElementLink<xAOD::TruthParticleContainer> > > > PMGTools::PMGDecayProductsSelectionTool::m_parentsAccessor {}

private

common parents accessor

Definition at line 87 of file PMGDecayProductsSelectionTool.h.

87{};

◆ m_requiredParentIndex

int PMGTools::PMGDecayProductsSelectionTool::m_requiredParentIndex { -1 }

private

Index for the required parent particles.

Definition at line 79 of file PMGDecayProductsSelectionTool.h.

79{ -1 };

◆ m_requiredParentPDGIDs

std::vector<int> PMGTools::PMGDecayProductsSelectionTool::m_requiredParentPDGIDs

private

tool properties

Definition at line 70 of file PMGDecayProductsSelectionTool.h.

◆ m_truthParticleIndex

int PMGTools::PMGDecayProductsSelectionTool::m_truthParticleIndex { -1 }

private

Index for the truth particle link.

Definition at line 77 of file PMGDecayProductsSelectionTool.h.

77{ -1 };

◆ 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 Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ PMGDecayProductsSelectionTool()

Member Function Documentation

◆ accept()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getAcceptInfo()

◆ getKey()

◆ getName()

◆ getNParents()

◆ getParent()

◆ getProperty()

◆ hasRequiredInitialParent()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_accept

◆ m_allowedIntermediatePDGIDs

◆ m_detStore

◆ m_evtStore

◆ m_parentsAccessor

◆ m_requiredParentIndex

◆ m_requiredParentPDGIDs

◆ m_truthParticleIndex

◆ m_varHandleArraysDeclared

◆ m_vhka