#include <BuildTruthTaus.h>

Inheritance diagram for TauAnalysisTools::BuildTruthTaus:

Collaboration diagram for TauAnalysisTools::BuildTruthTaus:

Classes
struct	TauTruthInfo

Public Member Functions
virtual void	print () const =0
	Print the state of the tool. More...

virtual StatusCode	sysInitialize ()
	Function initialising the tool in the correct way in Athena. More...

virtual void	print () const
	Print the state of the tool. More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

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

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
StatusCode	retrieveTruthTaus (TruthTausEvent &truthTausEvent) const

void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

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

Protected Attributes
TruthTausEvent	m_truthTausEvent

bool	m_bTruthTauAvailable {}

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
virtual	~BuildTruthTaus ()=default

virtual StatusCode	initialize () override

virtual void	setTruthMatchingMode () override

virtual StatusCode	retrieveTruthTaus () override

virtual StatusCode	retrieveTruthTaus (ITruthTausEvent &truthTausEvent) const override

StatusCode	buildTruthTausFromTruthParticles (TruthTausEvent &truthTausEvent, const EventContext &ctx) const

StatusCode	examineTruthTau (const xAOD::TruthParticle &xTruthParticle) const

StatusCode	examineTruthTauDecay (const xAOD::TruthParticle &xTruthParticle, TauTruthInfo &truthInfo) const

void	printDecay (const xAOD::TruthParticle &xTruthParticle, int depth=0) const

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
Gaudi::Property< bool >	m_bWriteInvisibleFourMomentum { this, "WriteInvisibleFourMomentum", false}

Gaudi::Property< bool >	m_bWriteVisibleChargedFourMomentum { this, "WriteVisibleChargedFourMomentum", false}

Gaudi::Property< bool >	m_bWriteVisibleNeutralFourMomentum { this, "WriteVisibleNeutralFourMomentum", false}

Gaudi::Property< bool >	m_bWriteDecayModeVector { this, "WriteDecayModeVector", true}

Gaudi::Property< bool >	m_bWriteVertices { this, "WriteVertices", true}

SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_truthTauInputContainer { this, "TruthTauContainerName", "TruthTaus", "Truth tau input container name (truth matching mode)" }

SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_truthParticleContainer { this, "TruthParticleContainerName", "TruthParticles", "Truth particles input container name" }

SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_truthElectronContainer { this, "TruthElectronContainerName", "TruthElectrons", "Truth electrons input container name" }

SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_truthMuonContainer { this, "TruthMuonContainerName", "TruthMuons", "Truth muons input container name" }

SG::ReadHandleKey< xAOD::JetContainer >	m_truthJetContainer { this, "TruthJetContainerName", "AntiKt4TruthDressedWZJets", "Truth jets input container name" }

SG::WriteHandleKey< xAOD::TruthParticleContainer >	m_truthTauOutputContainer { this, "NewTruthTauContainerName", "TruthTaus", "Truth tau output container name" }

SG::ReadDecorHandleKey< xAOD::TruthParticleContainer >	m_originReadDecorKey {this, "inputClassifierParticleOrigin", "TruthParticles.classifierParticleOrigin", "Particle origin"}

SG::ReadDecorHandleKey< xAOD::TruthParticleContainer >	m_typeReadDecorKey {this, "inputClassifierParticleType", "TruthParticles.classifierParticleType", "Particle type"}

SG::ReadDecorHandleKey< xAOD::TruthParticleContainer >	m_outcomeReadDecorKey {this, "inputClassifierParticleOutCome", "TruthParticles.classifierParticleOutCome", "Particle outcome"}

SG::ReadDecorHandleKey< xAOD::TruthParticleContainer >	m_classificationReadDecorKey {this, "inputClassification", "TruthParticles.Classification", "Classification code"}

SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_linkDecoratorKey {this, "originalTruthParticle", "TruthTaus.originalTruthParticle", "Name of the decoration linking to the original truth particle"}

SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_originDecoratorKey {this, "classifierParticleOrigin", "TruthTaus.classifierParticleOrigin", "Name of the decoration which records the particle origin"}

SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_typeDecoratorKey {this, "classifierParticleType", "TruthTaus.classifierParticleType", "Name of the decoration which records the particle type"}

SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_outcomeDecoratorKey {this, "classifierParticleOutCome", "TruthTaus.classifierParticleOutCome", "Name of the decoration which records the particle outcome"}

SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_classificationDecoratorKey {this, "Classification", "TruthTaus.Classification", "Name of the decoration which records the particle classification"}

bool	m_truthMatchingMode = false

MetaStore_t	m_inputMetaStore
	Object accessing the input metadata store. More...

MetaStore_t	m_outputMetaStore
	Object accessing the output metadata store. More...

bool	m_beginInputFileCalled
	Flag helping to discover when the tool misses the opening of the first input file. More...

bool	m_useIncidents

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Callback functions helping in metadata reading/writing
void	setUseIncidents (const bool flag)

virtual void	handle (const Incident &inc)
	Function receiving incidents from IncidentSvc/TEvent. More...

virtual StatusCode	beginInputFile ()
	Function called when a new input file is opened. More...

virtual StatusCode	endInputFile ()
	Function called when the currently open input file got completely processed. More...

virtual StatusCode	beginEvent ()
	Function called when a new events is loaded. More...

virtual StatusCode	metaDataStop ()
	Function called when the tool should write out its metadata. More...

Detailed Description

Definition at line 36 of file BuildTruthTaus.h.

Member Typedef Documentation

◆ MetaStore_t

typedef ServiceHandle< StoreGateSvc > asg::AsgMetadataTool::MetaStore_t

inherited

Type of the metadata store object in Athena.

Definition at line 66 of file AsgMetadataTool.h.

◆ MetaStorePtr_t

typedef const ServiceHandle< StoreGateSvc >& asg::AsgMetadataTool::MetaStorePtr_t

inherited

Type of the metadata store pointer in standalone mode.

Definition at line 68 of file AsgMetadataTool.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ ~BuildTruthTaus()

virtual TauAnalysisTools::BuildTruthTaus::~BuildTruthTaus ( )

privatevirtualdefault

Member Function Documentation

◆ beginEvent()

StatusCode asg::AsgMetadataTool::beginEvent ( )

protectedvirtualinherited

Function called when a new events is loaded.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in AsgElectronEfficiencyCorrectionTool, TrigConf::xAODConfigTool, TauAnalysisTools::TauSelectionTool, TauAnalysisTools::DiTauSelectionTool, TauAnalysisTools::CommonSmearingTool, TauAnalysisTools::DiTauEfficiencyCorrectionsTool, Trig::TrigDecisionTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, Trig::TrigConfBunchCrossingTool, xAODMaker::TriggerMenuMetaDataTool, and Trig::xAODBunchCrossingTool.

Definition at line 201 of file AsgMetadataTool.cxx.

                                           {
  
       // Return gracefully:
       return StatusCode::SUCCESS;
    }

◆ beginInputFile()

StatusCode asg::AsgMetadataTool::beginInputFile ( )

protectedvirtualinherited

Function called when a new input file is opened.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in AsgElectronEfficiencyCorrectionTool, TrigConf::xAODConfigTool, PMGTools::PMGTruthWeightTool, BookkeeperTool, BookkeeperDumperTool, Trig::TrigDecisionTool, xAODMaker::TriggerMenuMetaDataTool, xAODMaker::TruthMetaDataTool, Trig::xAODBunchCrossingTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, and TauAnalysisTools::TauSmearingTool.

Definition at line 185 of file AsgMetadataTool.cxx.

                                               {
  
       // Return gracefully:
       return StatusCode::SUCCESS;
    }

◆ buildTruthTausFromTruthParticles()

StatusCode BuildTruthTaus::buildTruthTausFromTruthParticles	(	TruthTausEvent &	truthTausEvent,
		const EventContext &	ctx
	)		const

private

Definition at line 162 of file BuildTruthTaus.cxx.

 {
   SG::ReadDecorHandle<xAOD::TruthParticleContainer, unsigned int > originReadDecor(m_originReadDecorKey, ctx);
   SG::ReadDecorHandle<xAOD::TruthParticleContainer, unsigned int > typeReadDecor(m_typeReadDecorKey, ctx);
   SG::ReadDecorHandle<xAOD::TruthParticleContainer, unsigned int > outcomeReadDecor(m_outcomeReadDecorKey, ctx);
   SG::ReadDecorHandle<xAOD::TruthParticleContainer, unsigned int > classificationReadDecor(m_classificationReadDecorKey, ctx);
  
   SG::WriteDecorHandle<xAOD::TruthParticleContainer, ElementLink<xAOD::TruthParticleContainer> > linkDecorator(m_linkDecoratorKey, ctx);
   SG::WriteDecorHandle<xAOD::TruthParticleContainer, unsigned int > originDecorator(m_originDecoratorKey, ctx);
   SG::WriteDecorHandle<xAOD::TruthParticleContainer, unsigned int > typeDecorator(m_typeDecoratorKey, ctx);
   SG::WriteDecorHandle<xAOD::TruthParticleContainer, unsigned int > outcomeDecorator(m_outcomeDecoratorKey, ctx);
   SG::WriteDecorHandle<xAOD::TruthParticleContainer, unsigned int > classificationDecorator(m_classificationDecoratorKey, ctx);
  
   for (auto xTruthParticle : *truthTausEvent.m_xTruthParticleContainer)
   {
     if ( xTruthParticle->isTau() )
     {
       auto xTruthTau = std::make_unique<xAOD::TruthParticle>();
       xTruthTau->makePrivateStore( *xTruthParticle );
  
       if ( examineTruthTau(*xTruthTau).isFailure() )
       {
         continue;
       }
  
       // adding decorations onto the truth tau requires that it is in the final Aux store
       truthTausEvent.m_xTruthTauContainer->push_back(std::move(xTruthTau));
       xAOD::TruthParticle* truthTau = truthTausEvent.m_xTruthTauContainer->back();
  
       // propagate MCTruthClassifier decorations
       typeDecorator(*truthTau) = typeReadDecor(*xTruthParticle);
       originDecorator(*truthTau) = originReadDecor(*xTruthParticle);
       outcomeDecorator(*truthTau) = outcomeReadDecor(*xTruthParticle);
       classificationDecorator(*truthTau) = classificationReadDecor(*xTruthParticle);
  
       // create link to the original TruthParticle
       ElementLink < xAOD::TruthParticleContainer > lTruthParticleLink(xTruthParticle, *truthTausEvent.m_xTruthParticleContainer);
       linkDecorator(*truthTau) = lTruthParticleLink;
     }
   }
   return StatusCode::SUCCESS;
 }

◆ declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [2/4]

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

◆ declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [4/4]

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

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

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

◆ endInputFile()

StatusCode asg::AsgMetadataTool::endInputFile ( )

protectedvirtualinherited

Function called when the currently open input file got completely processed.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in BookkeeperTool, BookkeeperDumperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 193 of file AsgMetadataTool.cxx.

                                             {
  
       // Return gracefully:
       return StatusCode::SUCCESS;
    }

◆ evtStore() [1/2]

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

◆ evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ examineTruthTau()

StatusCode BuildTruthTaus::examineTruthTau ( const xAOD::TruthParticle & xTruthParticle ) const

private

Definition at line 206 of file BuildTruthTaus.cxx.

 {
   // skip this tau if it has no decay vertex, should not happen
   if ( !xTruthParticle.hasDecayVtx() )
     return StatusCode::FAILURE;
  
   ATH_MSG_VERBOSE("looking for charged daughters of a truth tau");
  
   TauTruthInfo truthInfo;
  
   const xAOD::TruthVertex* xDecayVertex = xTruthParticle.decayVtx();
   if (xDecayVertex == nullptr)
     return StatusCode::FAILURE;
   for ( size_t iOutgoingParticle = 0; iOutgoingParticle < xDecayVertex->nOutgoingParticles(); ++iOutgoingParticle )
   {
     const xAOD::TruthParticle* xTruthDaughter = xDecayVertex->outgoingParticle(iOutgoingParticle);
     if (xTruthDaughter == nullptr)
     {
       ATH_MSG_ERROR("Truth daughter of tau decay was not found in "<< m_truthParticleContainer.key() <<" container. Please ensure that this container has the full tau decay information or produce the TruthTaus container in AtlasDerivation.");
       return StatusCode::FAILURE;
     }
  
     // if tau decays into tau this is not a proper tau decay
     if ( xTruthDaughter->isTau() )
     {
       ATH_MSG_VERBOSE("Tau decays into a tau itself -> skip this decay");
       return StatusCode::FAILURE;
     }
   }
  
   examineTruthTauDecay(xTruthParticle, truthInfo).ignore();
  
   if (truthInfo.m_bIsHadronicTau)
     ATH_MSG_VERBOSE(truthInfo.m_iNChargedDaughters << " prong hadronic truth tau was found with uniqueID "<<HepMC::uniqueID(xTruthParticle));
   else
     ATH_MSG_VERBOSE(truthInfo.m_iNChargedDaughters << " prong leptonic truth tau was found with uniqueID "<<HepMC::uniqueID(xTruthParticle));
   if ( truthInfo.m_iNChargedDaughters%2 == 0 )
   {
     ATH_MSG_WARNING("found tau with even multiplicity: " << truthInfo.m_iNChargedDaughters);
     printDecay(xTruthParticle);
   }
  
   static const SG::Decorator<double> decPtVis("pt_vis");
   static const SG::Decorator<double> decEtaVis("eta_vis");
   static const SG::Decorator<double> decPhiVis("phi_vis");
   static const SG::Decorator<double> decMVis("m_vis");
  
   static const SG::Decorator<size_t> decNumCharged("numCharged");
   static const SG::Decorator<size_t> decNumChargedPion("numChargedPion");
   static const SG::Decorator<size_t> decNumNeutral("numNeutral");
   static const SG::Decorator<size_t> decNumNeutralPion("numNeutralPion");
  
   decPtVis(xTruthParticle) = truthInfo.m_vTruthVisTLV.Pt();
   decEtaVis(xTruthParticle) = truthInfo.m_vTruthVisTLV.Eta();
   decPhiVis(xTruthParticle) = truthInfo.m_vTruthVisTLV.Phi();
   decMVis(xTruthParticle) = truthInfo.m_vTruthVisTLV.M();
  
   decNumCharged(xTruthParticle) = truthInfo.m_iNChargedDaughters;
   decNumChargedPion(xTruthParticle) = truthInfo.m_iNChargedPions;
   decNumNeutral(xTruthParticle) = truthInfo.m_iNNeutralPions+truthInfo.m_iNNeutralOthers;
   decNumNeutralPion(xTruthParticle) = truthInfo.m_iNNeutralPions;
  
   static const SG::Decorator<char> decIsHadronicTau("IsHadronicTau");
   decIsHadronicTau(xTruthParticle) = (char)truthInfo.m_bIsHadronicTau;
  
   if ( m_bWriteInvisibleFourMomentum )
   {
     TLorentzVector vTruthInvisTLV = xTruthParticle.p4() - truthInfo.m_vTruthVisTLV;
     static const SG::Decorator<double> decPtInvis("pt_invis");
     static const SG::Decorator<double> decEtaInvis("eta_invis");
     static const SG::Decorator<double> decPhiInvis("phi_invis");
     static const SG::Decorator<double> decMInvis("m_invis");
     decPtInvis(xTruthParticle)  = vTruthInvisTLV.Pt();
     decEtaInvis(xTruthParticle) = vTruthInvisTLV.Eta();
     decPhiInvis(xTruthParticle) = vTruthInvisTLV.Phi();
     decMInvis(xTruthParticle)   = vTruthInvisTLV.M();
   }
  
   if ( m_bWriteVisibleChargedFourMomentum )
   {
     static const SG::Decorator<double> decPtVisCharged("pt_vis_charged");
     static const SG::Decorator<double> decEtaVisCharged("eta_vis_charged");
     static const SG::Decorator<double> decPhiVisCharged("phi_vis_charged");
     static const SG::Decorator<double> decMVisCharged("m_vis_charged");
     decPtVisCharged(xTruthParticle)  = truthInfo.m_vTruthVisTLVCharged.Pt();
     decEtaVisCharged(xTruthParticle) = truthInfo.m_vTruthVisTLVCharged.Eta();
     decPhiVisCharged(xTruthParticle) = truthInfo.m_vTruthVisTLVCharged.Phi();
     decMVisCharged(xTruthParticle)   = truthInfo.m_vTruthVisTLVCharged.M();
   }
  
   if ( m_bWriteVisibleNeutralFourMomentum )
   {
     static const SG::Decorator<double> decPtVisNeutral("pt_vis_neutral");
     static const SG::Decorator<double> decEtaVisNeutral("eta_vis_neutral");
     static const SG::Decorator<double> decPhiVisNeutral("phi_vis_neutral");
     static const SG::Decorator<double> decMVisNeutral("m_vis_neutral");
     decPtVisNeutral(xTruthParticle)  = truthInfo.m_vTruthVisTLVNeutral.Pt();
     decEtaVisNeutral(xTruthParticle) = truthInfo.m_vTruthVisTLVNeutral.Eta();
     decPhiVisNeutral(xTruthParticle) = truthInfo.m_vTruthVisTLVNeutral.Phi();
     decMVisNeutral(xTruthParticle)   = truthInfo.m_vTruthVisTLVNeutral.M();
   }
  
   if ( m_bWriteDecayModeVector )
   {
     static const SG::Decorator<std::vector<int> > decDecayModeVector("DecayModeVector");
     decDecayModeVector(xTruthParticle) = truthInfo.m_vDecayMode;
   }
  
   if ( m_bWriteVertices )
   {
     // tau decay vertex
     static const SG::Decorator<float> decDecayVertexX("decay_vertex_x");
     static const SG::Decorator<float> decDecayVertexY("decay_vertex_y");
     static const SG::Decorator<float> decDecayVertexZ("decay_vertex_z"); 
    
     decDecayVertexX(xTruthParticle) = truthInfo.m_vDecayVertex.X();
     decDecayVertexY(xTruthParticle) = truthInfo.m_vDecayVertex.Y();
     decDecayVertexZ(xTruthParticle) = truthInfo.m_vDecayVertex.Z();
  
     // tau production vertex
     static const SG::Decorator<float> decProdVertexX("prod_vertex_x");
     static const SG::Decorator<float> decProdVertexY("prod_vertex_y");
     static const SG::Decorator<float> decProdVertexZ("prod_vertex_z");
     
     decProdVertexX(xTruthParticle) = truthInfo.m_vProdVertex.X();
     decProdVertexY(xTruthParticle) = truthInfo.m_vProdVertex.Y();
     decProdVertexZ(xTruthParticle) = truthInfo.m_vProdVertex.Z();
   }
  
   return StatusCode::SUCCESS;
 }

◆ examineTruthTauDecay()

StatusCode BuildTruthTaus::examineTruthTauDecay	(	const xAOD::TruthParticle &	xTruthParticle,
		TauTruthInfo &	truthInfo
	)		const

private

Definition at line 339 of file BuildTruthTaus.cxx.

 {
   // get vertex and check if it exists
   const xAOD::TruthVertex* xDecayVertex = xTruthParticle.decayVtx();
   if (!xDecayVertex)
     return StatusCode::SUCCESS;
  
   truthInfo.m_vDecayVertex.SetXYZ(xDecayVertex->x(),xDecayVertex->y(),xDecayVertex->z());
  
   if (xTruthParticle.hasProdVtx() ) {
      const xAOD::TruthVertex* xProdVertex = xTruthParticle.prodVtx();
      truthInfo.m_vProdVertex.SetXYZ(xProdVertex->x(),xProdVertex->y(),xProdVertex->z());
   } else {
      truthInfo.m_vProdVertex.SetXYZ(-1234,-1234,-1234);
   }  
  
   for ( size_t iOutgoingParticle = 0; iOutgoingParticle < xDecayVertex->nOutgoingParticles(); ++iOutgoingParticle )
   {
     const xAOD::TruthParticle* xTruthDaughter = xDecayVertex->outgoingParticle(iOutgoingParticle);
     if (xTruthDaughter == nullptr)
     {
       ATH_MSG_ERROR("Truth daughter of tau decay was not found in "<< m_truthParticleContainer.key() <<" container. Please ensure that this container has the full tau decay information or produce the TruthTaus container in AtlasDerivation.");
       return StatusCode::FAILURE;
     }
  
     int iAbsPdgId = xTruthDaughter->absPdgId();
     int iPdgId = xTruthDaughter->pdgId();
  
     // look at decay of unstable particles
     if (MC::isDecayed(xTruthDaughter)  || !MC::isPhysical(xTruthDaughter))
     {
       if ( iAbsPdgId != 111 && iAbsPdgId != 311 && iAbsPdgId != 310 && iAbsPdgId != 130 )
       {
         examineTruthTauDecay(*xTruthDaughter, truthInfo).ignore();
         continue;
       }
     }
  
     // only process stable particles
     if (!MC::isStable(xTruthDaughter) && !MC::isDecayed(xTruthDaughter))
       continue;
  
     // add pdgID to vector for decay mode classification
     truthInfo.m_vDecayMode.push_back(iPdgId);
  
     // if tau decays leptonically, indicated by an electron/muon neutrino then
     // it is not a hadronic decay
     if ( xTruthDaughter->isHadron() )
       truthInfo.m_bIsHadronicTau = true;
  
     // ignore neutrinos for further progress
     if ( xTruthDaughter->isNeutrino() )
     {
       ATH_MSG_VERBOSE("found neutrino decay particle with PdgId "<<iPdgId);
       continue;
     }
  
     // add momentum of non-neutrino particle to visible momentum
     truthInfo.m_vTruthVisTLV += xTruthDaughter->p4();
     if ( m_bWriteVisibleChargedFourMomentum )
       if ( xTruthDaughter->isCharged() )
         truthInfo.m_vTruthVisTLVCharged += xTruthDaughter->p4();
     if ( m_bWriteVisibleNeutralFourMomentum )
       if ( xTruthDaughter->isNeutral() )
         truthInfo.m_vTruthVisTLVNeutral += xTruthDaughter->p4();
  
     // only count charged decay particles
     if ( xTruthDaughter->isCharged() )
     {
       ATH_MSG_VERBOSE("found charged decay particle with PdgId "<<iPdgId);
       truthInfo.m_iNChargedDaughters++;
       // count charged pions
       if (iAbsPdgId==211) truthInfo.m_iNChargedPions++;
       else truthInfo.m_iNChargedOthers++;
     }
     else
     {
       ATH_MSG_VERBOSE("found neutral decay particle with PdgId "<<iPdgId);
       // count neutral pions
       if (iAbsPdgId==111) truthInfo.m_iNNeutralPions++;
       else truthInfo.m_iNNeutralOthers++;
     }
   }
   return StatusCode::SUCCESS;
 }

◆ 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

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

◆ getProperty()

template<class T >

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

inherited

Get one of the tool's properties.

◆ handle()

void asg::AsgMetadataTool::handle ( const Incident & inc )

protectedvirtualinherited

Function receiving incidents from IncidentSvc/TEvent.

Reimplemented in Trig::TrigDecisionTool.

Definition at line 135 of file AsgMetadataTool.cxx.

                                                      {
  
       // Tell the user what's happening:
       ATH_MSG_VERBOSE( "Callback received with incident: " << inc.type() );
  
       // Call the appropriate member function:
       if( inc.type() == IncidentType::BeginInputFile ) {
         m_beginInputFileCalled = true;
         if( beginInputFile().isFailure() ) {
           ATH_MSG_FATAL( "Failed to call beginInputFile()" );
           throw std::runtime_error( "Couldn't call beginInputFile()" );
          }
       } else if( inc.type() == IncidentType::EndInputFile ) {
         if( endInputFile().isFailure() ) {
           ATH_MSG_FATAL( "Failed to call endInputFile()" );
           throw std::runtime_error( "Couldn't call endInputFile()" );
          }
       } else if( inc.type() == IncidentType::BeginEvent ) {
          // If the tool didn't catch the begin input file incident for the
          // first input file of the job, then call the appropriate function
          // now.
          if( ! m_beginInputFileCalled ) {
             m_beginInputFileCalled = true;
             if( beginInputFile().isFailure() ) {
                ATH_MSG_FATAL( "Failed to call beginInputFile()" );
                throw std::runtime_error( "Couldn't call beginInputFile()" );
             }
          }
          if( beginEvent().isFailure() ) {
             ATH_MSG_FATAL( "Failed to call beginEvent()" );
             throw std::runtime_error( "Couldn't call beginEvent()" );
          }
  
      #ifdef XAOD_STANDALONE
       } else if( inc.type() == IncidentType::MetaDataStop ) {
          if( metaDataStop().isFailure() ) {
             ATH_MSG_FATAL( "Failed to call metaDataStop()" );
             throw std::runtime_error( "Couldn't call metaDataStop()" );
          }
          
      #endif // XAOD_STANDALONE
       } else {
          ATH_MSG_WARNING( "Unknown incident type received in AsgMetaDataTool: " << inc.type() );
       }
  
       return;
    }

◆ initialize()

StatusCode BuildTruthTaus::initialize ( )

overrideprivatevirtual

Implements TauAnalysisTools::IBuildTruthTaus.

Reimplemented in TauAnalysisTools::TauTruthMatchingTool, and TauAnalysisTools::DiTauTruthMatchingTool.

Definition at line 32 of file BuildTruthTaus.cxx.

 {
   if (!m_truthMatchingMode) {
     ATH_MSG_INFO( "Initializing BuildTruthTaus, will generate " <<  m_truthTauOutputContainer.key() << " from " << m_truthParticleContainer.key() << " container" );
   }
   else {
     ATH_MSG_INFO( "Initializing BuildTruthTaus in truth matching mode, using input container " << m_truthTauInputContainer.key() );
   }
  
   // input containers
   ATH_CHECK( m_truthTauInputContainer.initialize(m_truthMatchingMode) );
   ATH_CHECK( m_truthParticleContainer.initialize(SG::AllowEmpty) );
   ATH_CHECK( m_truthElectronContainer.initialize(SG::AllowEmpty) );
   ATH_CHECK( m_truthMuonContainer.initialize(SG::AllowEmpty) );
   ATH_CHECK( m_truthJetContainer.initialize(SG::AllowEmpty) );
  
   // in truth matching mode, truth electron/muon/jet containers are optional but expected
   if (m_truthMatchingMode) {
     if (m_truthElectronContainer.empty()) {
       ATH_MSG_WARNING("Truth electron container is not available, won't perform matching to truth electrons");
     }
     if (m_truthMuonContainer.empty()) {
       ATH_MSG_WARNING("Truth muon container is not available, won't perform matching to truth muons");
     }
     if (m_truthJetContainer.empty()) {
       ATH_MSG_WARNING("Truth jet container is not available, won't perform matching to truth jets");
     }
   }
  
   // output container
   ATH_CHECK( m_truthTauOutputContainer.initialize(!m_truthMatchingMode) );
  
   // input decorations
   ATH_CHECK( m_originReadDecorKey.initialize(!m_truthMatchingMode) );
   ATH_CHECK( m_typeReadDecorKey.initialize(!m_truthMatchingMode) );
   ATH_CHECK( m_outcomeReadDecorKey.initialize(!m_truthMatchingMode) );
   ATH_CHECK( m_classificationReadDecorKey.initialize(!m_truthMatchingMode) );
   // output decorations
   ATH_CHECK( m_linkDecoratorKey.initialize(!m_truthMatchingMode) );
   ATH_CHECK( m_originDecoratorKey.initialize(!m_truthMatchingMode) );
   ATH_CHECK( m_typeDecoratorKey.initialize(!m_truthMatchingMode) );
   ATH_CHECK( m_outcomeDecoratorKey.initialize(!m_truthMatchingMode) );
   ATH_CHECK( m_classificationDecoratorKey.initialize(!m_truthMatchingMode) );
  
   // drop at earliest occasion
   m_bTruthTauAvailable = !m_truthTauInputContainer.empty();
  
   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.

◆ inputMetaStore()

AsgMetadataTool::MetaStorePtr_t asg::AsgMetadataTool::inputMetaStore ( ) const

inherited

Accessor for the input metadata store.

Definition at line 93 of file AsgMetadataTool.cxx.

                                                                        {
  
 #ifdef XAOD_STANDALONE
       return &m_inputMetaStore;
 #else // XAOD_STANDALONE
       return m_inputMetaStore;
 #endif // XAOD_STANDALONE
    }

◆ metaDataStop()

StatusCode asg::AsgMetadataTool::metaDataStop ( )

protectedvirtualinherited

Function called when the tool should write out its metadata.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in BookkeeperTool, BookkeeperDumperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 209 of file AsgMetadataTool.cxx.

                                             {
  
       // Return gracefully:
       return StatusCode::SUCCESS;
    }

◆ msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

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

◆ outputMetaStore()

AsgMetadataTool::MetaStorePtr_t asg::AsgMetadataTool::outputMetaStore ( ) const

inherited

Accessor for the output metadata store.

Definition at line 102 of file AsgMetadataTool.cxx.

                                                                         {
  
 #ifdef XAOD_STANDALONE
       return &m_outputMetaStore;
 #else // XAOD_STANDALONE
       return m_outputMetaStore;
 #endif // XAOD_STANDALONE
    }

◆ print() [1/2]

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

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

◆ print() [2/2]

virtual void asg::IAsgTool::print ( ) const

pure virtualinherited

Print the state of the tool.

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

◆ printDecay()

void BuildTruthTaus::printDecay	(	const xAOD::TruthParticle &	xTruthParticle,
		int	depth = `0`
	)		const

private

Definition at line 426 of file BuildTruthTaus.cxx.

 {
   // loop over all decay particles, print their kinematic and other properties
  
   const xAOD::TruthVertex* xDecayVertex = xTruthParticle.decayVtx();
   if (xDecayVertex == nullptr)
     return;
  
   for ( size_t iOutgoingParticle = 0; iOutgoingParticle < xDecayVertex->nOutgoingParticles(); ++iOutgoingParticle )
   {
     const xAOD::TruthParticle* xTruthDaughter = xDecayVertex->outgoingParticle(iOutgoingParticle);
     if (xTruthDaughter == nullptr)
     {
       ATH_MSG_WARNING("Truth daughter of tau decay was not found in "<< m_truthParticleContainer.key() <<" container. Please ensure that this container has the full tau decay information or produce the TruthTaus container in AtlasDerivation.");
       return;
     }
     ATH_MSG_WARNING("depth "<<depth
                     <<" e "<<xTruthDaughter->e()
                     <<" eta "<<xTruthDaughter->p4().Eta()
                     <<" phi "<<xTruthDaughter->p4().Phi()
                     <<" pdgid "<<xTruthDaughter->pdgId()
                     <<" status "<<xTruthDaughter->status()
                     <<" uniqueID "<<HepMC::uniqueID(xTruthDaughter));
     printDecay(*xTruthDaughter, depth+1);
   }
 }

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

◆ retrieveTruthTaus() [1/3]

StatusCode BuildTruthTaus::retrieveTruthTaus ( )

overrideprivatevirtual

Implements TauAnalysisTools::IBuildTruthTaus.

Definition at line 83 of file BuildTruthTaus.cxx.

 {
   return retrieveTruthTaus (m_truthTausEvent);
 }

◆ retrieveTruthTaus() [2/3]

StatusCode BuildTruthTaus::retrieveTruthTaus ( ITruthTausEvent & truthTausEvent ) const

overrideprivatevirtual

Implements TauAnalysisTools::IBuildTruthTaus.

Definition at line 89 of file BuildTruthTaus.cxx.

 {
   return retrieveTruthTaus (dynamic_cast<TruthTausEvent&> (truthTausEvent));
 }

◆ retrieveTruthTaus() [3/3]

StatusCode BuildTruthTaus::retrieveTruthTaus ( TruthTausEvent & truthTausEvent ) const

protected

Definition at line 95 of file BuildTruthTaus.cxx.

 {
   const EventContext& ctx = Gaudi::Hive::currentContext();
  
   // truth matching mode
   if (m_truthMatchingMode) {
     if (!m_truthElectronContainer.empty()) {
       SG::ReadHandle<xAOD::TruthParticleContainer> truthElectronsHandle(m_truthElectronContainer, ctx);
       if (!truthElectronsHandle.isValid()) {
     ATH_MSG_ERROR ("Could not retrieve " << truthElectronsHandle.key());
     return StatusCode::FAILURE;
       }
       truthTausEvent.m_xTruthElectronContainerConst = truthElectronsHandle.cptr();
     }
  
     if (!m_truthMuonContainer.empty()) {
       SG::ReadHandle<xAOD::TruthParticleContainer> truthMuonsHandle(m_truthMuonContainer, ctx);
       if (!truthMuonsHandle.isValid()) {
     ATH_MSG_ERROR ("Could not retrieve " << truthMuonsHandle.key());
     return StatusCode::FAILURE;
       }
       truthTausEvent.m_xTruthMuonContainerConst = truthMuonsHandle.cptr();
     }
  
     if (!m_truthJetContainer.empty()) {
       SG::ReadHandle<xAOD::JetContainer> truthJetsHandle(m_truthJetContainer, ctx);
       if (!truthJetsHandle.isValid()) {
     ATH_MSG_ERROR ("Could not retrieve " << truthJetsHandle.key());
     return StatusCode::FAILURE;
       }
       truthTausEvent.m_xTruthJetContainerConst = truthJetsHandle.cptr();
     }
  
     SG::ReadHandle<xAOD::TruthParticleContainer> truthTausHandle(m_truthTauInputContainer, ctx);
     if (!truthTausHandle.isValid()) {
       ATH_MSG_ERROR ("Could not retrieve " << truthTausHandle.key());
       return StatusCode::FAILURE;
     }
     truthTausEvent.m_xTruthTauContainerConst = truthTausHandle.cptr();
   }
   // truth tau building mode
   else {
     SG::ReadHandle<xAOD::TruthParticleContainer> truthParticlesHandle(m_truthParticleContainer, ctx);
     if (!truthParticlesHandle.isValid()) {
       ATH_MSG_ERROR ("Could not retrieve " << truthParticlesHandle.key());
       return StatusCode::FAILURE;
     }
     truthTausEvent.m_xTruthParticleContainer = truthParticlesHandle.cptr();
  
     auto truthTausOutput = std::make_unique<xAOD::TruthParticleContainer>();
     auto truthTausOutputAux = std::make_unique<xAOD::TruthParticleAuxContainer>();
     truthTausOutput->setStore(truthTausOutputAux.get());
     truthTausEvent.m_xTruthTauContainer = truthTausOutput.get();
  
     auto writeHandle = SG::makeHandle(m_truthTauOutputContainer, ctx);
     ATH_CHECK(writeHandle.record(std::move(truthTausOutput), std::move(truthTausOutputAux)));
  
     ATH_CHECK( buildTruthTausFromTruthParticles(truthTausEvent, ctx) );
   }
  
   return StatusCode::SUCCESS;
 }

◆ setTruthMatchingMode()

virtual void TauAnalysisTools::BuildTruthTaus::setTruthMatchingMode ( )

inlineoverrideprivatevirtual

Implements TauAnalysisTools::IBuildTruthTaus.

Definition at line 65 of file BuildTruthTaus.h.

                                                {
     m_truthMatchingMode = true;
   };

◆ setUseIncidents()

void asg::AsgMetadataTool::setUseIncidents ( const bool flag )

inlineprotectedinherited

Definition at line 132 of file AsgMetadataTool.h.

    {
       m_useIncidents = flag;
    }

◆ sysInitialize()

StatusCode asg::AsgMetadataTool::sysInitialize ( )

virtualinherited

Function initialising the tool in the correct way in Athena.

This function is used to set up the callbacks from IncidentSvc in Athena at the right time during initialisation, without the user having to do anything special in his/her code.

Reimplemented from AthCommonDataStore< AthCommonMsg< AlgTool > >.

Definition at line 115 of file AsgMetadataTool.cxx.

                                              {
  
 #ifndef XAOD_STANDALONE
       if (m_useIncidents) {
          // Connect to the IncidentSvc:
          ServiceHandle< IIncidentSvc > incSvc( "IncidentSvc", name() );
          ATH_CHECK( incSvc.retrieve() );
  
          // Set up the right callbacks: don't rethrow exceptions, any failure and we should end
          incSvc->addListener( this, IncidentType::BeginEvent, 0, false );
       }
       // Let the base class do its thing:
       ATH_CHECK( AlgTool::sysInitialize() );
  
 #endif // not XAOD_STANDALONE
  
       // Return gracefully:
       return StatusCode::SUCCESS;
    }

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

bool asg::AsgMetadataTool::m_beginInputFileCalled

privateinherited

Flag helping to discover when the tool misses the opening of the first input file.

Definition at line 126 of file AsgMetadataTool.h.

◆ m_bTruthTauAvailable

bool TauAnalysisTools::BuildTruthTaus::m_bTruthTauAvailable {}

protected

Definition at line 113 of file BuildTruthTaus.h.

◆ m_bWriteDecayModeVector

Gaudi::Property<bool> TauAnalysisTools::BuildTruthTaus::m_bWriteDecayModeVector { this, "WriteDecayModeVector", true}

private

Definition at line 121 of file BuildTruthTaus.h.

◆ m_bWriteInvisibleFourMomentum

Gaudi::Property<bool> TauAnalysisTools::BuildTruthTaus::m_bWriteInvisibleFourMomentum { this, "WriteInvisibleFourMomentum", false}

private

Definition at line 118 of file BuildTruthTaus.h.

◆ m_bWriteVertices

Gaudi::Property<bool> TauAnalysisTools::BuildTruthTaus::m_bWriteVertices { this, "WriteVertices", true}

private

Definition at line 122 of file BuildTruthTaus.h.

◆ m_bWriteVisibleChargedFourMomentum

Gaudi::Property<bool> TauAnalysisTools::BuildTruthTaus::m_bWriteVisibleChargedFourMomentum { this, "WriteVisibleChargedFourMomentum", false}

private

Definition at line 119 of file BuildTruthTaus.h.

◆ m_bWriteVisibleNeutralFourMomentum

Gaudi::Property<bool> TauAnalysisTools::BuildTruthTaus::m_bWriteVisibleNeutralFourMomentum { this, "WriteVisibleNeutralFourMomentum", false}

private

Definition at line 120 of file BuildTruthTaus.h.

◆ m_classificationDecoratorKey

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> TauAnalysisTools::BuildTruthTaus::m_classificationDecoratorKey {this, "Classification", "TruthTaus.Classification", "Name of the decoration which records the particle classification"}

private

Definition at line 143 of file BuildTruthTaus.h.

◆ m_classificationReadDecorKey

SG::ReadDecorHandleKey<xAOD::TruthParticleContainer> TauAnalysisTools::BuildTruthTaus::m_classificationReadDecorKey {this, "inputClassification", "TruthParticles.Classification", "Classification code"}

private

Definition at line 137 of file BuildTruthTaus.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_inputMetaStore

MetaStore_t asg::AsgMetadataTool::m_inputMetaStore

privateinherited

Object accessing the input metadata store.

Definition at line 119 of file AsgMetadataTool.h.

◆ m_linkDecoratorKey

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> TauAnalysisTools::BuildTruthTaus::m_linkDecoratorKey {this, "originalTruthParticle", "TruthTaus.originalTruthParticle", "Name of the decoration linking to the original truth particle"}

private

Definition at line 139 of file BuildTruthTaus.h.

◆ m_originDecoratorKey

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> TauAnalysisTools::BuildTruthTaus::m_originDecoratorKey {this, "classifierParticleOrigin", "TruthTaus.classifierParticleOrigin", "Name of the decoration which records the particle origin"}

private

Definition at line 140 of file BuildTruthTaus.h.

◆ m_originReadDecorKey

SG::ReadDecorHandleKey<xAOD::TruthParticleContainer> TauAnalysisTools::BuildTruthTaus::m_originReadDecorKey {this, "inputClassifierParticleOrigin", "TruthParticles.classifierParticleOrigin", "Particle origin"}

private

Definition at line 134 of file BuildTruthTaus.h.

◆ m_outcomeDecoratorKey

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> TauAnalysisTools::BuildTruthTaus::m_outcomeDecoratorKey {this, "classifierParticleOutCome", "TruthTaus.classifierParticleOutCome", "Name of the decoration which records the particle outcome"}

private

Definition at line 142 of file BuildTruthTaus.h.

◆ m_outcomeReadDecorKey

SG::ReadDecorHandleKey<xAOD::TruthParticleContainer> TauAnalysisTools::BuildTruthTaus::m_outcomeReadDecorKey {this, "inputClassifierParticleOutCome", "TruthParticles.classifierParticleOutCome", "Particle outcome"}

private

Definition at line 136 of file BuildTruthTaus.h.

◆ m_outputMetaStore

MetaStore_t asg::AsgMetadataTool::m_outputMetaStore

privateinherited

Object accessing the output metadata store.

Definition at line 121 of file AsgMetadataTool.h.

◆ m_truthElectronContainer

SG::ReadHandleKey<xAOD::TruthParticleContainer> TauAnalysisTools::BuildTruthTaus::m_truthElectronContainer { this, "TruthElectronContainerName", "TruthElectrons", "Truth electrons input container name" }

private

Definition at line 127 of file BuildTruthTaus.h.

◆ m_truthJetContainer

SG::ReadHandleKey<xAOD::JetContainer> TauAnalysisTools::BuildTruthTaus::m_truthJetContainer { this, "TruthJetContainerName", "AntiKt4TruthDressedWZJets", "Truth jets input container name" }

private

Definition at line 129 of file BuildTruthTaus.h.

◆ m_truthMatchingMode

bool TauAnalysisTools::BuildTruthTaus::m_truthMatchingMode = false

private

Definition at line 145 of file BuildTruthTaus.h.

◆ m_truthMuonContainer

SG::ReadHandleKey<xAOD::TruthParticleContainer> TauAnalysisTools::BuildTruthTaus::m_truthMuonContainer { this, "TruthMuonContainerName", "TruthMuons", "Truth muons input container name" }

private

Definition at line 128 of file BuildTruthTaus.h.

◆ m_truthParticleContainer

SG::ReadHandleKey<xAOD::TruthParticleContainer> TauAnalysisTools::BuildTruthTaus::m_truthParticleContainer { this, "TruthParticleContainerName", "TruthParticles", "Truth particles input container name" }

private

Definition at line 126 of file BuildTruthTaus.h.

◆ m_truthTauInputContainer

SG::ReadHandleKey<xAOD::TruthParticleContainer> TauAnalysisTools::BuildTruthTaus::m_truthTauInputContainer { this, "TruthTauContainerName", "TruthTaus", "Truth tau input container name (truth matching mode)" }

private

Definition at line 125 of file BuildTruthTaus.h.

◆ m_truthTauOutputContainer

SG::WriteHandleKey<xAOD::TruthParticleContainer> TauAnalysisTools::BuildTruthTaus::m_truthTauOutputContainer { this, "NewTruthTauContainerName", "TruthTaus", "Truth tau output container name" }

private

Definition at line 131 of file BuildTruthTaus.h.

◆ m_truthTausEvent

TruthTausEvent TauAnalysisTools::BuildTruthTaus::m_truthTausEvent

protected

Definition at line 110 of file BuildTruthTaus.h.

◆ m_typeDecoratorKey

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> TauAnalysisTools::BuildTruthTaus::m_typeDecoratorKey {this, "classifierParticleType", "TruthTaus.classifierParticleType", "Name of the decoration which records the particle type"}

private

Definition at line 141 of file BuildTruthTaus.h.

◆ m_typeReadDecorKey

SG::ReadDecorHandleKey<xAOD::TruthParticleContainer> TauAnalysisTools::BuildTruthTaus::m_typeReadDecorKey {this, "inputClassifierParticleType", "TruthParticles.classifierParticleType", "Particle type"}

private

Definition at line 135 of file BuildTruthTaus.h.

◆ m_useIncidents

bool asg::AsgMetadataTool::m_useIncidents

privateinherited

Definition at line 128 of file AsgMetadataTool.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.

The documentation for this class was generated from the following files:

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Callback functions helping in metadata reading/writing

Detailed Description

Member Typedef Documentation

◆ MetaStore_t

◆ MetaStorePtr_t

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ ~BuildTruthTaus()

Member Function Documentation

◆ beginEvent()

◆ beginInputFile()

◆ buildTruthTausFromTruthParticles()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ endInputFile()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ examineTruthTau()

◆ examineTruthTauDecay()

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getProperty()

◆ handle()

◆ initialize()

◆ inputHandles()

◆ inputMetaStore()

◆ metaDataStop()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ outputMetaStore()

◆ print() [1/2]

◆ print() [2/2]

◆ printDecay()

◆ renounce()

◆ renounceArray()

◆ retrieveTruthTaus() [1/3]

◆ retrieveTruthTaus() [2/3]

◆ retrieveTruthTaus() [3/3]

◆ setTruthMatchingMode()

◆ setUseIncidents()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_beginInputFileCalled

◆ m_bTruthTauAvailable

◆ m_bWriteDecayModeVector

◆ m_bWriteInvisibleFourMomentum

◆ m_bWriteVertices

◆ m_bWriteVisibleChargedFourMomentum

◆ m_bWriteVisibleNeutralFourMomentum

◆ m_classificationDecoratorKey

◆ m_classificationReadDecorKey

◆ m_detStore

◆ m_evtStore

◆ m_inputMetaStore

◆ m_linkDecoratorKey

◆ m_originDecoratorKey

◆ m_originReadDecorKey

◆ m_outcomeDecoratorKey