#include <PhotonTruthTool.h>

Inheritance diagram for D3PD::PhotonTruthTool:

Collaboration diagram for D3PD::PhotonTruthTool:

Public Member Functions
	PhotonTruthTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Gaudi tool constructor.
virtual StatusCode	initialize ()
	Standard Gaudi `initialize` method.
const xAOD::TruthParticle *	toTruthParticle (const xAOD::Photon &g) const
	Go from a photon to a matching `TruthParticle`.
bool	getMCConv (const xAOD::TruthParticle *truePart, float &RconvMC, float &ZconvMC) const
	Check a truth particle for a conversion.
bool	isPromptPhotonMC (const xAOD::TruthParticle *truePart) const
	Test for a prompt photon.
bool	isPromptParticleMC (const xAOD::TruthParticle *truePart) const
	Test for a prompt particle.
bool	isQuarkBremMC (const xAOD::TruthParticle *truePart) const
	Test for a brem.
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

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
bool	isFinalStatePhotonMC (const xAOD::TruthParticle *truePart) const
	Test for a final-state photon.
bool	isFinalState (const xAOD::TruthParticle *truePart) const
	Test for a final-state particle.
const xAOD::TruthParticle *	getMother (const xAOD::TruthParticle *p) const
	Get the (first) mother particle of p.
const xAOD::TruthVertex *	getMotherVert (const xAOD::TruthParticle *p) const
	Get the mother vertex for p.
std::vector< const xAOD::TruthParticle * >	getMothers (const xAOD::TruthParticle *p) const
	Return list of mother particles of p.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< IMCTruthClassifier >	m_classifier
	Property: classifier tool.
float	m_zTruthConv
	Property: Conversion vertex z cut.
float	m_rTruthConv
	Property: Conversion vertex r cut.
bool	m_useG4Particles
	Property.
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 33 of file PhotonTruthTool.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

◆ PhotonTruthTool()

D3PD::PhotonTruthTool::PhotonTruthTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Standard Gaudi tool constructor.

Parameters

type	The name of the tool type.
name	The tool name.
parent	The tool's Gaudi parent.

Definition at line 30 of file PhotonTruthTool.cxx.

  : AthAlgTool (type, name, parent),
    m_classifier ("MCTruthClassifier")
{
  declareProperty ("Classifier", m_classifier, "Classifier tool instance.");
  declareProperty ("ZTruthConv",     m_zTruthConv = 50e3);
  declareProperty ("RTruthConv",     m_rTruthConv = 800);
  declareProperty ("UseG4Particles", m_useG4Particles = false);
}

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ getMCConv()

bool D3PD::PhotonTruthTool::getMCConv	(	const xAOD::TruthParticle *	truePart,
		float &	RconvMC,
		float &	ZconvMC ) const

Check a truth particle for a conversion.

Parameters

	truePart	The particle to check.
[out]	RconvMC	Radius of the conversion.
[out]	ZconvMC	Z of the conversion.

Returns: True if this is a conversion; otherwise false.

Definition at line 74 of file PhotonTruthTool.cxx.

{
  RconvMC = +9.999e+10 ;
  ZconvMC = +9.999e+10 ;
  if (!truePart) return false;
 
  const xAOD::TruthVertex* v = truePart->decayVtx();
  if (!v || v->nOutgoingParticles() < 2)
    return false;
 
  int pdgId  = truePart->pdgId();
 
  RconvMC = v->perp();
  ZconvMC = v->z();
 
  bool OKint = ( RconvMC < m_rTruthConv ) && ( fabs(ZconvMC) < m_zTruthConv );
 
  if ( pdgId == 22 ) { // photon
    if ( v->nOutgoingParticles() == 2 ) {
      int pdgChild[2] = {0};
      for ( unsigned u=0; u<2 ; ++u) {
        const xAOD::TruthParticle* p = v->outgoingParticle(u);
        if (p)
          pdgChild[u] = p->pdgId();
      }
      if ( pdgChild[0]+pdgChild[1]==0 && pdgChild[0]*pdgChild[1]==-121 ) {
        // gamma -> e+e-
    return OKint ;
      }
    }
  }
  else if ( std::abs(pdgId) == 11 ) { // e+/e-
    v = truePart->prodVtx();
    if ( v->nIncomingParticles()==1 && v->nOutgoingParticles()==2 ) {
      int pdgBrother[2] = {0};
      for ( unsigned u=0 ; u<2 ; ++u ) {
        const xAOD::TruthParticle* p = v->outgoingParticle(u);
        if (p)
          pdgBrother[u] = p->pdgId();
      }
      if ( pdgBrother[0]+pdgBrother[1]==(22+pdgId) &&
           pdgBrother[0]*pdgBrother[1]==(22*pdgId) )
      {
        // e(+/-) -> e(+/-)gamma
    return OKint ;
      }
    }
  }
  return false ;
}

◆ getMother()

const xAOD::TruthParticle * D3PD::PhotonTruthTool::getMother ( const xAOD::TruthParticle * p ) const

private

Get the (first) mother particle of p.

Definition at line 251 of file PhotonTruthTool.cxx.

{
  const xAOD::TruthVertex* v = getMotherVert (p);
 
  if (!v || v->nIncomingParticles() == 0)
    return 0;
 
  return v->incomingParticle(0);
}

◆ getMothers()

std::vector< const xAOD::TruthParticle * > D3PD::PhotonTruthTool::getMothers ( const xAOD::TruthParticle * p ) const

private

Return list of mother particles of p.

Definition at line 266 of file PhotonTruthTool.cxx.

{
  std::vector<const xAOD::TruthParticle*> out;
  const xAOD::TruthVertex* v = getMotherVert (p);
 
  if (v) {
    int n = v->nIncomingParticles();
    out.reserve (n);
    for (int i = 0; i < n; i++)
      out.push_back (v->incomingParticle(i));
  }
 
  return out;
}

◆ getMotherVert()

const xAOD::TruthVertex * D3PD::PhotonTruthTool::getMotherVert ( const xAOD::TruthParticle * p ) const

private

Get the mother vertex for p.

Definition at line 231 of file PhotonTruthTool.cxx.

{
  const xAOD::TruthVertex* v = p->prodVtx();
 
  // if mother is a duplicate, try climbing up the tree by one step...
  while (v && v->nIncomingParticles() == 1 &&
         v->incomingParticle(0)->pdgId() == p->pdgId())
  {
    p = v->incomingParticle(0);
    v = p->prodVtx();
  }
 
  return v;
}

◆ initialize()

StatusCode D3PD::PhotonTruthTool::initialize ( )

virtual

Standard Gaudi initialize method.

Definition at line 46 of file PhotonTruthTool.cxx.

{
  CHECK( AthAlgTool::initialize() );
  CHECK( m_classifier.retrieve() );
  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.

◆ isFinalState()

bool D3PD::PhotonTruthTool::isFinalState ( const xAOD::TruthParticle * truePart ) const

private

Test for a final-state particle.

Definition at line 203 of file PhotonTruthTool.cxx.

{
  if ( truePart == nullptr ) return false;
  if ( !MC::isStable(truePart)) return false; 
  if ( !m_useG4Particles ) return ( !HepMC::is_simulation_particle(truePart) );
    // if it is a photon, keep it regardless of its Geant interaction
    if ( MC::isPhoton(truePart) ) return true ; 
    // reject Geant electron from conversion
    if ( MC::isElectron(truePart) && HepMC::is_simulation_particle(truePart) ) {
      const xAOD::TruthParticle* mother = getMother(truePart) ;
      if ( mother!=0 && MC::isPhoton(mother) )  return false ;
    }
 
    // reject particles interacted in detector
    const xAOD::TruthVertex* v = truePart->decayVtx();
    if (!v) return false;// should never happen, but just in case...
    if ( v->nOutgoingParticles()>0 ) { 
      if ( v->perp()<m_rTruthConv 
       && fabs(v->z())<m_zTruthConv )  return false ;
    }
  return true ;
}

◆ isFinalStatePhotonMC()

bool D3PD::PhotonTruthTool::isFinalStatePhotonMC ( const xAOD::TruthParticle * truePart ) const

private

Test for a final-state photon.

Definition at line 192 of file PhotonTruthTool.cxx.

{
  return ( isFinalState(truePart) && MC::isPhoton(truePart) ) ;
}

◆ isPromptParticleMC()

bool D3PD::PhotonTruthTool::isPromptParticleMC ( const xAOD::TruthParticle * truePart ) const

Test for a prompt particle.

Definition at line 141 of file PhotonTruthTool.cxx.

{
  if ( truePart == 0 ) return false ;
  const std::vector<const xAOD::TruthParticle*> mothers =
    getMothers(truePart);
  unsigned nmothers = mothers.size() ;
  if ( nmothers == 0 ) {
    // particles with NO mother are NEVER classified as PROMPT:
    return false ;
  }
  else if ( nmothers == 1 ) {
    // particles with ONE mother are classified as PROMPT if coming
    // from non-QCD-boson decay:
    // (including exotics like heavy bosons, MSSM Higgs, graviton)
    int aPdgMother = abs(mothers[0]->pdgId());
    return  (( aPdgMother>=23 && aPdgMother<=39 ) || aPdgMother==5000039 ) ;
  }
  else {
    // particles with more mothers are classified as PROMPT
    // if they come from at least 1 parton:
    // (is this sensible?)
    int nParentPartons = 0 ;
    for ( unsigned u=0 ; u<nmothers ; ++u ) {
      int pdgMother = mothers[u]->pdgId() ;
      if ( pdgMother==21 || ( std::abs(pdgMother)<7 && pdgMother!=0 ) )
        ++nParentPartons ;
    }
    return ( nParentPartons >= 1 ) ;
  }
}

◆ isPromptPhotonMC()

bool D3PD::PhotonTruthTool::isPromptPhotonMC ( const xAOD::TruthParticle * truePart ) const

Test for a prompt photon.

Definition at line 131 of file PhotonTruthTool.cxx.

{
  return ( isFinalStatePhotonMC(truePart) && isPromptParticleMC(truePart) ) ;
}

◆ isQuarkBremMC()

bool D3PD::PhotonTruthTool::isQuarkBremMC ( const xAOD::TruthParticle * truePart ) const

Test for a brem.

Definition at line 177 of file PhotonTruthTool.cxx.

{
  if ( ! isFinalStatePhotonMC(truePart) ) return false ;
  const std::vector<const xAOD::TruthParticle*> mothers =
    getMothers(truePart) ;
  if ( mothers.size() != 1 )  return false ;
  int pdgMother = mothers[0]->pdgId() ;
  return ( pdgMother==21 || ( std::abs(pdgMother)<7 && pdgMother!=0 ) ) ;
}

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ 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 >, and AthCheckedComponent<::AthAlgTool >.

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

◆ toTruthParticle()

const xAOD::TruthParticle * D3PD::PhotonTruthTool::toTruthParticle ( const xAOD::Photon & g ) const

Go from a photon to a matching TruthParticle.

Parameters

g	The input photon.
cache	Truth classifier association cache.

Returns: The matching TruthParticle, or null.

Parameters

g	The input photon.

Returns: The matching TruthParticle, or null.

Definition at line 60 of file PhotonTruthTool.cxx.

{
  return std::get<2>(m_classifier->particleTruthClassifier_full(&g));
}

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

ToolHandle<IMCTruthClassifier> D3PD::PhotonTruthTool::m_classifier

private

Property: classifier tool.

Definition at line 110 of file PhotonTruthTool.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_rTruthConv

float D3PD::PhotonTruthTool::m_rTruthConv

private

Property: Conversion vertex r cut.

Definition at line 116 of file PhotonTruthTool.h.

◆ m_useG4Particles

bool D3PD::PhotonTruthTool::m_useG4Particles

private

Property.

Definition at line 119 of file PhotonTruthTool.h.

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

◆ m_zTruthConv

float D3PD::PhotonTruthTool::m_zTruthConv

private

Property: Conversion vertex z cut.

Definition at line 113 of file PhotonTruthTool.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

◆ PhotonTruthTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getMCConv()

◆ getMother()

◆ getMothers()

◆ getMotherVert()

◆ initialize()

◆ inputHandles()

◆ isFinalState()

◆ isFinalStatePhotonMC()

◆ isPromptParticleMC()

◆ isPromptPhotonMC()

◆ isQuarkBremMC()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ toTruthParticle()

◆ updateVHKA()

Member Data Documentation

◆ m_classifier

◆ m_detStore

◆ m_evtStore

◆ m_rTruthConv

◆ m_useG4Particles

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_zTruthConv