TauPi0ClusterCreator Class Reference

Creates Pi0 clusters (Pi0 Finder). More...

#include <TauPi0ClusterCreator.h>

Inheritance diagram for TauPi0ClusterCreator:

Collaboration diagram for TauPi0ClusterCreator:

Public Member Functions
	TauPi0ClusterCreator (const std::string &name)
virtual	~TauPi0ClusterCreator ()=default
virtual StatusCode	executeTool (xAOD::TauJet &pTau, const EventContext &ctx, xAOD::PFOContainer &neutralPFOContainer, xAOD::PFOContainer &hadronicClusterPFOContainer, const xAOD::CaloClusterContainer &pi0CaloClusContainer) const override
virtual StatusCode	executeTool (xAOD::TauJet &, const EventContext &) const override
	Execute - called for each tau candidate.
virtual StatusCode	executeTool (xAOD::TauJet &, const EventContext &, CaloConstCellContainer &, boost::dynamic_bitset<> &) const override
virtual StatusCode	executeTool (xAOD::TauJet &, const EventContext &, const xAOD::VertexContainer *) const override
virtual StatusCode	executeTool (xAOD::TauJet &, const EventContext &, xAOD::VertexContainer &) const override
virtual StatusCode	executeTool (xAOD::TauJet &, const EventContext &, xAOD::TauTrackContainer &) const override
virtual StatusCode	executeTool (xAOD::TauJet &, const EventContext &, xAOD::CaloClusterContainer &, xAOD::PFOContainer &) const override
virtual StatusCode	executeTool (xAOD::TauJet &, const EventContext &, xAOD::PFOContainer &, xAOD::PFOContainer &) const override
virtual StatusCode	executeTool (xAOD::TauJet &, const EventContext &, xAOD::PFOContainer &) const override
virtual StatusCode	executeTool (xAOD::TauJet &, const EventContext &, xAOD::ParticleContainer &, xAOD::PFOContainer &) const override
virtual StatusCode	initialize () override
	Tool initializer.
virtual StatusCode	eventInitialize () override
	Event initializer - called at the beginning of each event.
virtual StatusCode	eventFinalize () override
	Event finalizer - called at the end of each event.
virtual StatusCode	finalize () override
	Finalizer.
std::string	find_file (const std::string &fname) const
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
bool	inTrigger () const
bool	inAOD () const
bool	inEleRM () const
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Protected Attributes
Gaudi::Property< bool >	m_in_trigger {this, "inTrigger", false, "Indicate if the tool is running on trigger"}
Gaudi::Property< bool >	m_in_AOD {this, "inAOD", false, "Indicate if the tool is running on AOD"}
Gaudi::Property< bool >	m_in_EleRM {this, "inEleRM", false, "Indicate if the tool is running on EleRM routine"}
Gaudi::Property< std::string >	m_tauRecToolsTag {this, "calibFolder", "tauRecTools/R22_preprod", "CVMFS path to the tau calibration folder"}

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	configureNeutralPFO (const xAOD::CaloCluster &cluster, const xAOD::CaloClusterContainer &pi0ClusterContainer, const xAOD::TauJet &tau, const std::vector< const xAOD::PFO * > &shotPFOs, const std::map< unsigned, const xAOD::CaloCluster * > &shotsInCluster, xAOD::PFO &neutralPFO) const
	Configure the neutral PFO.
StatusCode	configureHadronicPFO (const xAOD::CaloVertexedTopoCluster &cluster, double clusterEnergyHad, xAOD::PFO &hadronicPFO) const
	Configure the haronic PFO.
std::map< unsigned, const xAOD::CaloCluster * >	getShotToClusterMap (const std::vector< const xAOD::PFO * > &shotVector, std::vector< const xAOD::CaloCluster * > &goodpi0Vecor) const
std::vector< unsigned >	getShotsMatchedToCluster (const std::vector< const xAOD::PFO * > &shotVector, const std::map< unsigned, const xAOD::CaloCluster * > &clusterToShotMap, const xAOD::CaloCluster &pi0Cluster) const
int	getNPhotons (const std::vector< const xAOD::PFO * > &shotVector, const std::vector< unsigned > &shotsInCluster) const
void	getClusterVariables (const xAOD::CaloCluster &cluster, std::vector< int > &nPosECells, float &coreEnergyEM1, std::vector< float > &deltaEtaFirstMom, std::vector< float > &secondEtaWRTClusterPositionInLayer) const
	eta moment in PS, EM1 and EM2 w.r.t cluster eta
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< double >	m_clusterEtCut {this, "ClusterEtCut", 0.5 * Gaudi::Units::GeV, "Et threshould for pi0 candidate clusters"}
Gaudi::Property< double >	m_maxDeltaRNeutral {this, "MaxDeltaRNeutral", 0.2, "max DeltaR for pi0-tau association"}
Gaudi::Property< double >	m_maxDeltaRJetClust {this, "MaxDeltaRJetClust", 0.4, "max DeltaR for vertexed cluster-tau association"}
Gaudi::Property< double >	m_recoFromAOD {this, "RecoFromAOD", false, "Flag if the reconstruction is happening at AOD-level"}
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Creates Pi0 clusters (Pi0 Finder).

Author

Will Davey will..nosp@m.dave.nosp@m.y@cer.nosp@m.n.ch

Benedict Winter bened.nosp@m.ict..nosp@m.tobia.nosp@m.s.wi.nosp@m.nter@.nosp@m.cern.nosp@m..ch

Stephanie Yuen steph.nosp@m.anie.nosp@m..yuen.nosp@m.@cer.nosp@m.n.ch

Definition at line 28 of file TauPi0ClusterCreator.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 376 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

TauPi0ClusterCreator()

TauPi0ClusterCreator::TauPi0ClusterCreator

(

const std::string &

name

)

Definition at line 15 of file TauPi0ClusterCreator.cxx.

                                                                :
    TauRecToolBase(name) {
}

~TauPi0ClusterCreator()

virtual TauPi0ClusterCreator::~TauPi0ClusterCreator ( )

virtualdefault

Member Function Documentation

configureHadronicPFO()

StatusCode TauPi0ClusterCreator::configureHadronicPFO ( const xAOD::CaloVertexedTopoCluster & cluster, double clusterEnergyHad, xAOD::PFO & hadronicPFO ) const

private

Configure the haronic PFO.

Definition at line 404 of file TauPi0ClusterCreator.cxx.

                                                                                  {
  double clusterPtHad = clusterEnergyHad/std::cosh(cluster.eta());
  hadronicPFO.setP4(clusterPtHad, cluster.eta(), cluster.phi(), 0.);
 
  return StatusCode::SUCCESS;
}

configureNeutralPFO()

StatusCode TauPi0ClusterCreator::configureNeutralPFO ( const xAOD::CaloCluster & cluster, const xAOD::CaloClusterContainer & pi0ClusterContainer, const xAOD::TauJet & tau, const std::vector< const xAOD::PFO * > & shotPFOs, const std::map< unsigned, const xAOD::CaloCluster * > & shotsInCluster, xAOD::PFO & neutralPFO ) const

private

Configure the neutral PFO.

Definition at line 299 of file TauPi0ClusterCreator.cxx.

                                                                                {
  // Set the properties of the PFO
  // -- Default value
  neutralPFO.setBDTPi0Score(-9999.);
  neutralPFO.setCharge(0);
  neutralPFO.setAttribute<int>(xAOD::PFODetails::PFOAttributes::nPi0Proto, -1);
 
  // -- CENTER_MAG
  double CENTER_MAG = 0.0;
  if (!cluster.retrieveMoment(xAOD::CaloCluster::MomentType::CENTER_MAG, CENTER_MAG)) {
    ATH_MSG_WARNING("Couldn't retrieve CENTER_MAG moment. Set it to 0.");
  }
  neutralPFO.setCenterMag( static_cast<float>(CENTER_MAG));
  
  // -- Number of photons 
  std::vector<unsigned> shotsInCluster = getShotsMatchedToCluster(shotPFOs, shotToClusterMap, cluster);
  int NHitsInEM1 = getNPhotons(shotPFOs, shotsInCluster);
  neutralPFO.setAttribute<int>(xAOD::PFODetails::PFOAttributes::cellBased_NHitsInEM1, NHitsInEM1);
  
  // -- Energy at each layer
  float eEM1 = cluster.eSample(CaloSampling::EMB1) + cluster.eSample(CaloSampling::EME1);
  neutralPFO.setAttribute<float>(xAOD::PFODetails::PFOAttributes::cellBased_energy_EM1, eEM1);
  
  float eEM2 = cluster.eSample(CaloSampling::EMB2) + cluster.eSample(CaloSampling::EME2);
  neutralPFO.setAttribute<float>(xAOD::PFODetails::PFOAttributes::cellBased_energy_EM2, eEM2);
 
  //-- Get variables
  std::vector<float> deltaEtaFirstMom (3, 0.);
  std::vector<float> deltaEtaSecondMom (3, 0.);
  std::vector<int>   nPosECells(3, 0);
  float EM1CoreFrac = 0.;
 
  getClusterVariables(cluster, nPosECells, EM1CoreFrac, deltaEtaFirstMom, deltaEtaSecondMom);
   
  // -- Number of positive cells in each layer
  neutralPFO.setAttribute<int>(xAOD::PFODetails::PFOAttributes::cellBased_NPosECells_PS,  nPosECells.at(0));
  neutralPFO.setAttribute<int>(xAOD::PFODetails::PFOAttributes::cellBased_NPosECells_EM1, nPosECells.at(1));
  neutralPFO.setAttribute<int>(xAOD::PFODetails::PFOAttributes::cellBased_NPosECells_EM2, nPosECells.at(2));
 
  // -- Core Fraction of the energy in EM1 
  neutralPFO.setAttribute<float>(xAOD::PFODetails::PFOAttributes::cellBased_EM1CoreFrac, EM1CoreFrac);
 
  // -- First moment of deltaEta(cluster, cell) in EM1 and EM2 
  neutralPFO.setAttribute<float>(xAOD::PFODetails::PFOAttributes::cellBased_firstEtaWRTClusterPosition_EM1, deltaEtaFirstMom.at(1));
  neutralPFO.setAttribute<float>(xAOD::PFODetails::PFOAttributes::cellBased_firstEtaWRTClusterPosition_EM2, deltaEtaFirstMom.at(2));
  
  // -- Second moment of deltaEta(cluster, cell) in EM1 and EM2
  neutralPFO.setAttribute<float>(xAOD::PFODetails::PFOAttributes::cellBased_secondEtaWRTClusterPosition_EM1, deltaEtaSecondMom.at(1));
  neutralPFO.setAttribute<float>(xAOD::PFODetails::PFOAttributes::cellBased_secondEtaWRTClusterPosition_EM2, deltaEtaSecondMom.at(2));
 
  // -- Retrieve cluster moments
  using Moment = xAOD::CaloCluster::MomentType;
  using Attribute = xAOD::PFODetails::PFOAttributes; 
  const std::array< std::pair<Moment, Attribute>, 12> momentAttributePairs {{
      {Moment::FIRST_ETA, Attribute::cellBased_FIRST_ETA},
      {Moment::SECOND_R, Attribute::cellBased_SECOND_R}, 
      {Moment::SECOND_LAMBDA, Attribute::cellBased_SECOND_LAMBDA},
      {Moment::DELTA_PHI, Attribute::cellBased_DELTA_PHI},
      {Moment::DELTA_THETA, Attribute::cellBased_DELTA_THETA},
      {Moment::CENTER_LAMBDA, Attribute::cellBased_CENTER_LAMBDA},
      {Moment::LATERAL, Attribute::cellBased_LATERAL},
      {Moment::LONGITUDINAL, Attribute::cellBased_LONGITUDINAL},
      {Moment::ENG_FRAC_EM, Attribute::cellBased_ENG_FRAC_EM},
      {Moment::ENG_FRAC_MAX, Attribute::cellBased_ENG_FRAC_MAX},
      {Moment::ENG_FRAC_CORE, Attribute::cellBased_ENG_FRAC_CORE},
      {Moment::SECOND_ENG_DENS, Attribute::cellBased_SECOND_ENG_DENS}
  }};
  
  for (const auto& [moment, attribute] : momentAttributePairs) {
    double value = 0.0;
    if (! cluster.retrieveMoment(moment, value)) {
      ATH_MSG_WARNING("Cound not retrieve " << moment);
    }
    neutralPFO.setAttribute(attribute, static_cast<float>(value));
  }
 
  // -- Element link to the cluster 
  ElementLink<xAOD::CaloClusterContainer> clusElementLink;
  clusElementLink.toContainedElement(pi0ClusterContainer, &cluster);
  neutralPFO.setClusterLink( clusElementLink );
 
  // -- Element link to the shots
  std::vector<ElementLink<xAOD::IParticleContainer>> shotlinks;
  for (unsigned index = 0; index < shotsInCluster.size(); ++index) {
    auto& shotPFOElementLink = tau.shotPFOLinks().at(shotsInCluster.at(index));
    ElementLink<xAOD::IParticleContainer> shotElementLink( shotPFOElementLink.dataID(), shotPFOElementLink.index() );
    if (!shotElementLink.isValid()) {
      ATH_MSG_WARNING("Created an invalid element link to xAOD::PFO");
    }
    shotlinks.push_back(shotElementLink);
  }
  if(!neutralPFO.setAssociatedParticleLinks( xAOD::PFODetails::TauShot,shotlinks)) { 
    ATH_MSG_WARNING("Couldn't add shot links to neutral PFO!");
  }
 
  return StatusCode::SUCCESS;
}

declareGaudiProperty()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

declareProperty()

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

detStore()

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

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

eventFinalize()

StatusCode TauRecToolBase::eventFinalize ( )

overridevirtualinherited

Event finalizer - called at the end of each event.

Implements ITauToolBase.

Definition at line 123 of file TauRecToolBase.cxx.

                                         {
  return StatusCode::SUCCESS;
}

eventInitialize()

StatusCode TauRecToolBase::eventInitialize ( )

overridevirtualinherited

Event initializer - called at the beginning of each event.

Implements ITauToolBase.

Definition at line 36 of file TauRecToolBase.cxx.

                                          {
  return StatusCode::SUCCESS;
}

evtStore()

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

executeTool() [1/10]

StatusCode TauRecToolBase::executeTool ( xAOD::TauJet & , const EventContext &  ) const

overridevirtual

Execute - called for each tau candidate.

Reimplemented from TauRecToolBase.

Definition at line 43 of file TauRecToolBase.cxx.

                                                  {
  ATH_MSG_ERROR("function not implemented");
  return StatusCode::FAILURE;
}

executeTool() [2/10]

StatusCode TauRecToolBase::executeTool ( xAOD::TauJet & , const EventContext & , CaloConstCellContainer & , boost::dynamic_bitset<> &  ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 49 of file TauRecToolBase.cxx.

                                                      {
  ATH_MSG_ERROR("function not implemented");
  return StatusCode::FAILURE;
}

executeTool() [3/10]

StatusCode TauRecToolBase::executeTool ( xAOD::TauJet & , const EventContext & , const xAOD::VertexContainer *  ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 54 of file TauRecToolBase.cxx.

                                                         {
  ATH_MSG_ERROR("function not implemented");
  return StatusCode::FAILURE;
}

executeTool() [4/10]

StatusCode TauRecToolBase::executeTool ( xAOD::TauJet & , const EventContext & , xAOD::CaloClusterContainer & , xAOD::PFOContainer &  ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 66 of file TauRecToolBase.cxx.

                                                 {
  ATH_MSG_ERROR("function not implemented");
  return StatusCode::FAILURE;
}

executeTool() [5/10]

StatusCode TauRecToolBase::executeTool ( xAOD::TauJet & , const EventContext & , xAOD::ParticleContainer & , xAOD::PFOContainer &  ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 86 of file TauRecToolBase.cxx.

                                                 {
  ATH_MSG_ERROR("function not implemented");
  return StatusCode::FAILURE;
}

executeTool() [6/10]

StatusCode TauRecToolBase::executeTool ( xAOD::TauJet & , const EventContext & , xAOD::PFOContainer &  ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 82 of file TauRecToolBase.cxx.

                                                 {
  ATH_MSG_ERROR("function not implemented");
  return StatusCode::FAILURE;
}

executeTool() [7/10]

StatusCode TauRecToolBase::executeTool ( xAOD::TauJet & , const EventContext & , xAOD::PFOContainer & , xAOD::PFOContainer &  ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 77 of file TauRecToolBase.cxx.

                                                 {
  ATH_MSG_ERROR("function not implemented");
  return StatusCode::FAILURE;
} 

executeTool() [8/10]

StatusCode TauRecToolBase::executeTool ( xAOD::TauJet & , const EventContext & , xAOD::TauTrackContainer &  ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 62 of file TauRecToolBase.cxx.

                                                     {
  ATH_MSG_ERROR("function not implemented");
  return StatusCode::FAILURE;
}

executeTool() [9/10]

StatusCode TauRecToolBase::executeTool ( xAOD::TauJet & , const EventContext & , xAOD::VertexContainer &  ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 58 of file TauRecToolBase.cxx.

                                                                    {
  ATH_MSG_ERROR("function not implemented");
  return StatusCode::FAILURE;
}

executeTool() [10/10]

StatusCode TauPi0ClusterCreator::executeTool ( xAOD::TauJet & pTau, const EventContext & ctx, xAOD::PFOContainer & neutralPFOContainer, xAOD::PFOContainer & hadronicClusterPFOContainer, const xAOD::CaloClusterContainer & pi0CaloClusContainer ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 20 of file TauPi0ClusterCreator.cxx.

                                                                                    {
 
  // Any tau needs to have PFO vectors. Set empty vectors before nTrack cut
  std::vector<ElementLink<xAOD::PFOContainer>> empty;
  tau.setProtoNeutralPFOLinks(empty);
  tau.setHadronicPFOLinks(empty);
 
  // only need pi0s and shots for 0-5 prong taus 
  if (!tauRecTools::doPi0andShots(tau)) {
    return StatusCode::SUCCESS;
  }
 
  // Retrieve Ecal1 shots and match them to clusters
  std::vector<const xAOD::PFO*> shotPFOs;
  
  unsigned nShots = tau.nShotPFOs();
  for (unsigned index=0; index<nShots; ++index) {
    const xAOD::PFO* shotPFO = tau.shotPFO(index);
    shotPFOs.push_back(shotPFO);
  }
 
  // We will always perform the vertex correction
  const xAOD::Vertex* vertex = tau.vertex();
 
  // Tau custom PFO reconstruction is only used in offline reconstrution
  TLorentzVector tauAxis = tauRecTools::getTauAxis(tau);
 
  // Preselect the pi0s clusters
  std::vector<const xAOD::CaloCluster*> good_pi0s;
  for (TLorentzVector clusterP4;const xAOD::CaloCluster* cluster: pi0ClusterContainer){
    if (vertex) {
      xAOD::CaloVertexedTopoCluster vertexedCluster(*cluster, vertex->position());
      clusterP4 = vertexedCluster.p4();
    }
    else {
      clusterP4 = cluster->p4();
    }
    // Clusters must have enough energy, and within 0.4 cone of the tau candidate
    if ((clusterP4.Pt() < m_clusterEtCut) || (clusterP4.DeltaR(tauAxis) > m_maxDeltaRJetClust))   continue;       
 
    good_pi0s.push_back(cluster);
  } 
 
  // Map shot to the pi0 cluster 
  std::map<unsigned, const xAOD::CaloCluster*> shotToClusterMap = getShotToClusterMap(shotPFOs, good_pi0s);
 
  // Loop over preselected pi0 clusters, and create neutral PFOs
  for (TLorentzVector clusterP4;const xAOD::CaloCluster* cluster: good_pi0s){
    if (vertex) {
      xAOD::CaloVertexedTopoCluster vertexedCluster(*cluster, vertex->position());
      clusterP4 = vertexedCluster.p4();
    }
    else {
      clusterP4 = cluster->p4();
    }
 
    // Create the neutral PFOs
    xAOD::PFO* neutralPFO = new xAOD::PFO();
    neutralPFOContainer.push_back(neutralPFO);
 
    // -- Set the PFO four momentum corrected w.r.t. the tau vertex
    neutralPFO->setP4(clusterP4.Pt(), clusterP4.Eta(), clusterP4.Phi(), 0.);
    
    // Add the link to the tau candidate 
    ElementLink<xAOD::PFOContainer> PFOElementLink;
    PFOElementLink.toContainedElement(neutralPFOContainer, neutralPFO);
    tau.addProtoNeutralPFOLink(PFOElementLink);
 
    ATH_CHECK(configureNeutralPFO(*cluster, pi0ClusterContainer, tau, shotPFOs, shotToClusterMap, *neutralPFO));
  }
 
  // Loop over clusters from jet seed, and create hadronic PFOs
  std::vector<xAOD::CaloVertexedTopoCluster> vertexedClusterList = tau.vertexedClusters();
  for (const xAOD::CaloVertexedTopoCluster& vertexedCluster : vertexedClusterList){
    TLorentzVector clusterP4 = vertexedCluster.p4();
       
    // Clusters must have positive energy, and within 0.2 cone of the tau candidate 
    if((clusterP4.E()<=0.) || (clusterP4.DeltaR(tauAxis) > m_maxDeltaRNeutral) ) continue;
 
    double clusterEnergyHad = 0.;
    
    const xAOD::CaloCluster& cluster = vertexedCluster.clust();
    const CaloClusterCellLink* cellLinks = cluster.getCellLinks();
    if (!cellLinks) {
      if (!m_recoFromAOD)
          ATH_MSG_WARNING("The cell links of the tau cluster is unavailable.");
      else
          ATH_MSG_DEBUG("The cell links of the tau cluster is unavailable due to reconstruction from AOD");
 
      continue;
    }
    CaloClusterCellLink::const_iterator cellLink = cellLinks->begin();
    for (; cellLink != cellLinks->end(); ++cellLink) {
      const CaloCell* cell = static_cast<const CaloCell*>(*cellLink);
       
      int sampling = cell->caloDDE()->getSampling();
      if (sampling < 8) continue;
 
      // TODO: what is the weight for EMTopo
      double cellEnergy = cell->e() * cellLink.weight();
      clusterEnergyHad += cellEnergy;
    }
    
    // Energy in Had Calorimeter must be positive
    if(clusterEnergyHad <= 0.) continue;
  
    // Create the hadrnic PFO
    xAOD::PFO* hadronicPFO = new xAOD::PFO();
    hadronicPFOContainer.push_back(hadronicPFO);
    
    // Add element link from tau to hadronic PFO
    ElementLink<xAOD::PFOContainer> PFOElementLink;
    PFOElementLink.toContainedElement( hadronicPFOContainer, hadronicPFO );
    tau.addHadronicPFOLink( PFOElementLink );
    
    ATH_CHECK(configureHadronicPFO(vertexedCluster, clusterEnergyHad, *hadronicPFO));
  }
 
  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

finalize()

StatusCode TauRecToolBase::finalize ( )

overridevirtualinherited

Finalizer.

Implements ITauToolBase.

Reimplemented in PanTau::PanTauProcessor.

Definition at line 127 of file TauRecToolBase.cxx.

                                   {
  return StatusCode::SUCCESS;
}

find_file()

std::string TauRecToolBase::find_file ( const std::string & fname ) const

inherited

Definition at line 19 of file TauRecToolBase.cxx.

                                                                {
  std::string full_path;
  //offline calib files are in GroupData
  //online calib files are in release
  full_path = PathResolverFindCalibFile(m_tauRecToolsTag+"/"+fname);
  if(full_path.empty()) full_path = PathResolverFindCalibFile(fname);
  return full_path;
}

getClusterVariables()

void TauPi0ClusterCreator::getClusterVariables ( const xAOD::CaloCluster & cluster, std::vector< int > & nPosECells, float & coreEnergyEM1, std::vector< float > & deltaEtaFirstMom, std::vector< float > & secondEtaWRTClusterPositionInLayer ) const

private

eta moment in PS, EM1 and EM2 w.r.t cluster eta

Definition at line 242 of file TauPi0ClusterCreator.cxx.

                                                                                          {
 
  float totalEnergyEM1 = 0.;    
  std::vector<float> totalEnergy (3, 0.);
 
  const CaloClusterCellLink* cellLinks = cluster.getCellLinks();
  CaloClusterCellLink::const_iterator cellLink = cellLinks->begin();
  for (; cellLink != cellLinks->end(); ++cellLink) {
    const CaloCell* cell = static_cast<const CaloCell*>(*cellLink);
    
    // Only consider PS, EM1, and EM2
    int sampling = cell->caloDDE()->getSampling();
    int layer = sampling%4;
    if (layer >= 3) continue;
 
    // Only consider positive cells
    float cellEnergy_weighted = cell->e() * cellLink.weight();
    if (cellEnergy_weighted <= 0) continue;
 
    ++nPosECells[layer];
 
    float deltaEta = cell->eta() - cluster.eta(); 
 
    deltaEtaFirstMom[layer] += deltaEta * cellEnergy_weighted;
    deltaEtaSecondMom[layer] += deltaEta * deltaEta * cellEnergy_weighted;
    totalEnergy[layer] += cellEnergy_weighted;
 
    // calculate coreEnergyEM1
    if (sampling != 1 && sampling != 5) continue;
 
    totalEnergyEM1 += cellEnergy_weighted;
    float deltaPhi = P4Helpers::deltaPhi(cell->phi(), cluster.phi());
 
    // Core region: [0.05, 0.05/8]
    if(std::abs(deltaPhi) > 0.05 || std::abs(deltaEta) > 2 * 0.025/8.) continue;
    coreEnergyEM1 += cellEnergy_weighted;
  }
 
  for (int layer=0; layer < 3; ++layer) {
    if (totalEnergy[layer] != 0.) {
      deltaEtaFirstMom[layer]/=std::abs(totalEnergy[layer]);
      deltaEtaSecondMom[layer]/=std::abs(totalEnergy[layer]);
    }
    else {
      deltaEtaFirstMom[layer]=0.;
      deltaEtaSecondMom[layer]=0.;
    }
  }
 
  coreEnergyEM1 = (totalEnergyEM1 > 0.) ? coreEnergyEM1/totalEnergyEM1 : 0.;
 
}

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::Event 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::Event, 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::Event 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::Event, 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
   }

getNPhotons()

int TauPi0ClusterCreator::getNPhotons ( const std::vector< const xAOD::PFO * > & shotVector, const std::vector< unsigned > & shotsInCluster ) const

private

Definition at line 226 of file TauPi0ClusterCreator.cxx.

                                                                                       {
  int totalPhotons = 0;
  
  for (unsigned index = 0; index < shotsInCluster.size(); ++index) {
    int nPhotons = 0;
    const xAOD::PFO* shotPFO = shotPFOs.at(shotsInCluster.at(index));
    if (! shotPFO->attribute(xAOD::PFODetails::PFOAttributes::tauShots_nPhotons, nPhotons)) { 
      ATH_MSG_WARNING("Can't find NHitsInEM1. Set it to 0.");
    }
    totalPhotons += nPhotons;
  }
  
  return totalPhotons;
}

getProperty()

template<class T>

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

inherited

Get one of the tool's properties.

getShotsMatchedToCluster()

std::vector< unsigned > TauPi0ClusterCreator::getShotsMatchedToCluster ( const std::vector< const xAOD::PFO * > & shotVector, const std::map< unsigned, const xAOD::CaloCluster * > & clusterToShotMap, const xAOD::CaloCluster & pi0Cluster ) const

private

Definition at line 207 of file TauPi0ClusterCreator.cxx.

                                                                              {
  std::vector<unsigned> shotsMatchedToCluster;
  
  // Loop over the shots, and select those matched to the cluster
  for (unsigned index = 0; index < shotPFOs.size(); ++index) {
    auto iterator = shotToClusterMap.find(index);
    if (iterator == shotToClusterMap.end()) continue;
    if (iterator->second != &pi0Cluster) continue;
    
    shotsMatchedToCluster.push_back(index);
  }
  
  return shotsMatchedToCluster;
}

getShotToClusterMap()

std::map< unsigned, const xAOD::CaloCluster * > TauPi0ClusterCreator::getShotToClusterMap ( const std::vector< const xAOD::PFO * > & shotVector, std::vector< const xAOD::CaloCluster * > & goodpi0Vecor ) const

private

Definition at line 147 of file TauPi0ClusterCreator.cxx.

                                                                                                                                  {
  std::map<unsigned, const xAOD::CaloCluster*> shotToClusterMap;
  for (unsigned index = 0; index < shotPFOs.size(); ++index) {
    const xAOD::PFO* shotPFO = shotPFOs.at(index);
 
    int seedHashInt = -1;
    if (!shotPFO->attribute(xAOD::PFODetails::PFOAttributes::tauShots_seedHash, seedHashInt)) {
      ATH_MSG_WARNING("Couldn't find seed hash. Set it to -1, no cluster will be associated to shot.");
    }
    const IdentifierHash seedHash = static_cast<const IdentifierHash>(seedHashInt);
   
    float weightInCluster = -1.;
    float weightInPreviousCluster = -1;
    
    // Loop over custom pi0 clusters, and map shot to the cluster
    for (const xAOD::CaloCluster* cluster: goodPi0s){
 
      weightInCluster = -1.;        
 
      const CaloClusterCellLink* cellLinks = cluster->getCellLinks();
      CaloClusterCellLink::const_iterator cellLink = cellLinks->begin();
      for (; cellLink != cellLinks->end(); ++cellLink) {
        const CaloCell* cell = static_cast<const CaloCell*>(*cellLink);
        
        // Check if seed cell is in cluster.
        if (cell->caloDDE()->calo_hash() != seedHash) continue;
        
        weightInCluster = cellLink.weight();
        // found cell, no need to loop over other cells
        break;
      }
      
      if (weightInCluster < 0) continue;
        
      // Check if cell was already found in a previous cluster
      if (weightInPreviousCluster < 0) {
        // Cell not found in a previous cluster. 
        // Have to check whether cell is shared with other cluster
        shotToClusterMap[index] = cluster;
        weightInPreviousCluster = weightInCluster;
      }
      else {
        // Cell has been found in a previous cluster
        // assign shot to this cluster if it has larger weight for the cell
        // otherwise the shots keeps assigned to the previous cluster
        if (weightInCluster > weightInPreviousCluster) {
      shotToClusterMap[index] = cluster;
        }
    
        break;
      }
    }
  }
  
  return shotToClusterMap;
}

inAOD()

bool TauRecToolBase::inAOD ( ) const

inlineprotectedinherited

Definition at line 116 of file TauRecToolBase.h.

{ return m_in_AOD; }

inEleRM()

bool TauRecToolBase::inEleRM ( ) const

inlineprotectedinherited

Definition at line 117 of file TauRecToolBase.h.

{ return m_in_EleRM; }

initialize()

StatusCode TauRecToolBase::initialize ( void )

overridevirtualinherited

Tool initializer.

Reimplemented from asg::AsgTool.

Reimplemented in MvaTESEvaluator, MvaTESVariableDecorator, PanTau::PanTauProcessor, TauAODMuonRemovalTool, TauCalibrateLC, TauCombinedTES, TauDecayModeNNClassifier, TauElectronVetoVariables, TauEleOverlapChecker, TauGNNEvaluator, TauJetRNNEvaluator, TauPi0CreateROI, TauPi0ScoreCalculator, tauRecTools::TauTrackRNNClassifier, tauRecTools::TrackRNN, TauShotFinder, TausRUsEvaluator, TauTrackCaloExtrapolator, TauTrackFinder, TauVertexedClusterDecorator, TauVertexFinder, TauVertexVariables, and TauWPDecorator.

Definition at line 32 of file TauRecToolBase.cxx.

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

inTrigger()

bool TauRecToolBase::inTrigger ( ) const

inlineprotectedinherited

Definition at line 115 of file TauRecToolBase.h.

{ return m_in_trigger; }

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg_level_name()

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

inherited

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

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

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

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

Returns

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

Definition at line 101 of file AsgTool.cxx.

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

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

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

overridevirtualinherited

Return this algorithm's output handles.

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

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

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

renounce()

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

inlineprotectedinherited

Definition at line 368 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 352 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, and AthCheckedComponent<::AthAlgTool >.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

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

inlineinherited

Definition at line 298 of file AthCommonDataStore.h.

                                               {
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_clusterEtCut

Gaudi::Property<double> TauPi0ClusterCreator::m_clusterEtCut {this, "ClusterEtCut", 0.5 * Gaudi::Units::GeV, "Et threshould for pi0 candidate clusters"}

private

Definition at line 79 of file TauPi0ClusterCreator.h.

{this, "ClusterEtCut", 0.5 * Gaudi::Units::GeV, "Et threshould for pi0 candidate clusters"};

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 381 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 378 of file AthCommonDataStore.h.

m_in_AOD

Gaudi::Property<bool> TauRecToolBase::m_in_AOD {this, "inAOD", false, "Indicate if the tool is running on AOD"}

protectedinherited

Definition at line 105 of file TauRecToolBase.h.

{this, "inAOD",       false,                     "Indicate if the tool is running on AOD"};

m_in_EleRM

Gaudi::Property<bool> TauRecToolBase::m_in_EleRM {this, "inEleRM", false, "Indicate if the tool is running on EleRM routine"}

protectedinherited

Definition at line 106 of file TauRecToolBase.h.

{this, "inEleRM",       false,                     "Indicate if the tool is running on EleRM routine"};

m_in_trigger

Gaudi::Property<bool> TauRecToolBase::m_in_trigger {this, "inTrigger", false, "Indicate if the tool is running on trigger"}

protectedinherited

Definition at line 104 of file TauRecToolBase.h.

{this, "inTrigger",   false,                     "Indicate if the tool is running on trigger"};

m_maxDeltaRJetClust

Gaudi::Property<double> TauPi0ClusterCreator::m_maxDeltaRJetClust {this, "MaxDeltaRJetClust", 0.4, "max DeltaR for vertexed cluster-tau association"}

private

Definition at line 81 of file TauPi0ClusterCreator.h.

{this, "MaxDeltaRJetClust", 0.4, "max DeltaR for vertexed cluster-tau association"};

m_maxDeltaRNeutral

Gaudi::Property<double> TauPi0ClusterCreator::m_maxDeltaRNeutral {this, "MaxDeltaRNeutral", 0.2, "max DeltaR for pi0-tau association"}

private

Definition at line 80 of file TauPi0ClusterCreator.h.

{this, "MaxDeltaRNeutral", 0.2, "max DeltaR for pi0-tau association"};

m_recoFromAOD

Gaudi::Property<double> TauPi0ClusterCreator::m_recoFromAOD {this, "RecoFromAOD", false, "Flag if the reconstruction is happening at AOD-level"}

private

Definition at line 82 of file TauPi0ClusterCreator.h.

{this, "RecoFromAOD", false, "Flag if the reconstruction is happening at AOD-level"};

m_tauRecToolsTag

Gaudi::Property<std::string> TauRecToolBase::m_tauRecToolsTag {this, "calibFolder", "tauRecTools/R22_preprod", "CVMFS path to the tau calibration folder"}

protectedinherited

Definition at line 107 of file TauRecToolBase.h.

{this, "calibFolder", "tauRecTools/R22_preprod", "CVMFS path to the tau calibration folder"};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 387 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 386 of file AthCommonDataStore.h.

---

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

• TauPi0ClusterCreator.h
• TauPi0ClusterCreator.cxx