TauAODRunnerAlg Class Reference

The implementation of the TauAODRunnerAlg, which is meant to run at AOD level. More...

#include <TauAODRunnerAlg.h>

Inheritance diagram for TauAODRunnerAlg:

Collaboration diagram for TauAODRunnerAlg:

Public Member Functions
	TauAODRunnerAlg (const std::string &name, ISvcLocator *)
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &ctx) const override
virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...
virtual bool	isClonable () const override
	Specify if the algorithm is clonable. More...
virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm. More...
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...
virtual bool	filterPassed (const EventContext &ctx) const
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
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
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...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> 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...

Static Private Member Functions
static bool	isTauModified (const xAOD::TauJet *newtau)

Private Attributes
ToolHandleArray< ITauToolBase >	m_modificationTools {this, "modificationTools", {}, "Tools for modifying the taus"}
ToolHandleArray< ITauToolBase >	m_officialTools {this, "officialTools", {}, "Official Reconstruction tools for taus after the modifications"}
SG::ReadHandleKey< xAOD::TauJetContainer >	m_tauContainer {this, "Key_tauContainer", "TauJets", "input tau key"}
SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_pi0ClusterInputContainer {this, "Key_pi0ClusterInputContainer", "TauPi0Clusters", "input pi0 cluster"}
SG::WriteHandleKey< xAOD::TauJetContainer >	m_tauOutContainer {this, "Key_tauOutputContainer", "TauJets_AODReco", "output tau key"}
SG::WriteHandleKey< xAOD::ParticleContainer >	m_pi0Container {this, "Key_pi0OutputContainer", "TauFinalPi0s_AODReco", "output tau final pi0 key"}
SG::WriteHandleKey< xAOD::PFOContainer >	m_neutralPFOOutputContainer {this, "Key_neutralPFOOutputContainer", "TauNeutralPFOs_AODReco", "output tau neutral pfo key"}
SG::WriteHandleKey< xAOD::PFOContainer >	m_chargedPFOOutputContainer {this, "Key_chargedPFOOutputContainer", "TauChargedPFOs_AODReco", "output tau charged pfo key"}
SG::WriteHandleKey< xAOD::PFOContainer >	m_hadronicPFOOutputContainer {this, "Key_hadronicPFOOutputContainer", "TauHadronicPFOs_AODReco", "output tau hadronic pfo key"}
SG::WriteHandleKey< xAOD::TauTrackContainer >	m_tauTrackOutputContainer {this, "Key_tauTrackOutputContainer", "TauTracks_AODReco", "output tau track key"}
SG::WriteHandleKey< xAOD::VertexContainer >	m_vertexOutputContainer {this, "Key_vertexOutputContainer", "TauSecondaryVertices_AODReco", "output vertex container key"}
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks. More...
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

Detailed Description

The implementation of the TauAODRunnerAlg, which is meant to run at AOD level.

This algorithm reads in the AOD TauJets and TauTracks containers, as well as other tau related containers, and make deep copies. The tools scheduled for this algorithm were divided into two categories, modification tools and standard tools after the modification. The algorithm does not proceed to the standard tools if the tau object was not modified by the modification tools, unless no modification tool has been provided. The example python scheduling scripts can be found in the DerivationFramework package.

Caution! The tool can be configured to only deep-copy the TauJet container (by setting the other input/output keys to "", but this will restrict the tools you can run, to only those that decorate/modify the TauJets, and none of the linked objects (e.g. vertices, tracks, PFOs, etc). Otherwise, errors and/or crashes will happen.

Definition at line 44 of file TauAODRunnerAlg.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

TauAODRunnerAlg()

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

Definition at line 7 of file TauAODRunnerAlg.cxx.

                                                                                : 
  AthReentrantAlgorithm(name, pSvcLocator) {}

Member Function Documentation

cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

{
  return 0;
}

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::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());
 
  }

declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::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< Gaudi::Algorithm > >::detStore ( ) const

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( )

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode TauAODRunnerAlg::execute ( const EventContext &  ctx ) const

overridevirtual

Definition at line 67 of file TauAODRunnerAlg.cxx.

                                                                  {
  // Input TauJets
  SG::ReadHandle<xAOD::TauJetContainer> tauInputHandle(m_tauContainer, ctx);
  if (!tauInputHandle.isValid()) {
    ATH_MSG_ERROR("Could not retrieve TauJetContainer with key " << tauInputHandle.key());
    return StatusCode::FAILURE;
  }
  const xAOD::TauJetContainer *pTauContainer = tauInputHandle.cptr();
  
 
  // Output TauTracks
  xAOD::TauTrackContainer* newTauTrkCon = nullptr;
  SG::WriteHandle<xAOD::TauTrackContainer> outputTauTrackHandle;
  if(!m_tauTrackOutputContainer.empty()) {
    outputTauTrackHandle = SG::makeHandle(m_tauTrackOutputContainer, ctx);
    ATH_CHECK(outputTauTrackHandle.record(std::make_unique<xAOD::TauTrackContainer>(), std::make_unique<xAOD::TauTrackAuxContainer>()));
    newTauTrkCon = outputTauTrackHandle.ptr();
  }
 
  // Output TauJets
  SG::WriteHandle<xAOD::TauJetContainer> outputTauHandle(m_tauOutContainer, ctx);
  ATH_CHECK(outputTauHandle.record(std::make_unique<xAOD::TauJetContainer>(), std::make_unique<xAOD::TauJetAuxContainer>()));
  xAOD::TauJetContainer *newTauCon = outputTauHandle.ptr();
 
  static const SG::Accessor<ElementLink<xAOD::TauJetContainer>> acc_ori_tau_link("originalTauJet");
  static const SG::Accessor<char> acc_modified("ModifiedInAOD");
 
  for (const xAOD::TauJet *tau : *pTauContainer) {
    // Deep copy the tau container
    xAOD::TauJet* newTau = newTauCon->push_back(std::make_unique<xAOD::TauJet>());
    *newTau = *tau;
 
    // Link the original tau to the deepcopy
    ElementLink<xAOD::TauJetContainer> link_to_ori_tau;
    link_to_ori_tau.toContainedElement(*pTauContainer, tau);
    acc_ori_tau_link(*newTau) = link_to_ori_tau;
 
    // If the output TauTrackContainer is declared, create a new copy of all existing TauTracks
    // otherwise, reuse the same TauTracks (e.g. if only new TauID is being ran on a deep copy 
    // of the input TauJet container).
    if(newTauTrkCon) {
      // Clear the tautrack links to allow relinking.
      newTau->clearTauTrackLinks();
      for(const xAOD::TauTrack *tauTrk : tau->allTracks()) {
        // Deep copy the tau track
        xAOD::TauTrack* newTauTrk = newTauTrkCon->push_back(std::make_unique<xAOD::TauTrack>());
        *newTauTrk = *tauTrk;
 
        // Relink the tautrack
        ElementLink<xAOD::TauTrackContainer> linkToTauTrack;
        linkToTauTrack.toContainedElement(*newTauTrkCon, newTauTrk);
        newTau->addTauTrackLink(linkToTauTrack);
      }
    }
 
    // 'ModifiedInAOD' will be overriden by modification tools for relevant candidates
    acc_modified(*newTau) = static_cast<char>(false);
 
    // Execute all the modification tools (if provided)
    for(const ToolHandle<ITauToolBase> &tool : m_modificationTools) {
      ATH_MSG_DEBUG("RunnerAlg Invoking tool " << tool->name());
      if(tool->execute(*newTau).isFailure()) break;
    }
 
    // If tau candidate was not modified and we ran modification tools, remove it from container
    // The track cleanup is performed by the thinning algorithm downstream
    if(!m_modificationTools.empty() && !acc_modified(*newTau)) {
      newTauCon->pop_back();
    }
  }
 
 
  // Read the CaloClusterContainer
  const xAOD::CaloClusterContainer* pi0ClusterContainer = nullptr;
  SG::ReadHandle<xAOD::CaloClusterContainer> pi0ClusterInHandle;
  if(!m_pi0ClusterInputContainer.empty()) {
    pi0ClusterInHandle = SG::makeHandle(m_pi0ClusterInputContainer, ctx);
    if(!pi0ClusterInHandle.isValid()) {
      ATH_MSG_ERROR ("Could not retrieve HiveDataObj with key " << pi0ClusterInHandle.key());
      return StatusCode::FAILURE;
    }
    pi0ClusterContainer = pi0ClusterInHandle.cptr();
  }
 
  // Write charged PFO container
  xAOD::PFOContainer* chargedPFOContainer = nullptr;
  SG::WriteHandle<xAOD::PFOContainer> chargedPFOHandle;
  if(!m_chargedPFOOutputContainer.empty()) {
    chargedPFOHandle = SG::makeHandle(m_chargedPFOOutputContainer, ctx);
    ATH_CHECK(chargedPFOHandle.record(std::make_unique<xAOD::PFOContainer>(), std::make_unique<xAOD::PFOAuxContainer>()));
    chargedPFOContainer = chargedPFOHandle.ptr();
  }
 
  // Write neutral PFO container
  xAOD::PFOContainer* neutralPFOContainer = nullptr;
  SG::WriteHandle<xAOD::PFOContainer> neutralPFOHandle;
  if(!m_neutralPFOOutputContainer.empty()) {
    neutralPFOHandle = SG::makeHandle(m_neutralPFOOutputContainer, ctx);
    ATH_CHECK(neutralPFOHandle.record(std::make_unique<xAOD::PFOContainer>(), std::make_unique<xAOD::PFOAuxContainer>()));
    neutralPFOContainer = neutralPFOHandle.ptr();
  }
 
  // Write pi0 container
  xAOD::ParticleContainer* pi0Container = nullptr;
  SG::WriteHandle<xAOD::ParticleContainer> pi0Handle;
  if(!m_pi0Container.empty()) {
    pi0Handle = SG::makeHandle(m_pi0Container, ctx);
    ATH_CHECK(pi0Handle.record(std::make_unique<xAOD::ParticleContainer>(), std::make_unique<xAOD::ParticleAuxContainer>()));
    pi0Container = pi0Handle.ptr();
  }
 
  // Write hadronic cluster PFO container
  xAOD::PFOContainer* hadronicClusterPFOContainer = nullptr;
  SG::WriteHandle<xAOD::PFOContainer> hadronicPFOHandle;
  if(!m_hadronicPFOOutputContainer.empty()) {
    hadronicPFOHandle = SG::makeHandle(m_hadronicPFOOutputContainer, ctx);
    ATH_CHECK(hadronicPFOHandle.record(std::make_unique<xAOD::PFOContainer>(), std::make_unique<xAOD::PFOAuxContainer>()));
    hadronicClusterPFOContainer = hadronicPFOHandle.ptr();
  }
 
  // Write secondary vertices
  xAOD::VertexContainer* pSecVtxContainer = nullptr;
  SG::WriteHandle<xAOD::VertexContainer> vertOutHandle;
  if(!m_vertexOutputContainer.empty()) {
    vertOutHandle = SG::makeHandle(m_vertexOutputContainer, ctx);
    ATH_CHECK(vertOutHandle.record(std::make_unique<xAOD::VertexContainer>(), std::make_unique<xAOD::VertexAuxContainer>()));
    pSecVtxContainer = vertOutHandle.ptr();
  }
 
  
  // Execute all post-modification (_official_) tools
  for (xAOD::TauJet *pTau : *newTauCon) {
    StatusCode sc = StatusCode::SUCCESS;
    for (const ToolHandle<ITauToolBase> &tool : m_officialTools) {
      ATH_MSG_DEBUG("RunnerAlg Invoking tool " << tool->name());
      if (tool->type() == "TauPi0ClusterCreator")
        sc = tool->executePi0ClusterCreator(*pTau, *neutralPFOContainer, *hadronicClusterPFOContainer, *pi0ClusterContainer);
      else if (tool->type() == "TauVertexVariables")
        sc = tool->executeVertexVariables(*pTau, *pSecVtxContainer);
      else if (tool->type() == "TauPi0ClusterScaler")
        sc = tool->executePi0ClusterScaler(*pTau, *neutralPFOContainer, *chargedPFOContainer);
      else if (tool->type() == "TauPi0ScoreCalculator")
        sc = tool->executePi0nPFO(*pTau, *neutralPFOContainer);
      else if (tool->type() == "TauPi0Selector")
        sc = tool->executePi0nPFO(*pTau, *neutralPFOContainer);
      else if (tool->type() == "PanTau::PanTauProcessor")
        sc = tool->executePanTau(*pTau, *pi0Container, *neutralPFOContainer);
      else if (tool->type() == "tauRecTools::TauTrackRNNClassifier")
        sc = tool->executeTrackClassifier(*pTau, *newTauTrkCon);
      else
        sc = tool->execute(*pTau);
 
      if (sc.isFailure()) break;
    }
    if (sc.isSuccess()) ATH_MSG_VERBOSE("The tau candidate has been modified successfully by the invoked official tools.");
  }
 
  ATH_MSG_VERBOSE("The tau candidate container has been modified by the rest of the tools");
  ATH_MSG_DEBUG(newTauCon->size() << " / " << pTauContainer->size() <<" taus were modified");
 
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::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 & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 94 of file AthCommonReentrantAlgorithm.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 BaseAlg::extraOutputDeps();
}

filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext &  ctx ) const

inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

initialize()

StatusCode TauAODRunnerAlg::initialize ( )

overridevirtual

Definition at line 11 of file TauAODRunnerAlg.cxx.

                                       {
  ATH_CHECK(m_tauContainer.initialize());
  ATH_CHECK(m_pi0ClusterInputContainer.initialize(SG::AllowEmpty));
  ATH_CHECK(m_tauOutContainer.initialize());
  ATH_CHECK(m_pi0Container.initialize(SG::AllowEmpty));
  ATH_CHECK(m_neutralPFOOutputContainer.initialize(SG::AllowEmpty));
  ATH_CHECK(m_chargedPFOOutputContainer.initialize(SG::AllowEmpty));
  ATH_CHECK(m_hadronicPFOOutputContainer.initialize(SG::AllowEmpty));
  ATH_CHECK(m_tauTrackOutputContainer.initialize(SG::AllowEmpty));
  ATH_CHECK(m_vertexOutputContainer.initialize(SG::AllowEmpty));
 
  ATH_CHECK(m_modificationTools.retrieve());
  ATH_CHECK(m_officialTools.retrieve());
 
  if(!m_modificationTools.empty()) {
    ATH_MSG_INFO("List of modification tools in execution sequence:");
    ATH_MSG_INFO("------------------------------------");
    for (const auto &tool : m_modificationTools) {
      ATH_MSG_INFO(tool->type() << " - " << tool->name());
    }
    ATH_MSG_INFO("------------------------------------");
  } else {
    ATH_MSG_INFO("Running without modification tools");
  }
 
  if(!m_officialTools.empty()) {
    ATH_MSG_INFO("List of official tools in execution sequence:");
    ATH_MSG_INFO("------------------------------------");
    for (const auto &tool : m_officialTools) {
      ATH_MSG_INFO(tool->type() << " - " << tool->name());
 
      if((tool->type() == "TauPi0ClusterCreator" && (m_neutralPFOOutputContainer.empty() || m_hadronicPFOOutputContainer.empty() || m_pi0ClusterInputContainer.empty()))
         || (tool->type() == "TauVertexVariables" && m_vertexOutputContainer.empty())
         || (tool->type() == "TauPi0ClusterScaler" && (m_neutralPFOOutputContainer.empty() || m_chargedPFOOutputContainer.empty()))
         || (tool->type() == "TauPi0ScoreCalculator" && m_neutralPFOOutputContainer.empty())
         || (tool->type() == "TauPi0Selector" && m_neutralPFOOutputContainer.empty())
         || (tool->type() == "PanTau::PanTauProcessor" && (m_neutralPFOOutputContainer.empty() || m_pi0Container.empty()))
         || (tool->type() == "tauRecTools::TauTrackRNNClassifier" && m_tauTrackOutputContainer.empty())) {
        ATH_MSG_ERROR("Missing input/output containers required for tool " << tool->name() << " (" << tool->type() << ")");
        return StatusCode::FAILURE;
      } 
    }
    ATH_MSG_INFO("------------------------------------");
  } else {
    ATH_MSG_INFO("Running without official tools");
  }
 
  if(m_modificationTools.empty() && m_officialTools.empty()) {
    ATH_MSG_ERROR("Could not allocate any tool!");
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::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.

isClonable()

bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

{
  // Reentrant algorithms are clonable.
  return true;
}

isTauModified()

bool TauAODRunnerAlg::isTauModified ( const xAOD::TauJet *  newtau )

staticprivate

Definition at line 232 of file TauAODRunnerAlg.cxx.

                                                            {
  static const SG::ConstAccessor<char> acc_modified("ModifiedInAOD");
  return acc_modified(*newtau);
}

msg() [1/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

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

overridevirtualinherited

Return this algorithm's output handles.

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

renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounce ( T &  h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray &  handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setFilterPassed()

virtual void AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool  state, const EventContext &  ctx  ) const

inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext &  ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::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< Gaudi::Algorithm > >.

Reimplemented in InputMakerBase, and HypoBase.

Definition at line 61 of file AthCommonReentrantAlgorithm.cxx.

                                                               {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::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< Gaudi::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< Gaudi::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_chargedPFOOutputContainer

SG::WriteHandleKey<xAOD::PFOContainer> TauAODRunnerAlg::m_chargedPFOOutputContainer {this, "Key_chargedPFOOutputContainer", "TauChargedPFOs_AODReco", "output tau charged pfo key"}

private

Definition at line 61 of file TauAODRunnerAlg.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::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< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

m_hadronicPFOOutputContainer

SG::WriteHandleKey<xAOD::PFOContainer> TauAODRunnerAlg::m_hadronicPFOOutputContainer {this, "Key_hadronicPFOOutputContainer", "TauHadronicPFOs_AODReco", "output tau hadronic pfo key"}

private

Definition at line 62 of file TauAODRunnerAlg.h.

m_modificationTools

ToolHandleArray<ITauToolBase> TauAODRunnerAlg::m_modificationTools {this, "modificationTools", {}, "Tools for modifying the taus"}

private

Definition at line 52 of file TauAODRunnerAlg.h.

m_neutralPFOOutputContainer

SG::WriteHandleKey<xAOD::PFOContainer> TauAODRunnerAlg::m_neutralPFOOutputContainer {this, "Key_neutralPFOOutputContainer", "TauNeutralPFOs_AODReco", "output tau neutral pfo key"}

private

Definition at line 60 of file TauAODRunnerAlg.h.

m_officialTools

ToolHandleArray<ITauToolBase> TauAODRunnerAlg::m_officialTools {this, "officialTools", {}, "Official Reconstruction tools for taus after the modifications"}

private

Definition at line 53 of file TauAODRunnerAlg.h.

m_pi0ClusterInputContainer

SG::ReadHandleKey<xAOD::CaloClusterContainer> TauAODRunnerAlg::m_pi0ClusterInputContainer {this, "Key_pi0ClusterInputContainer", "TauPi0Clusters", "input pi0 cluster"}

private

Definition at line 57 of file TauAODRunnerAlg.h.

m_pi0Container

SG::WriteHandleKey<xAOD::ParticleContainer> TauAODRunnerAlg::m_pi0Container {this, "Key_pi0OutputContainer", "TauFinalPi0s_AODReco", "output tau final pi0 key"}

private

Definition at line 59 of file TauAODRunnerAlg.h.

m_tauContainer

SG::ReadHandleKey<xAOD::TauJetContainer> TauAODRunnerAlg::m_tauContainer {this, "Key_tauContainer", "TauJets", "input tau key"}

private

Definition at line 56 of file TauAODRunnerAlg.h.

m_tauOutContainer

SG::WriteHandleKey<xAOD::TauJetContainer> TauAODRunnerAlg::m_tauOutContainer {this, "Key_tauOutputContainer", "TauJets_AODReco", "output tau key"}

private

Definition at line 58 of file TauAODRunnerAlg.h.

m_tauTrackOutputContainer

SG::WriteHandleKey<xAOD::TauTrackContainer> TauAODRunnerAlg::m_tauTrackOutputContainer {this, "Key_tauTrackOutputContainer", "TauTracks_AODReco", "output tau track key"}

private

Definition at line 63 of file TauAODRunnerAlg.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vertexOutputContainer

SG::WriteHandleKey<xAOD::VertexContainer> TauAODRunnerAlg::m_vertexOutputContainer {this, "Key_vertexOutputContainer", "TauSecondaryVertices_AODReco", "output vertex container key"}

private

Definition at line 64 of file TauAODRunnerAlg.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• TauAODRunnerAlg.h
• TauAODRunnerAlg.cxx