TauShotFinder Class Reference

#include <TauShotFinder.h>

Inheritance diagram for TauShotFinder:

Collaboration diagram for TauShotFinder:

Classes
struct	ptSort

Public Member Functions
	ASG_TOOL_CLASS2 (TauShotFinder, TauRecToolBase, ITauToolBase)
	TauShotFinder (const std::string &name)
virtual	~TauShotFinder ()=default
virtual StatusCode	initialize () override
	Tool initializer.
virtual StatusCode	executeTool (xAOD::TauJet &pTau, const EventContext &ctx, xAOD::CaloClusterContainer &tauShotCaloClusContainer, xAOD::PFOContainer &tauShotPFOContainer) 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::PFOContainer &, xAOD::PFOContainer &, const xAOD::CaloClusterContainer &) 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	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	selectCells (const xAOD::TauJet &tau, std::vector< const CaloCell * > &cells, const EventContext &ctx) const
	Apply preselection of the cells Cells within dR < 0.4, in EM1, and pt > 100 MeV are selected.
StatusCode	selectSeedCells (const xAOD::TauJet &tau, const CaloCellContainer &cellContainer, std::vector< const CaloCell * > &seedCells, const EventContext &ctx) const
	Select the seed cells used to construct the shot Cells must sastisfy:
bool	isPhiNeighbour (IdentifierHash cell1Hash, IdentifierHash cell2Hash) const
	Check whether two cells are neighbours in the phi direction.
const CaloCell *	getPhiNeighbour (const CaloCell &seedCell, const std::vector< const CaloCell * > &seedCells) const
	Get the hottest neighbour cell in the phi direction.
std::vector< const CaloCell * >	getEtaNeighbours (const CaloCell &cell, const CaloCellContainer &cellContainer, int maxDepth) const
	Get neighbour cells in the eta direction.
void	addEtaNeighbours (const CaloCell &cell, const CaloCellContainer &cellContainer, std::vector< const CaloCell * > &cells, int depth, int maxDepth, bool next) const
	Get neighbour cells in the eta direction.
xAOD::CaloCluster *	createShotCluster (const CaloCell *cell, const CaloCell *phiNeighCell, const CaloCellContainer &cellContainer, xAOD::CaloClusterContainer *clusterContainer) const
	Create the shot cluster Shot cluster contains 5x1 cells from the seed cell and hottestneighbour cell in the phi direction.
int	getEtaBin (float eta) const
	Get eta bin.
int	getNPhotons (float eta, float energy) const
	Get NPhotons in shot.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< int >	m_nCellsInEta {this, "NCellsInEta"}
Gaudi::Property< std::vector< float > >	m_minPtCut {this, "MinPtCut"}
Gaudi::Property< std::vector< float > >	m_doubleShotCut {this, "AutoDoubleShotCut"}
Gaudi::Property< bool >	m_removeElectronCells {this, "RemoveElectronCells", false}
Gaudi::Property< float >	m_energyThreshold {this, "EnergyThreshold", 100., "energy threshold (in MeV) to select cells"}
SG::ReadHandleKey< CaloCellContainer >	m_caloCellInputContainer {this,"Key_caloCellInputContainer", "AllCalo", "input calo cell container key"}
ToolHandle< IHadronicCalibrationTool >	m_caloWeightTool {this, "CaloWeightTool", "H1WeightToolCSC12Generic"}
SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_removedClusterInputContainer {this,"Key_RemovedClusterInputContainer", "", "input removed cluster key"}
const CaloCell_ID *	m_calo_id = nullptr
	calo cell navigation
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 30 of file TauShotFinder.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

TauShotFinder()

TauShotFinder::TauShotFinder

(

const std::string &

name

)

Definition at line 16 of file TauShotFinder.cxx.

                                                  :
    TauRecToolBase(name) {}

~TauShotFinder()

virtual TauShotFinder::~TauShotFinder ( )

virtualdefault

Member Function Documentation

addEtaNeighbours()

void TauShotFinder::addEtaNeighbours ( const CaloCell & cell, const CaloCellContainer & cellContainer, std::vector< const CaloCell * > & cells, int depth, int maxDepth, bool next ) const

private

Get neighbour cells in the eta direction.

Definition at line 331 of file TauShotFinder.cxx.

                                                      {
  ++depth; 
  
  if (depth > maxDepth) return;
 
  const IdentifierHash cellHash = cell.caloDDE()->calo_hash();
  
  std::vector<IdentifierHash> neigHashes;
  if (next) {
    m_calo_id->get_neighbours(cellHash,LArNeighbours::nextInEta,neigHashes);
  }
  else {
    m_calo_id->get_neighbours(cellHash,LArNeighbours::prevInEta,neigHashes);
  }
 
  for (const IdentifierHash& hash : neigHashes) {
    const CaloCell* newCell = cellContainer.findCell(hash);
    
    if (!newCell) continue;
    
    cells.push_back(newCell);
    this->addEtaNeighbours(*newCell, cellContainer, cells, depth, maxDepth, next);
  
    if (neigHashes.size() > 1) {
      ATH_MSG_DEBUG(cellHash << " has " << neigHashes.size()  <<  " neighbours in the eta direction !"); 
      break; 
    }
  } 
}

ASG_TOOL_CLASS2()

TauShotFinder::ASG_TOOL_CLASS2	(	TauShotFinder	,
		TauRecToolBase	,
		ITauToolBase	)

createShotCluster()

xAOD::CaloCluster * TauShotFinder::createShotCluster ( const CaloCell * cell, const CaloCell * phiNeighCell, const CaloCellContainer & cellContainer, xAOD::CaloClusterContainer * clusterContainer ) const

private

Create the shot cluster Shot cluster contains 5x1 cells from the seed cell and hottestneighbour cell in the phi direction.

Definition at line 368 of file TauShotFinder.cxx.

                                                                              {
    
  xAOD::CaloCluster* shotCluster = CaloClusterStoreHelper::makeCluster(clusterContainer,&cellContainer);
  
  int maxDepth = (m_nCellsInEta - 1) / 2;
 
  std::vector<const CaloCell*> windowNeighbours = this->getEtaNeighbours(*cell, cellContainer, maxDepth);
  if (phiNeigCell) {
    std::vector<const CaloCell*> mergeCells = this->getEtaNeighbours(*phiNeigCell, cellContainer, maxDepth);
    windowNeighbours.push_back(phiNeigCell);
    windowNeighbours.insert(windowNeighbours.end(), mergeCells.begin(), mergeCells.end());
  }
 
  shotCluster->getOwnCellLinks()->reserve(windowNeighbours.size()+1);
  const IdentifierHash seedHash = cell->caloDDE()->calo_hash();
  shotCluster->addCell(cellContainer.findIndex(seedHash), 1.);
  
  for (const CaloCell* thisCell : windowNeighbours) {
    shotCluster->addCell(cellContainer.findIndex(thisCell->caloDDE()->calo_hash()), 1.0);
  }
 
  CaloClusterKineHelper::calculateKine(shotCluster,true,true);
 
  return shotCluster;
} 

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::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() [5/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() [6/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() [7/10]

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

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 71 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 TauShotFinder::executeTool ( xAOD::TauJet & pTau, const EventContext & ctx, xAOD::CaloClusterContainer & tauShotCaloClusContainer, xAOD::PFOContainer & tauShotPFOContainer ) const

overridevirtual

Reimplemented from TauRecToolBase.

Definition at line 30 of file TauShotFinder.cxx.

                                                                {
 
  // Any tau needs to have shot PFO vectors. Set empty vectors before nTrack cut
  std::vector<ElementLink<xAOD::PFOContainer>> empty;
  tau.setShotPFOLinks(empty);
  
  // Only run on 0-5 prong taus 
  if (!tauRecTools::doPi0andShots(tau)) {
     return StatusCode::SUCCESS;
  }
  
  SG::ReadHandle<CaloCellContainer> caloCellInHandle( m_caloCellInputContainer, ctx );
  if (!caloCellInHandle.isValid()) {
    ATH_MSG_ERROR ("Could not retrieve HiveDataObj with key " << caloCellInHandle.key());
    return StatusCode::FAILURE;
  }
  const CaloCellContainer *cellContainer = caloCellInHandle.cptr();
 
  // Select seed cells:
  // -- dR < 0.4, EM1, pt > 100
  // -- largest pt among the neighbours in eta direction 
  // -- no other seed cell as neighbour in eta direction 
  std::vector<const CaloCell*> seedCells;
  ATH_CHECK(selectSeedCells(tau, *cellContainer, seedCells, ctx));
  ATH_MSG_DEBUG("seedCells.size() = " << seedCells.size());
    
  // Construt shot by merging neighbour cells in phi direction 
  while (!seedCells.empty()) {
    // Find the neighbour in phi direction, and choose the one with highest pt
    const CaloCell* cell = seedCells.front(); 
    const CaloCell* phiNeigCell = getPhiNeighbour(*cell, seedCells);
    
    // Construct shot PFO candidate
    xAOD::PFO* shot = new xAOD::PFO();
    shotPFOContainer.push_back(shot);
 
    // -- Construct the shot cluster 
    xAOD::CaloCluster* shotCluster = createShotCluster(cell, phiNeigCell, *cellContainer, &shotClusterContainer);
   
    ElementLink<xAOD::CaloClusterContainer> clusElementLink;
    clusElementLink.toContainedElement( shotClusterContainer, shotCluster );
    shot->setClusterLink( clusElementLink );
   
    // -- Calculate the four momentum
    // TODO: simplify the calculation 
    if (phiNeigCell) {
      // interpolate position
      double wtCell_phiNeigCell = m_caloWeightTool->wtCell(phiNeigCell);
      double wtCell_cell = m_caloWeightTool->wtCell(cell);
      double dPhi = TVector2::Phi_mpi_pi( phiNeigCell->phi() - cell->phi());
      double ratio = phiNeigCell->pt()*wtCell_phiNeigCell/(cell->pt()*wtCell_cell + phiNeigCell->pt()*wtCell_phiNeigCell);
      float phi = cell->phi()+dPhi*ratio;
      float pt = cell->pt()*wtCell_cell+phiNeigCell->pt()*wtCell_phiNeigCell;
 
      shot->setP4( static_cast<float>(pt), static_cast<float>(cell->eta()), static_cast<float>(phi), static_cast<float>(cell->m()));
    }
    else {
      shot->setP4( static_cast<float>(cell->pt()*m_caloWeightTool->wtCell(cell)), static_cast<float>(cell->eta()), static_cast<float>(cell->phi()), static_cast<float>(cell->m())); 
    }
 
    // -- Set the Attribute 
    shot->setBDTPi0Score(-9999.);
    shot->setCharge(0);
    shot->setCenterMag(0.0);
    
    shot->setAttribute<int>(xAOD::PFODetails::PFOAttributes::tauShots_nCellsInEta, m_nCellsInEta);
    
    const IdentifierHash seedHash = cell->caloDDE()->calo_hash();
    shot->setAttribute<int>(xAOD::PFODetails::PFOAttributes::tauShots_seedHash, seedHash);
 
    std::vector<std::vector<const CaloCell*>> cellBlock = TauShotVariableHelpers::getCellBlock(*shot, m_calo_id);
 
    float pt1 = TauShotVariableHelpers::ptWindow(cellBlock, 1, m_caloWeightTool);
    shot->setAttribute<float>(xAOD::PFODetails::PFOAttributes::tauShots_pt1, pt1);
    
    float pt3 = TauShotVariableHelpers::ptWindow(cellBlock, 3, m_caloWeightTool);
    shot->setAttribute<float>(xAOD::PFODetails::PFOAttributes::tauShots_pt3, pt3);
    
    float pt5 = TauShotVariableHelpers::ptWindow(cellBlock, 5, m_caloWeightTool);
    shot->setAttribute<float>(xAOD::PFODetails::PFOAttributes::tauShots_pt5, pt5);
    
    int nPhotons = getNPhotons(cell->eta(), pt1);
    shot->setAttribute<int>(xAOD::PFODetails::PFOAttributes::tauShots_nPhotons, nPhotons);
 
    // Add Element link to the shot PFO container
    ElementLink<xAOD::PFOContainer> PFOElementLink;
    PFOElementLink.toContainedElement(shotPFOContainer, shot);
    tau.addShotPFOLink(PFOElementLink);
    
    // Remove used cells from list
    auto cellIndex = std::find(seedCells.begin(), seedCells.end(), cell);
    seedCells.erase(cellIndex);
    if (phiNeigCell) {
      cellIndex = std::find(seedCells.begin(), seedCells.end(), phiNeigCell);
      seedCells.erase(cellIndex);
    }
  } // Loop over seed cells
  
  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;
}

getEtaBin()

int TauShotFinder::getEtaBin ( float eta ) const

private

Get eta bin.

Definition at line 136 of file TauShotFinder.cxx.

                                            {
  float absEta=std::abs(eta);
  
  if (absEta < 0.80) {
    return 0; // Central Barrel
  }
  if (absEta<1.39) {
    return 1; // Outer Barrel
  }
  if (absEta<1.51) {
    return 2; // Crack region
  }
  if (absEta<1.80) {
    return 3; // Endcap, fine granularity
  }
  return 4; // Endcap, coarse granularity
}

getEtaNeighbours()

std::vector< const CaloCell * > TauShotFinder::getEtaNeighbours ( const CaloCell & cell, const CaloCellContainer & cellContainer, int maxDepth ) const

private

Get neighbour cells in the eta direction.

Definition at line 316 of file TauShotFinder.cxx.

                                                                                 {
    std::vector<const CaloCell*> cells;
    
    // Add neighbours in next eta direction
    this->addEtaNeighbours(cell, cellContainer, cells, 0, maxDepth, true);
    // Add neighbours in previous eta direction
    this->addEtaNeighbours(cell, cellContainer, cells, 0, maxDepth, false);
 
    return cells; 
}

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 TauShotFinder::getNPhotons ( float eta, float energy ) const

private

Get NPhotons in shot.

Definition at line 156 of file TauShotFinder.cxx.

                                                            {
  int etaBin = getEtaBin(eta);
  
  // No photons in crack region
  if(etaBin==2) return 0;
 
  const std::vector<float>& minPtCut = m_minPtCut.value();
  const std::vector<float>& doubleShotCut = m_doubleShotCut.value();
  ATH_MSG_DEBUG("etaBin = " << etaBin  << ", energy = " << energy);
  ATH_MSG_DEBUG("MinPtCut: " << minPtCut.at(etaBin) << "DoubleShotCut: " << doubleShotCut.at(etaBin));
 
  if (energy < minPtCut.at(etaBin)) return 0;
  if (energy > doubleShotCut.at(etaBin)) return 2;
  return 1;
}

getPhiNeighbour()

const CaloCell * TauShotFinder::getPhiNeighbour ( const CaloCell & seedCell, const std::vector< const CaloCell * > & seedCells ) const

private

Get the hottest neighbour cell in the phi direction.

Definition at line 288 of file TauShotFinder.cxx.

                                                                                                  {
 
  const IdentifierHash seedHash = seedCell.caloDDE()->calo_hash();
 
  // Obtain the neighbour cells in the phi direction 
  std::vector<const CaloCell*> neighCells;
  for (const CaloCell* neighCell : seedCells) {
    if (neighCell == &seedCell) continue;
    
    IdentifierHash neighHash = neighCell->caloDDE()->calo_hash();
    if (this->isPhiNeighbour(seedHash, neighHash)) {
      neighCells.push_back(neighCell);
    }
  }
  std::sort(neighCells.begin(),neighCells.end(),ptSort(*this)); 
 
  // Select the one with largest pt
  const CaloCell* phiNeigCell = nullptr;
  if (!neighCells.empty()) {
    phiNeigCell = neighCells[0];
  } 
 
  return phiNeigCell;
}

getProperty()

template<class T>

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

inherited

Get one of the tool's properties.

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 TauShotFinder::initialize ( void )

overridevirtual

Tool initializer.

Reimplemented from TauRecToolBase.

Definition at line 19 of file TauShotFinder.cxx.

                                     {
  
  ATH_CHECK(m_caloWeightTool.retrieve());
  ATH_CHECK(m_caloCellInputContainer.initialize());
  ATH_CHECK(m_removedClusterInputContainer.initialize(SG::AllowEmpty));
  ATH_CHECK(detStore()->retrieve (m_calo_id, "CaloCell_ID"));
  ATH_MSG_INFO("Find TauShot in context: " << (inEleRM() ? "`EleRM`" : "`Standard`") << ", with Electron cell removal Flag: " << m_removeElectronCells);
  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; }

isPhiNeighbour()

bool TauShotFinder::isPhiNeighbour ( IdentifierHash cell1Hash, IdentifierHash cell2Hash ) const

private

Check whether two cells are neighbours in the phi direction.

Definition at line 266 of file TauShotFinder.cxx.

                                                                                           {
  std::vector<IdentifierHash> neigHashes;
 
  // Next cell in phi direction 
  m_calo_id->get_neighbours(cell1Hash,LArNeighbours::nextInPhi,neigHashes);
  if (neigHashes.size() > 1) {
    ATH_MSG_DEBUG(cell1Hash << " has " << neigHashes.size()  <<  " neighbours in the next phi direction !"); 
  }
  if (std::find(neigHashes.begin(), neigHashes.end(), cell2Hash) != neigHashes.end()) {
    return true;
  }
  
  // Previous cell in phi direction
  m_calo_id->get_neighbours(cell1Hash,LArNeighbours::prevInPhi,neigHashes);
  if (neigHashes.size() > 1) {
    ATH_MSG_DEBUG(cell1Hash << " has " << neigHashes.size()  <<  " neighbours in the previous phi direction !"); 
  }
  return std::find(neigHashes.begin(), neigHashes.end(), cell2Hash) != neigHashes.end();
}

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

selectCells()

StatusCode TauShotFinder::selectCells ( const xAOD::TauJet & tau, std::vector< const CaloCell * > & cells, const EventContext & ctx ) const

private

Apply preselection of the cells Cells within dR < 0.4, in EM1, and pt > 100 MeV are selected.

Definition at line 174 of file TauShotFinder.cxx.

                                                     {
  // if in EleRM tau reco, do electron cell removal
  std::vector<const CaloCell*> removed_cells;
  if (m_removeElectronCells && inEleRM()){
    SG::ReadHandle<xAOD::CaloClusterContainer> removedClustersHandle( m_removedClusterInputContainer, ctx );
    if (!removedClustersHandle.isValid()){
      ATH_MSG_ERROR ("Could not retrieve HiveDataObj with key " << removedClustersHandle.key());
      return StatusCode::FAILURE;
    }
    const xAOD::CaloClusterContainer *removed_clusters_cont = removedClustersHandle.cptr();
    
    for (auto cluster : *removed_clusters_cont){
      for(auto cell_it = cluster->cell_cbegin(); cell_it != cluster->cell_cend(); cell_it++){
        removed_cells.push_back(*cell_it);
      }
    }
  }
 
  // retrieve EM1 cells within dR=0.4, pre-selected by TauPi0CreateROI
  static const SG::ConstAccessor<std::vector<const CaloCell*>> acc_shotCells("shotCells");
  std::vector<const CaloCell*> shotCells = acc_shotCells(tau);
  
  for (const CaloCell* cell : shotCells) {
    // Require cells above threshold (100 MeV by default)
    if (cell->pt() * m_caloWeightTool->wtCell(cell) < m_energyThreshold) continue;
    // if in EleRM, check the clusters do not include electron activities
    if (m_removeElectronCells && inEleRM() && std::find(removed_cells.cbegin(), removed_cells.cend(), cell) != removed_cells.cend()) continue;
    
    cells.push_back(cell);
  }
  return StatusCode::SUCCESS;
} 

selectSeedCells()

StatusCode TauShotFinder::selectSeedCells ( const xAOD::TauJet & tau, const CaloCellContainer & cellContainer, std::vector< const CaloCell * > & seedCells, const EventContext & ctx ) const

private

Select the seed cells used to construct the shot Cells must sastisfy:

1. pre-selction: dR < 0.4, in EM1, and pt > 100 MeV
2. have largest pt among the neighbours in the eta direction
3. no other seed cells as neighbors in the eta direction

Definition at line 211 of file TauShotFinder.cxx.

                                                     {
 
  // Apply pre-selection of the cells
  assert(seedCells.empty());
  std::vector<const CaloCell*> cells;
  ATH_CHECK(selectCells(tau, cells, ctx));
  std::sort(cells.begin(),cells.end(),ptSort(*this));
 
  std::set<IdentifierHash> seedCellHashes;
 
  // Loop the pt sorted cells, and select the seed cells
  for (const CaloCell* cell: cells) {
    const IdentifierHash cellHash = cell->caloDDE()->calo_hash();
 
    std::vector<IdentifierHash> nextEtaHashes;
    m_calo_id->get_neighbours(cellHash, LArNeighbours::nextInEta, nextEtaHashes);
    std::vector<IdentifierHash> prevEtaHashes;
    m_calo_id->get_neighbours(cellHash, LArNeighbours::prevInEta, prevEtaHashes);
   
    std::vector<IdentifierHash> neighHashes = std::move(nextEtaHashes); 
    neighHashes.insert(neighHashes.end(),prevEtaHashes.begin(),prevEtaHashes.end()); 
   
    // Check whether it is a seed cell
    bool status = true;
    for (const IdentifierHash& neighHash : neighHashes) {
      // Seed cells must not have seed cells as neighbours
      // TODO: maybe this requirement can be removed
      if (seedCellHashes.find(neighHash) != seedCellHashes.end()) {
        status = false;
        break;
      }
      
      // Pt of seed cells must be larger than neighbours'
      const CaloCell* neighCell = cellContainer.findCell(neighHash);
      if (!neighCell) continue;
      if (neighCell->pt() * m_caloWeightTool->wtCell(neighCell) >= cell->pt() * m_caloWeightTool->wtCell(cell)) {
        status = false;
        break;
      }
    } // End of the loop of neighbour cells
    
    if (!status) continue; 
    
    seedCells.push_back(cell); 
    seedCellHashes.insert(cellHash);
  } // End of the loop of cells
 
  return StatusCode::SUCCESS;
} 

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_calo_id

const CaloCell_ID* TauShotFinder::m_calo_id = nullptr

private

calo cell navigation

Definition at line 117 of file TauShotFinder.h.

m_caloCellInputContainer

SG::ReadHandleKey<CaloCellContainer> TauShotFinder::m_caloCellInputContainer {this,"Key_caloCellInputContainer", "AllCalo", "input calo cell container key"}

private

Definition at line 112 of file TauShotFinder.h.

{this,"Key_caloCellInputContainer", "AllCalo", "input calo cell container key"};

m_caloWeightTool

ToolHandle<IHadronicCalibrationTool> TauShotFinder::m_caloWeightTool {this, "CaloWeightTool", "H1WeightToolCSC12Generic"}

private

Definition at line 113 of file TauShotFinder.h.

{this, "CaloWeightTool", "H1WeightToolCSC12Generic"};

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_doubleShotCut

Gaudi::Property<std::vector<float> > TauShotFinder::m_doubleShotCut {this, "AutoDoubleShotCut"}

private

Definition at line 108 of file TauShotFinder.h.

{this, "AutoDoubleShotCut"};

m_energyThreshold

Gaudi::Property<float> TauShotFinder::m_energyThreshold {this, "EnergyThreshold", 100., "energy threshold (in MeV) to select cells"}

private

Definition at line 110 of file TauShotFinder.h.

{this, "EnergyThreshold", 100., "energy threshold (in MeV) to select cells"};

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_minPtCut

Gaudi::Property<std::vector<float> > TauShotFinder::m_minPtCut {this, "MinPtCut"}

private

Definition at line 107 of file TauShotFinder.h.

{this, "MinPtCut"};

m_nCellsInEta

Gaudi::Property<int> TauShotFinder::m_nCellsInEta {this, "NCellsInEta"}

private

Definition at line 106 of file TauShotFinder.h.

{this, "NCellsInEta"};

m_removedClusterInputContainer

SG::ReadHandleKey<xAOD::CaloClusterContainer> TauShotFinder::m_removedClusterInputContainer {this,"Key_RemovedClusterInputContainer", "", "input removed cluster key"}

private

Definition at line 114 of file TauShotFinder.h.

{this,"Key_RemovedClusterInputContainer", "", "input removed cluster key"};

m_removeElectronCells

Gaudi::Property<bool> TauShotFinder::m_removeElectronCells {this, "RemoveElectronCells", false}

private

Definition at line 109 of file TauShotFinder.h.

{this, "RemoveElectronCells", false};

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:

• TauShotFinder.h
• TauShotFinder.cxx