The main purpose of this EF is to specify the decay of V1/V2 in H->V1V2, V1->decay, V2->decay with VH production. More...

#include <xAODXtoVVDecayFilterExtended.h>

Inheritance diagram for xAODXtoVVDecayFilterExtended:

Collaboration diagram for xAODXtoVVDecayFilterExtended:

Public Member Functions
virtual StatusCode	filterInitialize () override final
virtual StatusCode	filterFinalize () override final
virtual StatusCode	filterEvent () override final
	GenFilter (const std::string &name, ISvcLocator *pSvcLocator)
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
Event loop algorithm methods: not to be overloaded
StatusCode	initialize ()
StatusCode	execute ()
StatusCode	finalize ()
Counters
int	nPassed () const
int	nFailed () const
int	nNeeded () const
Event collection accessors (const and non-const)
HepMC::GenEvent *event	ATLAS_NOT_CONST_THREAD_SAFE ()
	Access the current signal event (first in the McEventCollection)
McEventCollection *events	ATLAS_NOT_CONST_THREAD_SAFE ()
	Access the current event's McEventCollection.
const HepMC::GenEvent *	event_const () const
	Access the current signal event (const)
const McEventCollection *	events_const () const
	Access the current event's McEventCollection (const)
const McEventCollection *	events_const (const EventContext &ctx) const
Particle data accessors
const ServiceHandle< IPartPropSvc >	partPropSvc () const
	Access the particle property service.
const HepPDT::ParticleDataTable &	particleTable () const
	Get a particle data table.
const HepPDT::ParticleDataTable &	pdt () const
	Shorter alias to get a particle data table.
const HepPDT::ParticleData *	particleData (int pid) const
	Access an element in the particle data table.

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.

Protected Attributes
Counters and requirements
int	m_nPass
int	m_nFail
int	m_nNeeded
Properties
std::string	m_mcEventKey {}
	StoreGate key for the MC event collection (defaults to GEN_EVENT)
BooleanProperty	m_mkMcEvent {this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"}
	Flag to determine if a new MC event collection should be made if it doesn't exist.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
void	FindAncestor (const xAOD::TruthVertex *searchvertex, int targetPDGID, bool &okPDGChild1, bool &okPDGChild2)
const xAOD::TruthParticle *	CheckGrandparent (const xAOD::TruthParticle *pitr, int &)
bool	RunHistory (const xAOD::TruthParticle *pitr)
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< int >	m_PDGGrandParent {this, "PDGGrandParent", 0}
Gaudi::Property< int >	m_PDGParent {this, "PDGParent", 0}
Gaudi::Property< bool >	m_UseStatusParent {this, "UseStatusParent", false}
Gaudi::Property< int >	m_StatusParent {this, "StatusParent", 0}
Gaudi::Property< std::vector< int > >	m_PDGChild1 {this, "PDGChild1", {}}
Gaudi::Property< std::vector< int > >	m_PDGChild2 {this, "PDGChild2",{}}
SG::ReadHandleKey< xAOD::TruthEventContainer >	m_truthEventKey {this, "TruthEventKey", "TruthEvents"}
int	m_nHtoVV {}
int	m_nGoodHtoVV {}
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

Utility event-mangling functions
Todo Replace with HepMC units when available
ServiceHandle< IPartPropSvc >	m_ppSvc {this, "PartPropSvc", "PartPropSvc"}
	Handle on the particle property service.
SG::ReadHandleKey< McEventCollection >	m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }
	Const handle to the MC event collection.
void	GeVToMeV (HepMC::GenEvent *evt)
	Scale event energies/momenta by x 1000.
void	MeVToGeV (HepMC::GenEvent *evt)
	Scale event energies/momenta by x 1/1000.
void	cmTomm (HepMC::GenEvent *evt)
	Scale event lengths by x 10.
void	mmTocm (HepMC::GenEvent *evt)
	Scale event lengths by x 1/10.

Detailed Description

The main purpose of this EF is to specify the decay of V1/V2 in H->V1V2, V1->decay, V2->decay with VH production.

(for example, V1/V2->leptonic decay but V->all)

Author: Junichi TANAKA; Tatsuya MASUBUCHI Modified such that it looks in the history of the particle mothers and finds whether there is a mother with m_PDGGrandParent Nikolaos Rompotis 15 January 2015

Definition at line 20 of file xAODXtoVVDecayFilterExtended.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

◆ ATLAS_NOT_CONST_THREAD_SAFE() [1/2]

HepMC::GenEvent *event GenBase::ATLAS_NOT_CONST_THREAD_SAFE ( )

inlineinherited

Access the current signal event (first in the McEventCollection)

Note: This function will make a new McEventCollection if there is not already a valid one and MakeMcEvent=True.

Definition at line 76 of file GenBase.h.

                                                      {
    if (events()->empty())
      ATH_MSG_ERROR("McEventCollection is empty during first event access");
    return *(events()->begin());
  }

◆ ATLAS_NOT_CONST_THREAD_SAFE() [2/2]

McEventCollection *events GenBase::ATLAS_NOT_CONST_THREAD_SAFE ( )

inherited

Access the current event's McEventCollection.

Note: This function will make a new McEventCollection if there is not already a valid one and MakeMcEvent=True.

◆ CheckGrandparent()

const xAOD::TruthParticle * xAODXtoVVDecayFilterExtended::CheckGrandparent	(	const xAOD::TruthParticle *	pitr,
		int &	result )

private

Definition at line 127 of file xAODXtoVVDecayFilterExtended.cxx.

{
 
    if (!pitr->prodVtx())
    {
        ATH_MSG_DEBUG("No ancestor for this case");
        result = -1;
        return NULL;
    }
    bool isGrandParentOK = false;
 
    if (pitr->prodVtx()->nIncomingParticles() == 0)
    {
        ATH_MSG_DEBUG("No mother for this case");
        result = -2;
        return NULL;
    }
 
    int n_mothers = 1;
 
    for (size_t thisMother_id = 0; thisMother_id < pitr->prodVtx()->nIncomingParticles(); thisMother_id++)
    {
        auto thisMother = pitr->prodVtx()->incomingParticle(thisMother_id);
        ATH_MSG_DEBUG("Now on this mother: " << (thisMother)->pdgId() << " " << n_mothers);
        if ((thisMother)->pdgId() != m_PDGGrandParent && std::abs((thisMother)->pdgId()) != m_PDGParent)
            break;
        if ((thisMother)->pdgId() == m_PDGGrandParent && n_mothers == 1)
        {
            isGrandParentOK = true;
        }
        n_mothers++;
    }
 
    if (isGrandParentOK)
    {
        result = m_PDGGrandParent;
    }
    else
    {
        result = 0;
    }
 
    return pitr->prodVtx()->incomingParticle(0);
}

◆ cmTomm()

void GenBase::cmTomm ( HepMC::GenEvent * evt )

protectedinherited

Scale event lengths by x 10.

Definition at line 78 of file GenBase.cxx.

                                       {
  for (HepMC::GenEvent::vertex_iterator vtx = evt->vertices_begin(); vtx != evt->vertices_end(); ++vtx) {
    const HepMC::FourVector fv((*vtx)->position().x() * 10,
                               (*vtx)->position().y() * 10,
                               (*vtx)->position().z() * 10,
                               (*vtx)->position().t() * 10);
    (*vtx)->set_position(fv);
  }
}

◆ 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

◆ event_const()

const HepMC::GenEvent * GenBase::event_const ( ) const

inlineinherited

Access the current signal event (const)

Definition at line 83 of file GenBase.h.

                                           {
    if (events_const()->empty())
      ATH_MSG_ERROR("Const McEventCollection is empty during first event access");
    return *(events_const()->begin());
  }

◆ events_const() [1/2]

const McEventCollection * GenBase::events_const ( ) const

inlineinherited

Access the current event's McEventCollection (const)

Definition at line 96 of file GenBase.h.

                                                {
    return events_const( getContext() );
  }

◆ events_const() [2/2]

const McEventCollection * GenBase::events_const ( const EventContext & ctx ) const

inlineinherited

Definition at line 99 of file GenBase.h.

                                                                         {
    SG::ReadHandle<McEventCollection> ret = SG::makeHandle(m_mcevents_const, ctx);
    if (!ret.isValid())
      ATH_MSG_ERROR("No McEventCollection found in StoreGate with key " << m_mcevents_const.key());
    return ret.cptr();
  }

◆ 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 GenFilter::execute ( )

virtualinherited

Todo: Probably the filter should only look at the first event... right?

Reimplemented from GenBase.

Definition at line 29 of file GenFilter.cxx.

                              {
  if (events_const()->empty()) {
    ATH_MSG_ERROR("No events found in McEventCollection");
    return StatusCode::FAILURE;
  } else if (events_const()->size() > 1) {
    ATH_MSG_WARNING("More than one event in current McEventCollection -- which is valid?");
  }
  StatusCode sc = filterEvent();
#ifdef HEPMC3
  if (filterPassed() || m_keepAll ) {
#else
  if (filterPassed() ) {
#endif
    ATH_MSG_DEBUG("Event passed filter");
    m_nPass += 1;
  } else {
    ATH_MSG_DEBUG("Event failed filter");
    m_nFail += 1;
  }
  // Bail out once we have enough events
  if (m_nPass >= m_nNeeded && m_nNeeded > 0)
    sc = StatusCode::FAILURE;
  return sc;
}

◆ 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();
}

◆ filterEvent()

StatusCode xAODXtoVVDecayFilterExtended::filterEvent ( )

finaloverridevirtual

Implements GenFilter.

Definition at line 40 of file xAODXtoVVDecayFilterExtended.cxx.

{
    bool okPDGChild1 = false;
    bool okPDGChild2 = false;
    int nGoodParent = 0;
 
    // Retrieve full TruthEventContainer container
    SG::ReadHandle<xAOD::TruthEventContainer> xTruthEventContainer{m_truthEventKey};
    CHECK( xTruthEventContainer.isValid() );
 
    for (const xAOD::TruthEvent* event : *xTruthEventContainer)
    {
        unsigned int nPart = event->nTruthParticles();
        for (unsigned int iPart = 0; iPart < nPart; ++iPart)
        {
            const xAOD::TruthParticle *pitr = event->truthParticle(iPart);
            if (std::abs(pitr->pdgId()) == m_PDGParent)
            {
                if((!m_UseStatusParent && !MC::isDecayed(pitr)) || (m_UseStatusParent && pitr->status() != m_StatusParent)) continue;
                bool isGrandParentOK = RunHistory(pitr);
                ATH_MSG_DEBUG(" Grand Parent is OK? " << isGrandParentOK);
                if (!isGrandParentOK)
                    continue;
                ++nGoodParent;
                FindAncestor(pitr->decayVtx(), m_PDGParent, okPDGChild1, okPDGChild2);
            }
        }
    }
    ATH_MSG_DEBUG("Result " << nGoodParent << " " << okPDGChild1 << " " << okPDGChild2);
 
    if (nGoodParent == 2)
    {
        ++m_nHtoVV;
        if (okPDGChild1 && okPDGChild2)
        {
            ++m_nGoodHtoVV;
            return StatusCode::SUCCESS;
        }
    }
 
    // If we get here we have failed
    setFilterPassed(false);
    return StatusCode::SUCCESS;
}

◆ filterFinalize()

StatusCode xAODXtoVVDecayFilterExtended::filterFinalize ( )

finaloverridevirtual

Reimplemented from GenFilter.

Definition at line 30 of file xAODXtoVVDecayFilterExtended.cxx.

{
    ATH_MSG_INFO("Statistics of X->VV, V->decay scanning all ancestors of V in order to find X");
    ATH_MSG_INFO("  ALL  X->VV  " << m_nHtoVV);
    ATH_MSG_INFO("  Good X->VV  " << m_nGoodHtoVV);
    if (m_nHtoVV != 0)
        ATH_MSG_INFO("  Fraction   " << double(m_nGoodHtoVV) / double(m_nHtoVV));
    return StatusCode::SUCCESS;
}

◆ filterInitialize()

StatusCode xAODXtoVVDecayFilterExtended::filterInitialize ( )

finaloverridevirtual

Reimplemented from GenFilter.

Definition at line 8 of file xAODXtoVVDecayFilterExtended.cxx.

{
    CHECK(m_truthEventKey.initialize());
    ATH_MSG_INFO("PDGGrandParent(H) = " << m_PDGGrandParent << " will scan all ancestors to find PDGGrandParent");
    ATH_MSG_INFO("PDGParent(V)      = " << m_PDGParent );
    if (m_PDGChild1.empty())
        ATH_MSG_ERROR("PDGChild1[] not set ");
    if (m_PDGChild2.empty())
        ATH_MSG_ERROR("PDGChild2[] not set ");
    for (size_t i = 0; i < m_PDGChild1.size(); ++i)
        ATH_MSG_INFO("PDGChild1[" << i << "] = " << m_PDGChild1[i]);
    for (size_t i = 0; i < m_PDGChild2.size(); ++i)
        ATH_MSG_INFO("PDGChild2[" << i << "] = " << m_PDGChild2[i]);
    ATH_MSG_INFO("UseStatusParent  " << m_UseStatusParent);
    ATH_MSG_INFO("StatusParent  " << m_StatusParent);
 
    // init
    m_nHtoVV = 0;
    m_nGoodHtoVV = 0;
    return StatusCode::SUCCESS;
}

◆ finalize()

StatusCode GenFilter::finalize ( )

inherited

Definition at line 56 of file GenFilter.cxx.

                               {
  ATH_MSG_INFO("Events passed = " << m_nPass << "  Events failed = " << m_nFail);
  CHECK(filterFinalize());
  return StatusCode::SUCCESS;
}

◆ FindAncestor()

void xAODXtoVVDecayFilterExtended::FindAncestor	(	const xAOD::TruthVertex *	searchvertex,
		int	targetPDGID,
		bool &	okPDGChild1,
		bool &	okPDGChild2 )

private

Definition at line 172 of file xAODXtoVVDecayFilterExtended.cxx.

{
    if (!searchvertex)
        return;
    for (size_t thisMother_id = 0; thisMother_id < searchvertex->nOutgoingParticles(); thisMother_id++)
    {
        auto thisAncestor = searchvertex->outgoingParticle(thisMother_id);
 
        if (std::abs(thisAncestor->pdgId()) == targetPDGID)
        { // same particle as parent
            FindAncestor(thisAncestor->decayVtx(), targetPDGID, okPDGChild1, okPDGChild2);
        }
        else
        {
            if (!okPDGChild1)
            {
                for (size_t i = 0; i < m_PDGChild1.size(); ++i)
                {
                    if (std::abs(thisAncestor->pdgId()) == m_PDGChild1[i])
                    {
                        okPDGChild1 = true;
                        break;
                    }
                }
                if (okPDGChild1)
                    break;
            }
            if (!okPDGChild2)
            {
                for (size_t i = 0; i < m_PDGChild2.size(); ++i)
                {
                    if (std::abs(thisAncestor->pdgId()) == m_PDGChild2[i])
                    {
                        okPDGChild2 = true;
                        break;
                    }
                }
                if (okPDGChild2)
                    break;
            }
        }
    }
}

◆ GenFilter()

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

Definition at line 33 of file GenFilter.cxx.

  : GenBase(name, pSvcLocator)
{
  declareProperty("TotalPassed", m_nNeeded=-1);
#ifdef HEPMC3
  declareProperty("KeepAllEvents", m_keepAll=false);
#endif
  m_nPass = 0;
  m_nFail = 0;
}

◆ GeVToMeV()

void GenBase::GeVToMeV ( HepMC::GenEvent * evt )

protectedinherited

Scale event energies/momenta by x 1000.

Todo: Add HepMC units awareness and do it differently when HepMC provides this functionality directly (and reference-based FourVector accessors)

Definition at line 58 of file GenBase.cxx.

                                         {
  for (HepMC::GenEvent::particle_iterator p = evt->particles_begin(); p != evt->particles_end(); ++p) {
    const HepMC::FourVector fv((*p)->momentum().px() * 1000,
                               (*p)->momentum().py() * 1000,
                               (*p)->momentum().pz() * 1000,
                               (*p)->momentum().e()  * 1000);
    (*p)->set_momentum(fv);
    (*p)->set_generated_mass(1000 * (*p)->generated_mass());
  }
}

◆ initialize()

StatusCode GenFilter::initialize ( )

virtualinherited

Reimplemented from GenBase.

Definition at line 20 of file GenFilter.cxx.

                                 {
  CHECK(GenBase::initialize());
  m_nPass = 0;
  m_nFail = 0;
  CHECK(filterInitialize());
  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.

◆ MeVToGeV()

void GenBase::MeVToGeV ( HepMC::GenEvent * evt )

protectedinherited

Scale event energies/momenta by x 1/1000.

Definition at line 68 of file GenBase.cxx.

                                         {
  for (HepMC::GenEvent::particle_iterator p = evt->particles_begin(); p != evt->particles_end(); ++p) {
    const HepMC::FourVector fv((*p)->momentum().px() / 1000,
                               (*p)->momentum().py() / 1000,
                               (*p)->momentum().pz() / 1000,
                               (*p)->momentum().e()  / 1000);
    (*p)->set_momentum(fv);
    (*p)->set_generated_mass((*p)->generated_mass() / 1000);
  }
}

◆ mmTocm()

void GenBase::mmTocm ( HepMC::GenEvent * evt )

protectedinherited

Scale event lengths by x 1/10.

Definition at line 87 of file GenBase.cxx.

                                       {
  for (HepMC::GenEvent::vertex_iterator vtx = evt->vertices_begin(); vtx != evt->vertices_end(); ++vtx) {
    const HepMC::FourVector fv((*vtx)->position().x() / 10,
                               (*vtx)->position().y() / 10,
                               (*vtx)->position().z() / 10,
                               (*vtx)->position().t() / 10);
    (*vtx)->set_position(fv);
  }
}

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

◆ nFailed()

int GenFilter::nFailed ( ) const

inlineinherited

Definition at line 53 of file GenFilter.h.

53{ return m_nFail; }

◆ nNeeded()

int GenFilter::nNeeded ( ) const

inlineinherited

Definition at line 54 of file GenFilter.h.

54{ return m_nNeeded; }

◆ nPassed()

int GenFilter::nPassed ( ) const

inlineinherited

Definition at line 52 of file GenFilter.h.

52{ return m_nPass; }

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

◆ particleData()

const HepPDT::ParticleData * GenBase::particleData ( int pid ) const

inlineinherited

Access an element in the particle data table.

Definition at line 126 of file GenBase.h.

                                                        {
    return pdt().particle(HepPDT::ParticleID(std::abs(pid)));
  }

◆ particleTable()

const HepPDT::ParticleDataTable & GenBase::particleTable ( ) const

inlineinherited

Get a particle data table.

Definition at line 118 of file GenBase.h.

                                                       {
    return *(m_ppSvc->PDT());
  }

◆ partPropSvc()

const ServiceHandle< IPartPropSvc > GenBase::partPropSvc ( ) const

inlineinherited

Access the particle property service.

Definition at line 113 of file GenBase.h.

                                                        {
    return m_ppSvc;
  }

◆ pdt()

const HepPDT::ParticleDataTable & GenBase::pdt ( ) const

inlineinherited

Shorter alias to get a particle data table.

Definition at line 123 of file GenBase.h.

123{ return particleTable(); }

GenBase::particleTable

const HepPDT::ParticleDataTable & particleTable() const

Get a particle data table.

Definition GenBase.h:118

◆ 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();
  }

◆ RunHistory()

bool xAODXtoVVDecayFilterExtended::RunHistory ( const xAOD::TruthParticle * pitr )

private

Definition at line 87 of file xAODXtoVVDecayFilterExtended.cxx.

{
    if (!pitr->prodVtx())
    {
        ATH_MSG_DEBUG("No History for this case");
        return false;
    }
    if (pitr->prodVtx()->nIncomingParticles() == 0)
    {
        ATH_MSG_DEBUG("No mother for this case");
        return false;
    }
    int result = 999;
 
    // Check if the first mother is ok
    pitr = CheckGrandparent(pitr, result);
    ATH_MSG_DEBUG("Pointer PDG ID: " << pitr->pdgId());
    if (std::abs(pitr->pdgId()) != m_PDGGrandParent && std::abs(pitr->pdgId()) != m_PDGParent)
        return false;
    if (result == m_PDGGrandParent)
        return true;
 
    //set pitr_current to pitr of grand parent 
    auto pitr_current = pitr;
    while (result >= 0)
    {
        pitr_current = CheckGrandparent(pitr_current, result);
        ATH_MSG_DEBUG("Pointer PDG ID: " << pitr->pdgId());
        if (std::abs(pitr_current->pdgId()) != m_PDGGrandParent && std::abs(pitr_current->pdgId()) != m_PDGParent)
            return false;
 
        if (result == m_PDGGrandParent)
            return true;
    }
 
    return false;
}

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

std::string GenBase::m_mcEventKey {}

protectedinherited

StoreGate key for the MC event collection (defaults to GEN_EVENT)

Definition at line 137 of file GenBase.h.

137{};

◆ m_mcevents_const

SG::ReadHandleKey<McEventCollection> GenBase::m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }

privateinherited

Const handle to the MC event collection.

Definition at line 163 of file GenBase.h.

163{ this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" };

◆ m_mkMcEvent

BooleanProperty GenBase::m_mkMcEvent {this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"}

protectedinherited

Flag to determine if a new MC event collection should be made if it doesn't exist.

Definition at line 139 of file GenBase.h.

139{this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"};

◆ m_nFail

int GenFilter::m_nFail

protectedinherited

Definition at line 66 of file GenFilter.h.

◆ m_nGoodHtoVV

int xAODXtoVVDecayFilterExtended::m_nGoodHtoVV {}

private

Definition at line 39 of file xAODXtoVVDecayFilterExtended.h.

39{};

◆ m_nHtoVV

int xAODXtoVVDecayFilterExtended::m_nHtoVV {}

private

Definition at line 38 of file xAODXtoVVDecayFilterExtended.h.

38{};

◆ m_nNeeded

int GenFilter::m_nNeeded

protectedinherited

Definition at line 67 of file GenFilter.h.

◆ m_nPass

int GenFilter::m_nPass

protectedinherited

Definition at line 65 of file GenFilter.h.

◆ m_PDGChild1

Gaudi::Property<std::vector<int> > xAODXtoVVDecayFilterExtended::m_PDGChild1 {this, "PDGChild1", {}}

private

Definition at line 34 of file xAODXtoVVDecayFilterExtended.h.

34{this, "PDGChild1", {}};

◆ m_PDGChild2

Gaudi::Property<std::vector<int> > xAODXtoVVDecayFilterExtended::m_PDGChild2 {this, "PDGChild2",{}}

private

Definition at line 35 of file xAODXtoVVDecayFilterExtended.h.

35{this, "PDGChild2",{}};

◆ m_PDGGrandParent

Gaudi::Property<int> xAODXtoVVDecayFilterExtended::m_PDGGrandParent {this, "PDGGrandParent", 0}

private

Definition at line 30 of file xAODXtoVVDecayFilterExtended.h.

30{this, "PDGGrandParent", 0};

◆ m_PDGParent

Gaudi::Property<int> xAODXtoVVDecayFilterExtended::m_PDGParent {this, "PDGParent", 0}

private

Definition at line 31 of file xAODXtoVVDecayFilterExtended.h.

31{this, "PDGParent", 0};

◆ m_ppSvc

ServiceHandle<IPartPropSvc> GenBase::m_ppSvc {this, "PartPropSvc", "PartPropSvc"}

privateinherited

Handle on the particle property service.

Definition at line 160 of file GenBase.h.

160{this, "PartPropSvc", "PartPropSvc"};

◆ m_StatusParent

Gaudi::Property<int> xAODXtoVVDecayFilterExtended::m_StatusParent {this, "StatusParent", 0}

private

Definition at line 33 of file xAODXtoVVDecayFilterExtended.h.

33{this, "StatusParent", 0};

◆ m_truthEventKey

SG::ReadHandleKey<xAOD::TruthEventContainer> xAODXtoVVDecayFilterExtended::m_truthEventKey {this, "TruthEventKey", "TruthEvents"}

private

Definition at line 36 of file xAODXtoVVDecayFilterExtended.h.

36{this, "TruthEventKey", "TruthEvents"};

◆ m_UseStatusParent

Gaudi::Property<bool> xAODXtoVVDecayFilterExtended::m_UseStatusParent {this, "UseStatusParent", false}

private

Definition at line 32 of file xAODXtoVVDecayFilterExtended.h.

32{this, "UseStatusParent", false};

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

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Utility event-mangling functions

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Function Documentation

◆ ATLAS_NOT_CONST_THREAD_SAFE() [1/2]

◆ ATLAS_NOT_CONST_THREAD_SAFE() [2/2]

◆ CheckGrandparent()

◆ cmTomm()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ event_const()

◆ events_const() [1/2]

◆ events_const() [2/2]

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterEvent()

◆ filterFinalize()

◆ filterInitialize()

◆ finalize()

◆ FindAncestor()

◆ GenFilter()

◆ GeVToMeV()

◆ initialize()

◆ inputHandles()

◆ MeVToGeV()

◆ mmTocm()

◆ msg()

◆ msgLvl()

◆ nFailed()

◆ nNeeded()

◆ nPassed()

◆ outputHandles()

◆ particleData()

◆ particleTable()

◆ partPropSvc()

◆ pdt()

◆ renounce()

◆ renounceArray()

◆ RunHistory()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_mcEventKey

◆ m_mcevents_const

◆ m_mkMcEvent

◆ m_nFail

◆ m_nGoodHtoVV

◆ m_nHtoVV

◆ m_nNeeded

◆ m_nPass

◆ m_PDGChild1

◆ m_PDGChild2

◆ m_PDGGrandParent

◆ m_PDGParent

◆ m_ppSvc

◆ m_StatusParent

◆ m_truthEventKey

◆ m_UseStatusParent

◆ m_varHandleArraysDeclared

◆ m_vhka