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, 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 (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 34 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 41 of file eflowCaloObject.h.

{ m_eflowRecClusters.push_back(cluster); }

addClusters()

void eflowCaloObject::addClusters

(

const std::vector< eflowRecCluster * > &

clusters

)

Definition at line 36 of file eflowCaloObject.cxx.

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

addTrack()

void eflowCaloObject::addTrack ( eflowRecTrack * track )

inline

Definition at line 40 of file eflowCaloObject.h.

{ m_eflowRecTracks.push_back(track); }

addTrackClusterLink()

void eflowCaloObject::addTrackClusterLink ( eflowTrackClusterLink * trackClusterLink )

inlineprivate

Definition at line 78 of file eflowCaloObject.h.

{ m_trackClusterLinks.push_back(std::pair(trackClusterLink,std::pair(NAN,NAN))); }

addTrackClusterLinks()

void eflowCaloObject::addTrackClusterLinks

(

const std::vector< eflowTrackClusterLink * > &

trackClusterLink

)

Definition at line 26 of file eflowCaloObject.cxx.

                                                                                                    {
  for (auto *ptr : trackClusterLink) {
    addTrackClusterLink(ptr);
  }
}

addTracks()

void eflowCaloObject::addTracks

(

const std::vector< eflowRecTrack * > &

tracks

)

Definition at line 32 of file eflowCaloObject.cxx.

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

clearClusters()

void eflowCaloObject::clearClusters ( )

inline

Definition at line 61 of file eflowCaloObject.h.

{ m_eflowRecClusters.clear(); }

clearLinks()

void eflowCaloObject::clearLinks ( )

inline

Definition at line 66 of file eflowCaloObject.h.

{ m_trackClusterLinks.clear(); }

clearTracks()

void eflowCaloObject::clearTracks ( )

inline

Definition at line 55 of file eflowCaloObject.h.

{ m_eflowRecTracks.clear(); }

efRecCluster() [1/2]

eflowRecCluster * eflowCaloObject::efRecCluster ( int i )

inline

Definition at line 59 of file eflowCaloObject.h.

{ return m_eflowRecClusters[i]; }

efRecCluster() [2/2]

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

inline

Definition at line 58 of file eflowCaloObject.h.

{ return m_eflowRecClusters[i]; }

efRecLink()

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

inline

Definition at line 65 of file eflowCaloObject.h.

{ return m_trackClusterLinks; }

efRecTrack() [1/2]

eflowRecTrack * eflowCaloObject::efRecTrack ( int i )

inline

Definition at line 53 of file eflowCaloObject.h.

{ return m_eflowRecTracks[i]; }

efRecTrack() [2/2]

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

inline

Definition at line 52 of file eflowCaloObject.h.

{ return m_eflowRecTracks[i]; }

getClusterEnergy()

double eflowCaloObject::getClusterEnergy

(

)

const

Definition at line 56 of file eflowCaloObject.cxx.

                                               {
  double clusterEnergy(0.0);
  for(unsigned iCluster=0; iCluster < nClusters(); ++iCluster) {
    clusterEnergy  += efRecCluster(iCluster)->getCluster()->e();
  }
  return clusterEnergy;
}

getExpectedEnergy()

double eflowCaloObject::getExpectedEnergy

(

)

const

Definition at line 40 of file eflowCaloObject.cxx.

                                                 {
  double expectedEnergy(0.0);
  for(unsigned iTrack=0; iTrack < nTracks(); ++iTrack) {
    if (!efRecTrack(iTrack)->isInDenseEnvironment()) expectedEnergy += efRecTrack(iTrack)->getEExpect();
  }
  return expectedEnergy;
}

getExpectedVariance()

double eflowCaloObject::getExpectedVariance

(

)

const

Definition at line 48 of file eflowCaloObject.cxx.

                                                  {
  double expectedVariance(0.0);
  for(unsigned iTrack=0; iTrack < nTracks(); ++iTrack) {
    if (!efRecTrack(iTrack)->isInDenseEnvironment()) expectedVariance += efRecTrack(iTrack)->getVarEExpect();
  }
  return expectedVariance;
}

nClusters()

unsigned eflowCaloObject::nClusters ( ) const

inline

Definition at line 60 of file eflowCaloObject.h.

{ return m_eflowRecClusters.size(); }

nTracks()

unsigned eflowCaloObject::nTracks ( ) const

inline

Definition at line 54 of file eflowCaloObject.h.

{ return m_eflowRecTracks.size(); }

setTrackClusterLinkSubtractionStatus()

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

inline

Definition at line 49 of file eflowCaloObject.h.

{ m_trackClusterLinks[index].second = energyRatio_energyValPair; }

simulateShower()

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

Definition at line 64 of file eflowCaloObject.cxx.

                                                                      {
 
  for (auto *thisEfRecTrack : m_eflowRecTracks) {
 
    std::vector<eflowRecCluster*> matchedClusters;
    matchedClusters.clear();
    std::vector<eflowTrackClusterLink*> links = thisEfRecTrack->getClusterMatches();
    std::vector<eflowTrackClusterLink*>::iterator itLink = links.begin();
    std::vector<eflowTrackClusterLink*>::iterator endLink = links.end();
    for (; itLink != endLink; ++itLink) {
      matchedClusters.push_back((*itLink)->getCluster());
    }
 
    double trackEM1eta = thisEfRecTrack->getTrackCaloPoints().getEM1eta();
    /* if a track is in the forward EM (2.5 < eta < 3.2) then there is no EM1 -> need to use EM2 */
    if(trackEM1eta<-998.) trackEM1eta = thisEfRecTrack->getTrackCaloPoints().getEM2eta();
    /* if a track is not in the EM region (3.2 < eta < 4.0) then should use FCAL0 */
    if(trackEM1eta<-998.) trackEM1eta = thisEfRecTrack->getTrackCaloPoints().getFCAL0eta();
 
    double trackE = thisEfRecTrack->getTrack()->e();
 
    if (!binnedParameters->binExists(trackE, trackEM1eta)) {
      thisEfRecTrack->setHasBin(false);
      return;
    }
 
    /* Determine the LFI */
    integrator->measureNewClus(matchedClusters, thisEfRecTrack);
    eflowFirstIntENUM j1st = integrator->getFirstIntLayer();
    
    /*Save j1st info */
    thisEfRecTrack->setLayerHED(j1st);
 
    /* Get parameters for j1st */
    eflowRingSubtractionManager& cellSubtractionManager = thisEfRecTrack->getCellSubtractionManager();
    cellSubtractionManager.getOrdering(binnedParameters, trackE, trackEM1eta, j1st,useLegacyEnergyBinIndexing);
 
    /* Set expected energy in the eflowRecTrack object */
    const double expectedEnergy = energyP ? energyP->nnEnergyPrediction(thisEfRecTrack) : cellSubtractionManager.fudgeMean() * thisEfRecTrack->getTrack()->e();     
    const double expectedEnergySigma = fabs(cellSubtractionManager.fudgeStdDev() * thisEfRecTrack->getTrack()->e());
 
    const std::vector<eflowTrackClusterLink*>* bestClusters_015 = thisEfRecTrack->getAlternativeClusterMatches("cone_015");
    const std::vector<eflowTrackClusterLink*>* bestClusters_02 = thisEfRecTrack->getAlternativeClusterMatches("cone_02");
 
    //First we calculate how much energy is found in a cone of 0.15
    float totalE_015 = 0.0;
    
    //This pointer can be a nullptr if no clusters were matched to a track in dR < 0.15
    if (bestClusters_015){
      for (eflowTrackClusterLink* thisLink : *bestClusters_015){
    eflowRecCluster* thisBestCluster = thisLink->getCluster();
    if (thisBestCluster){      
      const xAOD::CaloCluster* theCluster =  thisBestCluster->getCluster();
      if (theCluster) {
        if (theCluster->e()>0.0){
          totalE_015 += theCluster->e();
        }
      }
    }
      }
    }//if vector of 0.15 clusters exists
    
    double pull_015 = NAN;
    if (expectedEnergySigma > 1e-6 ) pull_015 = (totalE_015-expectedEnergy)/expectedEnergySigma;
    thisEfRecTrack->setpull15(pull_015);
 
    double trackPt = thisEfRecTrack->getTrack()->pt();
    //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.
    if (!std::isnan(pull_015)){
      //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
      //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.
      //The specific cut values were found by optimising the jet resolutions in the run 2 data taking environment.
      //Further details can be found in these slides from C. Young:
      //https://indico.cern.ch/event/396923/contributions/949333/attachments/795878/1090871/Presentation.pdf
      if (pull_015 > 0.0 + (log10(40000)-log10(trackPt))*33.2 && 0.0 != expectedEnergySigma && bestClusters_015 && bestClusters_02){
        thisEfRecTrack->setSubtracted(); //this tricks eflowRec into thinking this track was subtracted, and hence no further subtraction will be done
        thisEfRecTrack->setIsInDenseEnvironment();
        //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)
        //we use a larger cone of 0.2 for this
        std::vector<eflowRecCluster*> theBestEfRecClusters_02;
        for (eflowTrackClusterLink* thisLink : *bestClusters_02) if (thisLink->getCluster()->getCluster()->e() > 0.0) theBestEfRecClusters_02.push_back(thisLink->getCluster());
        integrator->measureNewClus(theBestEfRecClusters_02, thisEfRecTrack);
        j1st = integrator->getFirstIntLayer();
        cellSubtractionManager.getOrdering(binnedParameters, trackE, trackEM1eta, j1st,useLegacyEnergyBinIndexing);
        thisEfRecTrack->setEExpect(cellSubtractionManager.fudgeMean() * trackE, fabs(cellSubtractionManager.fudgeStdDev()*trackE)*fabs(cellSubtractionManager.fudgeStdDev()*trackE));
      }
      else {
        thisEfRecTrack->setEExpect(expectedEnergy, expectedEnergySigma*expectedEnergySigma);
      }//ok to do subtraction, and so we just set the usual expected E + sigma of expected E needed for subtraction 
    }
  }
}

Member Data Documentation

m_eflowRecClusters

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

private

Definition at line 82 of file eflowCaloObject.h.

m_eflowRecTracks

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

private

Definition at line 92 of file eflowCaloObject.h.

m_trackClusterLinks

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

private

Definition at line 89 of file eflowCaloObject.h.

---

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

• eflowCaloObject.h
• eflowCaloObject.cxx