ATLAS Offline Software
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
eflowCaloObject Class Reference

An internal EDM object which stores information about systems of associated tracks and calorimeter clusters. More...

#include <eflowCaloObject.h>

Collaboration diagram for eflowCaloObject:

Public Member Functions

 eflowCaloObject ()=default
 ~eflowCaloObject ()
void addTrack (eflowRecTrack *track)
void addCluster (eflowRecCluster *cluster)
void addTrackClusterLinks (const std::vector< eflowTrackClusterLink * > &trackClusterLink)
void addTracks (const std::vector< eflowRecTrack * > &tracks)
void addClusters (const std::vector< eflowRecCluster * > &clusters)
void setTrackClusterLinkSubtractionStatus (unsigned int index, const std::pair< float, float > &energyRatio_energyValPair)
const eflowRecTrack * efRecTrack (int i) const
eflowRecTrack * efRecTrack (int i)
unsigned nTracks () const
void clearTracks ()
const eflowRecCluster * efRecCluster (int i) const
eflowRecCluster * efRecCluster (int i)
unsigned nClusters () const
void clearClusters ()
const std::vector< std::pair< eflowTrackClusterLink *, std::pair< float, float > > > & efRecLink () const
void clearLinks ()
double getExpectedEnergy () const
double getExpectedVariance () const
double getClusterEnergy () const
void simulateShower (const EventContext &ctx, eflowLayerIntegrator *integrator, const eflowEEtaBinnedParameters *binnedParameters, const PFEnergyPredictorTool *energyP, bool useLegacyEnergyBinIndexing)

Private Member Functions

void addTrackClusterLink (eflowTrackClusterLink *trackClusterLink)

Private Attributes

std::vector< eflowRecCluster * > m_eflowRecClusters
std::vector< std::pair< eflowTrackClusterLink *, std::pair< float, float > > > m_trackClusterLinks
std::vector< eflowRecTrack * > m_eflowRecTracks

Detailed Description

An internal EDM object which stores information about systems of associated tracks and calorimeter clusters.

Specifically it stores vectors of pointers to eflowRecTracks, eflowRecClusters and eflowTrackClusterLinks. In addition it stores links to an xAOD::CaloClusterContainer and its associated aux container. This class also calculates the expected energy deposit in the calorimeter from a track in the system, and stores that information so that clients can retrieve it. It also calculates the calorimeter cell ordering to be used in the subtraction. Both of these things are done in the simulateShower method which uses the data stored in an eflowEEtaBinnedParameters object, which is filled by e.g the eflowCellEOverP_mc12_JetETMiss tool.

Definition at line 35 of file eflowCaloObject.h.

Constructor & Destructor Documentation

◆ eflowCaloObject()

eflowCaloObject::eflowCaloObject ( )
default

◆ ~eflowCaloObject()

eflowCaloObject::~eflowCaloObject ( )
default

Member Function Documentation

◆ addCluster()

void eflowCaloObject::addCluster ( eflowRecCluster * cluster)
inline

Definition at line 42 of file eflowCaloObject.h.

42{ m_eflowRecClusters.push_back(cluster); }
eflowCaloObject::m_eflowRecClusters
std::vector< eflowRecCluster * > m_eflowRecClusters
Definition eflowCaloObject.h:83

◆ addClusters()

void eflowCaloObject::addClusters ( const std::vector< eflowRecCluster * > & clusters)

Definition at line 38 of file eflowCaloObject.cxx.

38 {
39 m_eflowRecClusters.insert(m_eflowRecClusters.end(), clusters.begin(), clusters.end());
40 }

◆ addTrack()

void eflowCaloObject::addTrack ( eflowRecTrack * track)
inline

Definition at line 41 of file eflowCaloObject.h.

41{ m_eflowRecTracks.push_back(track); }
eflowCaloObject::m_eflowRecTracks
std::vector< eflowRecTrack * > m_eflowRecTracks
Definition eflowCaloObject.h:93

◆ addTrackClusterLink()

void eflowCaloObject::addTrackClusterLink ( eflowTrackClusterLink * trackClusterLink)
inlineprivate

Definition at line 79 of file eflowCaloObject.h.

79{ m_trackClusterLinks.push_back(std::pair(trackClusterLink,std::pair(NAN,NAN))); }
eflowCaloObject::m_trackClusterLinks
std::vector< std::pair< eflowTrackClusterLink *, std::pair< float, float > > > m_trackClusterLinks
Definition eflowCaloObject.h:90

◆ addTrackClusterLinks()

void eflowCaloObject::addTrackClusterLinks ( const std::vector< eflowTrackClusterLink * > & trackClusterLink)

Definition at line 28 of file eflowCaloObject.cxx.

28 {
29 for (auto *ptr : trackClusterLink) {
30 addTrackClusterLink(ptr);
31 }
32}
eflowCaloObject::addTrackClusterLink
void addTrackClusterLink(eflowTrackClusterLink *trackClusterLink)
Definition eflowCaloObject.h:79

◆ addTracks()

void eflowCaloObject::addTracks ( const std::vector< eflowRecTrack * > & tracks)

Definition at line 34 of file eflowCaloObject.cxx.

34 {
35 m_eflowRecTracks.insert(m_eflowRecTracks.end(), tracks.begin(), tracks.end());
36 }

◆ clearClusters()

void eflowCaloObject::clearClusters ( )
inline

Definition at line 62 of file eflowCaloObject.h.

62{ m_eflowRecClusters.clear(); }

◆ clearLinks()

void eflowCaloObject::clearLinks ( )
inline

Definition at line 67 of file eflowCaloObject.h.

67{ m_trackClusterLinks.clear(); }

◆ clearTracks()

void eflowCaloObject::clearTracks ( )
inline

Definition at line 56 of file eflowCaloObject.h.

56{ m_eflowRecTracks.clear(); }

◆ efRecCluster() [1/2]

eflowRecCluster * eflowCaloObject::efRecCluster ( int i)
inline

Definition at line 60 of file eflowCaloObject.h.

60{ return m_eflowRecClusters[i]; }

◆ efRecCluster() [2/2]

const eflowRecCluster * eflowCaloObject::efRecCluster ( int i) const
inline

Definition at line 59 of file eflowCaloObject.h.

59{ return m_eflowRecClusters[i]; }

◆ efRecLink()

const std::vector< std::pair< eflowTrackClusterLink *, std::pair< float, float > > > & eflowCaloObject::efRecLink ( ) const
inline

Definition at line 66 of file eflowCaloObject.h.

66{ return m_trackClusterLinks; }

◆ efRecTrack() [1/2]

eflowRecTrack * eflowCaloObject::efRecTrack ( int i)
inline

Definition at line 54 of file eflowCaloObject.h.

54{ return m_eflowRecTracks[i]; }

◆ efRecTrack() [2/2]

const eflowRecTrack * eflowCaloObject::efRecTrack ( int i) const
inline

Definition at line 53 of file eflowCaloObject.h.

53{ return m_eflowRecTracks[i]; }

◆ getClusterEnergy()

double eflowCaloObject::getClusterEnergy ( ) const

Definition at line 58 of file eflowCaloObject.cxx.

58 {
59 double clusterEnergy(0.0);
60 for(unsigned iCluster=0; iCluster < nClusters(); ++iCluster) {
61 clusterEnergy += efRecCluster(iCluster)->getCluster()->e();
62 }
63 return clusterEnergy;
64}
eflowCaloObject::nClusters
unsigned nClusters() const
Definition eflowCaloObject.h:61
eflowCaloObject::efRecCluster
const eflowRecCluster * efRecCluster(int i) const
Definition eflowCaloObject.h:59
eflowRecCluster::getCluster
xAOD::CaloCluster * getCluster()
Definition eflowRecCluster.h:49
xAOD::CaloCluster_v1::e
virtual double e() const
The total energy of the particle.
Definition CaloCluster_v1.cxx:265

◆ getExpectedEnergy()

double eflowCaloObject::getExpectedEnergy ( ) const

Definition at line 42 of file eflowCaloObject.cxx.

42 {
43 double expectedEnergy(0.0);
44 for(unsigned iTrack=0; iTrack < nTracks(); ++iTrack) {
45 if (!efRecTrack(iTrack)->isInDenseEnvironment()) expectedEnergy += efRecTrack(iTrack)->getEExpect();
46 }
47 return expectedEnergy;
48}
eflowCaloObject::efRecTrack
const eflowRecTrack * efRecTrack(int i) const
Definition eflowCaloObject.h:53
eflowCaloObject::nTracks
unsigned nTracks() const
Definition eflowCaloObject.h:55
eflowRecTrack::getEExpect
double getEExpect() const
Definition eflowRecTrack.h:85

◆ getExpectedVariance()

double eflowCaloObject::getExpectedVariance ( ) const

Definition at line 50 of file eflowCaloObject.cxx.

50 {
51 double expectedVariance(0.0);
52 for(unsigned iTrack=0; iTrack < nTracks(); ++iTrack) {
53 if (!efRecTrack(iTrack)->isInDenseEnvironment()) expectedVariance += efRecTrack(iTrack)->getVarEExpect();
54 }
55 return expectedVariance;
56}
eflowRecTrack::getVarEExpect
double getVarEExpect() const
Definition eflowRecTrack.h:86

◆ nClusters()

unsigned eflowCaloObject::nClusters ( ) const
inline

Definition at line 61 of file eflowCaloObject.h.

61{ return m_eflowRecClusters.size(); }

◆ nTracks()

unsigned eflowCaloObject::nTracks ( ) const
inline

Definition at line 55 of file eflowCaloObject.h.

55{ return m_eflowRecTracks.size(); }

◆ setTrackClusterLinkSubtractionStatus()

void eflowCaloObject::setTrackClusterLinkSubtractionStatus ( unsigned int index,
const std::pair< float, float > & energyRatio_energyValPair )
inline

Definition at line 50 of file eflowCaloObject.h.

50{ m_trackClusterLinks[index].second = energyRatio_energyValPair; }
DeMoScan.index
str index
Definition DeMoScan.py:362

◆ simulateShower()

void eflowCaloObject::simulateShower ( const EventContext & ctx,
eflowLayerIntegrator * integrator,
const eflowEEtaBinnedParameters * binnedParameters,
const PFEnergyPredictorTool * energyP,
bool useLegacyEnergyBinIndexing )

Definition at line 66 of file eflowCaloObject.cxx.

67 {
68
69 for (auto *thisEfRecTrack : m_eflowRecTracks) {
70
71 std::vector<eflowRecCluster*> matchedClusters;
72 const std::vector<eflowTrackClusterLink*>& links = thisEfRecTrack->getClusterMatches();
73 for (auto* itLink : links) {
74 matchedClusters.push_back(itLink->getCluster());
75 }
76
77 double trackEM1eta = thisEfRecTrack->getTrackCaloPoints().getEM1eta();
78 /* if a track is in the forward EM (2.5 < eta < 3.2) then there is no EM1 -> need to use EM2 */
79 if(trackEM1eta<-998.) trackEM1eta = thisEfRecTrack->getTrackCaloPoints().getEM2eta();
80 /* if a track is not in the EM region (3.2 < eta < 4.0) then should use FCAL0 */
81 if(trackEM1eta<-998.) trackEM1eta = thisEfRecTrack->getTrackCaloPoints().getFCAL0eta();
82
83 double trackE = thisEfRecTrack->getTrack()->e();
84
85 if (!binnedParameters->binExists(trackE, trackEM1eta)) {
86 thisEfRecTrack->setHasBin(false);
87 return;
88 }
89
90 /* Determine the LFI */
91 integrator->measureNewClus(ctx, matchedClusters, thisEfRecTrack);
92 eflowFirstIntENUM j1st = integrator->getFirstIntLayer();
93
94 /*Save j1st info */
95 thisEfRecTrack->setLayerHED(j1st);
96
97 /* Get parameters for j1st */
98 eflowRingSubtractionManager& cellSubtractionManager = thisEfRecTrack->getCellSubtractionManager();
99 cellSubtractionManager.getOrdering(binnedParameters, trackE, trackEM1eta, j1st,useLegacyEnergyBinIndexing);
100
101 /* Set expected energy in the eflowRecTrack object */
102 const double expectedEnergy = energyP ? energyP->nnEnergyPrediction(thisEfRecTrack) : cellSubtractionManager.fudgeMean() * thisEfRecTrack->getTrack()->e();
103 const double expectedEnergySigma = std::fabs(cellSubtractionManager.fudgeStdDev() * thisEfRecTrack->getTrack()->e());
104
105 const std::vector<eflowTrackClusterLink*>* bestClusters_015 = thisEfRecTrack->getAlternativeClusterMatches("cone_015");
106 const std::vector<eflowTrackClusterLink*>* bestClusters_02 = thisEfRecTrack->getAlternativeClusterMatches("cone_02");
107
108 //First we calculate how much energy is found in a cone of 0.15
109 float totalE_015 = 0.0;
110
111 //This pointer can be a nullptr if no clusters were matched to a track in dR < 0.15
112 if (bestClusters_015){
113 for (eflowTrackClusterLink* thisLink : *bestClusters_015){
114 eflowRecCluster* thisBestCluster = thisLink->getCluster();
115 if (thisBestCluster){
116 const xAOD::CaloCluster* theCluster = thisBestCluster->getCluster();
117 if (theCluster) {
118 if (theCluster->e()>0.0){
119 totalE_015 += theCluster->e();
120 }
121 }
122 }
123 }
124 }//if vector of 0.15 clusters exists
125
126 double pull_015 = NAN;
127 if (expectedEnergySigma > 1e-6 ) pull_015 = (totalE_015-expectedEnergy)/expectedEnergySigma;
128 thisEfRecTrack->setpull15(pull_015);
129
130 double trackPt = thisEfRecTrack->getTrack()->pt();
131 //If the looked up expected energy deposit was 0.0, then pull_015 is NAN. In that case we should not try to apply the 2D cut described below.
132 if (!std::isnan(pull_015)){
133 //We use a 2D cut in the pull_015 and log10 of track pt plane to define a dense environment - if too dense then we disable the charged shower subtraction
134 //The cut values are such that above a track pt of 40 GeV we are very agrressive about disabling the cell by cell charged shower subtraction.
135 //The specific cut values were found by optimising the jet resolutions in the run 2 data taking environment.
136 //Further details can be found in these slides from C. Young:
137 //https://indico.cern.ch/event/396923/contributions/949333/attachments/795878/1090871/Presentation.pdf
138 if (pull_015 > 0.0 + (log10(40000)-log10(trackPt))*33.2 && 0.0 != expectedEnergySigma && bestClusters_015 && bestClusters_02){
139 thisEfRecTrack->setSubtracted(); //this tricks eflowRec into thinking this track was subtracted, and hence no further subtraction will be done
140 thisEfRecTrack->setIsInDenseEnvironment();
141 //recalculate the LHED and the ordering and find the new expected E + sigma of expected E (the new LHED can change the latter two values we find in the look up tables)
142 //we use a larger cone of 0.2 for this
143 std::vector<eflowRecCluster*> theBestEfRecClusters_02;
144 for (eflowTrackClusterLink* thisLink : *bestClusters_02) if (thisLink->getCluster()->getCluster()->e() > 0.0) theBestEfRecClusters_02.push_back(thisLink->getCluster());
145 integrator->measureNewClus(ctx, theBestEfRecClusters_02, thisEfRecTrack);
146 j1st = integrator->getFirstIntLayer();
147 cellSubtractionManager.getOrdering(binnedParameters, trackE, trackEM1eta, j1st,useLegacyEnergyBinIndexing);
148 thisEfRecTrack->setEExpect(cellSubtractionManager.fudgeMean() * trackE, std::fabs(cellSubtractionManager.fudgeStdDev()*trackE)*std::fabs(cellSubtractionManager.fudgeStdDev()*trackE));
149 }
150 else {
151 thisEfRecTrack->setEExpect(expectedEnergy, expectedEnergySigma*expectedEnergySigma);
152 }//ok to do subtraction, and so we just set the usual expected E + sigma of expected E needed for subtraction
153 }
154 }
155}
PFEnergyPredictorTool::nnEnergyPrediction
float nnEnergyPrediction(const eflowRecTrack *ptr) const
Definition PFEnergyPredictorTool.cxx:132
eflowEEtaBinBase::binExists
bool binExists(double e, double eta) const
Definition eflowEEtaBinBase.h:32
eflowLayerIntegrator::measureNewClus
void measureNewClus(const xAOD::CaloCluster *clus, const eflowTrackCaloPoints &trackCalo)
Definition eflowLayerIntegrator.cxx:154
eflowLayerIntegrator::getFirstIntLayer
eflowFirstIntENUM getFirstIntLayer() const
Definition eflowLayerIntegrator.cxx:230
eflowRingSubtractionManager::getOrdering
bool getOrdering(const eflowEEtaBinnedParameters *binnedParameters, double e, double eta, eflowFirstIntENUM j1st, bool useLegacyEnergyBinIndexing)
Definition eflowRingSubtractionManager.cxx:100
eflowFirstIntENUM
eflowFirstIntRegions::J1STLAYER eflowFirstIntENUM
Definition eflowCaloRegions.h:79
TauTrackVars::trackPt
bool trackPt(const xAOD::TauJet &, const xAOD::TauTrack &track, float &out)
Definition ConstituentLoaderTauTrack.cxx:111
xAOD::CaloCluster
CaloCluster_v1 CaloCluster
Define the latest version of the calorimeter cluster class.
Definition Event/xAOD/xAODCaloEvent/xAODCaloEvent/CaloCluster.h:19

Member Data Documentation

◆ m_eflowRecClusters

std::vector<eflowRecCluster*> eflowCaloObject::m_eflowRecClusters
private

Definition at line 83 of file eflowCaloObject.h.

◆ m_eflowRecTracks

std::vector<eflowRecTrack*> eflowCaloObject::m_eflowRecTracks
private

Definition at line 93 of file eflowCaloObject.h.

◆ m_trackClusterLinks

std::vector<std::pair<eflowTrackClusterLink*,std::pair<float,float> > > eflowCaloObject::m_trackClusterLinks
private

Definition at line 90 of file eflowCaloObject.h.

The documentation for this class was generated from the following files:
Generated on for ATLAS Offline Software by doxygen 1.16.1