EgammaHcalIsolation Class Reference

#include <EgammaHcalIsolation.h>

Public Types
using	arrayHB = std::array< double, 4 >
using	arrayHE = std::array< double, 7 >
enum	InclusionRule : int { InclusionRule::withinConeAroundCluster = 0, InclusionRule::isBehindClusterSeed = 1 }

Public Member Functions
	EgammaHcalIsolation (InclusionRule extIncRule, double extRadius, InclusionRule intIncRule, double intRadius, const arrayHB &eThresHB, const arrayHB &etThresHB, int maxSeverityHB, const arrayHE &eThresHE, const arrayHE &etThresHE, int maxSeverityHE, const HBHERecHitCollection &mhbhe, edm::ESHandle< CaloGeometry > caloGeometry, edm::ESHandle< HcalTopology > hcalTopology, edm::ESHandle< HcalChannelQuality > hcalChStatus, edm::ESHandle< HcalSeverityLevelComputer > hcalSevLvlComputer, edm::ESHandle< CaloTowerConstituentsMap > towerMap)
	EgammaHcalIsolation (InclusionRule extIncRule, double extRadius, InclusionRule intIncRule, double intRadius, const arrayHB &eThresHB, const arrayHB &etThresHB, int maxSeverityHB, const arrayHE &eThresHE, const arrayHE &etThresHE, int maxSeverityHE, const HBHERecHitCollection &mhbhe, const CaloGeometry &caloGeometry, const HcalTopology &hcalTopology, const HcalChannelQuality &hcalChStatus, const HcalSeverityLevelComputer &hcalSevLvlComputer, const CaloTowerConstituentsMap &towerMap)
double	getHcalESum (const reco::Candidate *c, int depth) const
double	getHcalESum (const reco::SuperCluster *sc, int depth) const
double	getHcalESum (const math::XYZPoint &p, int depth) const
double	getHcalESum (const GlobalPoint &pclu, int depth) const
double	getHcalESumBc (const reco::Candidate *c, int depth) const
double	getHcalESumBc (const reco::SuperCluster *sc, int depth) const
double	getHcalESumBc (const math::XYZPoint &p, int depth, int ieta, int iphi, int include_or_exclude) const
double	getHcalESumBc (const GlobalPoint &pclu, int depth, int ieta, int iphi, int include_or_exclude) const
double	getHcalEtSum (const reco::Candidate *c, int depth) const
double	getHcalEtSum (const reco::SuperCluster *sc, int depth) const
double	getHcalEtSum (const math::XYZPoint &p, int depth) const
double	getHcalEtSum (const GlobalPoint &pclu, int depth) const
double	getHcalEtSumBc (const reco::Candidate *c, int depth) const
double	getHcalEtSumBc (const reco::SuperCluster *sc, int depth) const
double	getHcalEtSumBc (const math::XYZPoint &p, int depth, int ieta, int iphi, int include_or_exclude) const
double	getHcalEtSumBc (const GlobalPoint &pclu, int depth, int ieta, int iphi, int include_or_exclude) const

Private Member Functions
double	getHcalSum (const GlobalPoint &pclu, int depth, int ieta, int iphi, int include_or_exclude, double(*scale)(const double &)) const
double	goodHitEnergy (float pcluEta, float pcluPhi, const HBHERecHit &hit, int depth, int ieta, int iphi, int include_or_exclude, double(*scale)(const double &)) const

Private Attributes
const CaloGeometry &	caloGeometry_
arrayHB	eThresHB_
arrayHE	eThresHE_
arrayHB	etThresHB_
arrayHE	etThresHE_
InclusionRule	extIncRule_
double	extRadius_
const HcalChannelQuality &	hcalChStatus_
const HcalSeverityLevelComputer &	hcalSevLvlComputer_
const HcalTopology &	hcalTopology_
InclusionRule	intIncRule_
double	intRadius_
int	maxSeverityHB_
int	maxSeverityHE_
const HBHERecHitCollection &	mhbhe_
const CaloTowerConstituentsMap &	towerMap_

Detailed Description

Definition at line 38 of file EgammaHcalIsolation.h.

Member Typedef Documentation

arrayHB

using EgammaHcalIsolation::arrayHB = std::array<double, 4>

Definition at line 41 of file EgammaHcalIsolation.h.

arrayHE

using EgammaHcalIsolation::arrayHE = std::array<double, 7>

Definition at line 42 of file EgammaHcalIsolation.h.

Member Enumeration Documentation

InclusionRule

enum EgammaHcalIsolation::InclusionRule : int

strong

Enumerator
withinConeAroundCluster
isBehindClusterSeed

Definition at line 40 of file EgammaHcalIsolation.h.

: int { withinConeAroundCluster = 0, isBehindClusterSeed = 1 };

Constructor & Destructor Documentation

EgammaHcalIsolation() [1/2]

EgammaHcalIsolation::EgammaHcalIsolation	(	InclusionRule	extIncRule,
		double	extRadius,
		InclusionRule	intIncRule,
		double	intRadius,
		const arrayHB &	eThresHB,
		const arrayHB &	etThresHB,
		int	maxSeverityHB,
		const arrayHE &	eThresHE,
		const arrayHE &	etThresHE,
		int	maxSeverityHE,
		const HBHERecHitCollection &	mhbhe,
		edm::ESHandle< CaloGeometry >	caloGeometry,
		edm::ESHandle< HcalTopology >	hcalTopology,
		edm::ESHandle< HcalChannelQuality >	hcalChStatus,
		edm::ESHandle< HcalSeverityLevelComputer >	hcalSevLvlComputer,
		edm::ESHandle< CaloTowerConstituentsMap >	towerMap
	)

EgammaHcalIsolation() [2/2]

EgammaHcalIsolation::EgammaHcalIsolation	(	InclusionRule	extIncRule,
		double	extRadius,
		InclusionRule	intIncRule,
		double	intRadius,
		const arrayHB &	eThresHB,
		const arrayHB &	etThresHB,
		int	maxSeverityHB,
		const arrayHE &	eThresHE,
		const arrayHE &	etThresHE,
		int	maxSeverityHE,
		const HBHERecHitCollection &	mhbhe,
		const CaloGeometry &	caloGeometry,
		const HcalTopology &	hcalTopology,
		const HcalChannelQuality &	hcalChStatus,
		const HcalSeverityLevelComputer &	hcalSevLvlComputer,
		const CaloTowerConstituentsMap &	towerMap
	)

Member Function Documentation

getHcalESum() [1/4]

double EgammaHcalIsolation::getHcalESum ( const reco::Candidate *  c, int  depth  ) const

inline

Definition at line 79 of file EgammaHcalIsolation.h.

References HltBtagPostValidation_cff::c, hcalRecHitTable_cff::depth, and edm::Ref< C, T, F >::get().

Referenced by getHcalESum(), and EgammaHLTHcalVarProducerFromRecHit::produce().

                                                              {
    return getHcalESum(c->get<reco::SuperClusterRef>().get(), depth);
  }

getHcalESum() [2/4]

double EgammaHcalIsolation::getHcalESum ( const reco::SuperCluster *  sc, int  depth  ) const

inline

Definition at line 85 of file EgammaHcalIsolation.h.

References hcalRecHitTable_cff::depth, getHcalESum(), and reco::CaloCluster::position().

Referenced by getHcalESum().

{ return getHcalESum(sc->position(), depth); }

getHcalESum() [3/4]

double EgammaHcalIsolation::getHcalESum ( const math::XYZPoint &  p, int  depth  ) const

inline

Definition at line 87 of file EgammaHcalIsolation.h.

References hcalRecHitTable_cff::depth, getHcalESum(), and AlCaHLTBitMon_ParallelJobs::p.

                                                             {
    return getHcalESum(GlobalPoint(p.x(), p.y(), p.z()), depth);
  }

getHcalESum() [4/4]

double EgammaHcalIsolation::getHcalESum ( const GlobalPoint &  pclu, int  depth  ) const

inline

Definition at line 93 of file EgammaHcalIsolation.h.

References hcalRecHitTable_cff::depth, getHcalSum(), and scaleToE().

{ return getHcalSum(pclu, depth, 0, 0, 0, &scaleToE); }

getHcalESumBc() [1/4]

double EgammaHcalIsolation::getHcalESumBc ( const reco::Candidate *  c, int  depth  ) const

inline

Definition at line 96 of file EgammaHcalIsolation.h.

References HltBtagPostValidation_cff::c, hcalRecHitTable_cff::depth, and edm::Ref< C, T, F >::get().

Referenced by getHcalESumBc(), and EgammaHLTHcalVarProducerFromRecHit::produce().

                                                                {
    return getHcalESumBc(c->get<reco::SuperClusterRef>().get(), depth);
  }

getHcalESumBc() [2/4]

double EgammaHcalIsolation::getHcalESumBc ( const reco::SuperCluster *  sc, int  depth  ) const

inline

Definition at line 102 of file EgammaHcalIsolation.h.

References hcalRecHitTable_cff::depth, extIncRule_, getHcalESumBc(), intIncRule_, isBehindClusterSeed, reco::CaloCluster::position(), reco::SuperCluster::seed(), l1tHGCalTowerProducer_cfi::tower, towerMap_, egamma::towerOf(), and withinConeAroundCluster.

                                                                    {
    const auto tower = egamma::towerOf(*(sc->seed()), towerMap_);

    if (extIncRule_ == InclusionRule::isBehindClusterSeed and intIncRule_ == InclusionRule::withinConeAroundCluster)
      return getHcalESumBc(sc->position(), depth, tower.ieta(), tower.iphi(), -1);
    else if (extIncRule_ == InclusionRule::withinConeAroundCluster and
             intIncRule_ == InclusionRule::isBehindClusterSeed)
      return getHcalESumBc(sc->position(), depth, tower.ieta(), tower.iphi(), 1);

    return getHcalESumBc(sc->position(), depth, tower.ieta(), tower.iphi(), 0);
  }

getHcalESumBc() [3/4]

double EgammaHcalIsolation::getHcalESumBc ( const math::XYZPoint &  p, int  depth, int  ieta, int  iphi, int  include_or_exclude  ) const

inline

Definition at line 124 of file EgammaHcalIsolation.h.

References hcalRecHitTable_cff::depth, getHcalESumBc(), hcalRecHitTable_cff::ieta, hcalRecHitTable_cff::iphi, and AlCaHLTBitMon_ParallelJobs::p.

                                                                                                           {
    return getHcalESumBc(GlobalPoint(p.x(), p.y(), p.z()), depth, ieta, iphi, include_or_exclude);
  }

getHcalESumBc() [4/4]

double EgammaHcalIsolation::getHcalESumBc ( const GlobalPoint &  pclu, int  depth, int  ieta, int  iphi, int  include_or_exclude  ) const

inline

Definition at line 130 of file EgammaHcalIsolation.h.

References hcalRecHitTable_cff::depth, getHcalSum(), hcalRecHitTable_cff::ieta, hcalRecHitTable_cff::iphi, and scaleToE().

                                                                                                             {
    return getHcalSum(pclu, depth, ieta, iphi, include_or_exclude, &scaleToE);
  }

getHcalEtSum() [1/4]

double EgammaHcalIsolation::getHcalEtSum ( const reco::Candidate *  c, int  depth  ) const

inline

Definition at line 82 of file EgammaHcalIsolation.h.

References HltBtagPostValidation_cff::c, hcalRecHitTable_cff::depth, and edm::Ref< C, T, F >::get().

Referenced by GsfElectronAlgo::createElectron(), getHcalEtSum(), and EgammaHLTHcalVarProducerFromRecHit::produce().

                                                               {
    return getHcalEtSum(c->get<reco::SuperClusterRef>().get(), depth);
  }

getHcalEtSum() [2/4]

double EgammaHcalIsolation::getHcalEtSum ( const reco::SuperCluster *  sc, int  depth  ) const

inline

Definition at line 86 of file EgammaHcalIsolation.h.

References hcalRecHitTable_cff::depth, getHcalEtSum(), and reco::CaloCluster::position().

Referenced by getHcalEtSum().

{ return getHcalEtSum(sc->position(), depth); }

getHcalEtSum() [3/4]

double EgammaHcalIsolation::getHcalEtSum ( const math::XYZPoint &  p, int  depth  ) const

inline

Definition at line 90 of file EgammaHcalIsolation.h.

References hcalRecHitTable_cff::depth, getHcalEtSum(), and AlCaHLTBitMon_ParallelJobs::p.

                                                              {
    return getHcalEtSum(GlobalPoint(p.x(), p.y(), p.z()), depth);
  }

getHcalEtSum() [4/4]

double EgammaHcalIsolation::getHcalEtSum ( const GlobalPoint &  pclu, int  depth  ) const

inline

Definition at line 94 of file EgammaHcalIsolation.h.

References hcalRecHitTable_cff::depth, getHcalSum(), and scaleToEt().

{ return getHcalSum(pclu, depth, 0, 0, 0, &scaleToEt); }

getHcalEtSumBc() [1/4]

double EgammaHcalIsolation::getHcalEtSumBc ( const reco::Candidate *  c, int  depth  ) const

inline

Definition at line 99 of file EgammaHcalIsolation.h.

References HltBtagPostValidation_cff::c, hcalRecHitTable_cff::depth, and edm::Ref< C, T, F >::get().

Referenced by GsfElectronAlgo::createElectron(), getHcalEtSumBc(), and EgammaHLTHcalVarProducerFromRecHit::produce().

                                                                 {
    return getHcalEtSumBc(c->get<reco::SuperClusterRef>().get(), depth);
  }

getHcalEtSumBc() [2/4]

double EgammaHcalIsolation::getHcalEtSumBc ( const reco::SuperCluster *  sc, int  depth  ) const

inline

Definition at line 113 of file EgammaHcalIsolation.h.

References hcalRecHitTable_cff::depth, extIncRule_, getHcalEtSumBc(), intIncRule_, isBehindClusterSeed, reco::CaloCluster::position(), reco::SuperCluster::seed(), l1tHGCalTowerProducer_cfi::tower, towerMap_, egamma::towerOf(), and withinConeAroundCluster.

                                                                     {
    const auto tower = egamma::towerOf(*(sc->seed()), towerMap_);

    if (extIncRule_ == InclusionRule::isBehindClusterSeed and intIncRule_ == InclusionRule::withinConeAroundCluster)
      return getHcalEtSumBc(sc->position(), depth, tower.ieta(), tower.iphi(), -1);
    else if (extIncRule_ == InclusionRule::withinConeAroundCluster and
             intIncRule_ == InclusionRule::isBehindClusterSeed)
      return getHcalEtSumBc(sc->position(), depth, tower.ieta(), tower.iphi(), 1);

    return getHcalEtSumBc(sc->position(), depth, tower.ieta(), tower.iphi(), 0);
  }

getHcalEtSumBc() [3/4]

double EgammaHcalIsolation::getHcalEtSumBc ( const math::XYZPoint &  p, int  depth, int  ieta, int  iphi, int  include_or_exclude  ) const

inline

Definition at line 127 of file EgammaHcalIsolation.h.

References hcalRecHitTable_cff::depth, getHcalEtSumBc(), hcalRecHitTable_cff::ieta, hcalRecHitTable_cff::iphi, and AlCaHLTBitMon_ParallelJobs::p.

                                                                                                            {
    return getHcalEtSumBc(GlobalPoint(p.x(), p.y(), p.z()), depth, ieta, iphi, include_or_exclude);
  }

getHcalEtSumBc() [4/4]

double EgammaHcalIsolation::getHcalEtSumBc ( const GlobalPoint &  pclu, int  depth, int  ieta, int  iphi, int  include_or_exclude  ) const

inline

Definition at line 133 of file EgammaHcalIsolation.h.

References hcalRecHitTable_cff::depth, getHcalSum(), hcalRecHitTable_cff::ieta, hcalRecHitTable_cff::iphi, and scaleToEt().

                                                                                                              {
    return getHcalSum(pclu, depth, ieta, iphi, include_or_exclude, &scaleToEt);
  }

getHcalSum()

double EgammaHcalIsolation::getHcalSum ( const GlobalPoint &  pclu, int  depth, int  ieta, int  iphi, int  include_or_exclude, double(*)(const double &)  scale  ) const

private

Definition at line 180 of file EgammaHcalIsolation.cc.

References hcalRecHitTable_cff::depth, PV3DBase< T, PVType, FrameType >::eta(), goodHitEnergy(), hcalRecHitTable_cff::ieta, hcalRecHitTable_cff::iphi, mhbhe_, PV3DBase< T, PVType, FrameType >::phi(), and pfClustersFromCombinedCaloHF_cfi::scale.

Referenced by getHcalESum(), getHcalESumBc(), getHcalEtSum(), and getHcalEtSumBc().

                                                                              {
  double sum = 0.;
  const float pcluEta = pclu.eta();
  const float pcluPhi = pclu.phi();
  for (const auto &hit : mhbhe_)
    sum += goodHitEnergy(pcluEta, pcluPhi, hit, depth, ieta, iphi, include_or_exclude, scale);

  return sum;
}

goodHitEnergy()

double EgammaHcalIsolation::goodHitEnergy ( float  pcluEta, float  pcluPhi, const HBHERecHit &  hit, int  depth, int  ieta, int  iphi, int  include_or_exclude, double(*)(const double &)  scale  ) const

private

Definition at line 122 of file EgammaHcalIsolation.cc.

References caloGeometry_, HLTMuonOfflineAnalyzer_cfi::deltaR2, hcalRecHitTable_cff::depth, HcalDetId::depth(), eThresHB_, eThresHE_, etThresHB_, etThresHE_, extIncRule_, extRadius_, RemoveAddSevLevel::flag, CaloGeometry::getGeometry(), HcalSeverityLevelComputer::getSeverityLevel(), HcalChannelStatus::getValue(), HcalCondObjectContainer< Item >::getValues(), HcalBarrel, hcalChStatus_, HcalEndcap, hcalSevLvlComputer_, hcalTopology_, hcalSimParameters_cfi::he, trackingPlots::hp, HcalTopology::idFront(), hcalRecHitTable_cff::ieta, intIncRule_, intRadius_, hcalRecHitTable_cff::iphi, maxSeverityHB_, maxSeverityHE_, or, HcalSeverityLevelComputer::recoveredRecHit(), pfClustersFromCombinedCaloHF_cfi::scale, scaleToEt(), ErrorSummaryFilter_cfi::severity, and withinConeAroundCluster.

Referenced by getHcalSum().

                                                                                 {
  const HcalDetId hid(hit.detid());
  const int hd = hid.depth(), he = hid.ieta(), hp = hid.iphi();
  const int h1 = hd - 1;

  if (include_or_exclude == -1 and (he != ieta or hp != iphi))
    return 0.;

  if (include_or_exclude == 1 and (he == ieta and hp == iphi))
    return 0.;

  if ((hid.subdet() == HcalBarrel and (hd < 1 or hd > int(eThresHB_.size()))) or
      (hid.subdet() == HcalEndcap and (hd < 1 or hd > int(eThresHE_.size()))))
    edm::LogWarning("EgammaHcalIsolation")
        << " hit in subdet " << hid.subdet() << " has an unaccounted for depth of " << hd << "!!";

  const bool right_depth = (depth == 0 or hd == depth);
  if (!right_depth)
    return 0.;

  const bool goodHBe = hid.subdet() == HcalBarrel and hit.energy() > eThresHB_[h1];
  const bool goodHEe = hid.subdet() == HcalEndcap and hit.energy() > eThresHE_[h1];
  if (!(goodHBe or goodHEe))
    return 0.;

  const auto phit = caloGeometry_.getGeometry(hit.detid())->repPos();
  const float phitEta = phit.eta();

  if (extIncRule_ == InclusionRule::withinConeAroundCluster or intIncRule_ == InclusionRule::withinConeAroundCluster) {
    auto const dR2 = deltaR2(pcluEta, pcluPhi, phitEta, phit.phi());
    if ((extIncRule_ == InclusionRule::withinConeAroundCluster and dR2 > extRadius_) or
        (intIncRule_ == InclusionRule::withinConeAroundCluster and dR2 < intRadius_))
      return 0.;
  }

  DetId did = hcalTopology_.idFront(hid);
  const uint32_t flag = hit.flags();
  const uint32_t dbflag = hcalChStatus_.getValues(did)->getValue();
  int severity = hcalSevLvlComputer_.getSeverityLevel(did, flag, dbflag);
  bool recovered = hcalSevLvlComputer_.recoveredRecHit(did, flag);

  const double het = hit.energy() * scaleToEt(phitEta);
  const bool goodHB = goodHBe and (severity <= maxSeverityHB_ or recovered) and het > etThresHB_[h1];
  const bool goodHE = goodHEe and (severity <= maxSeverityHE_ or recovered) and het > etThresHE_[h1];

  if (goodHB or goodHE)
    return hit.energy() * scale(phitEta);

  return 0.;
}

Member Data Documentation

caloGeometry_

const CaloGeometry& EgammaHcalIsolation::caloGeometry_

private

Definition at line 168 of file EgammaHcalIsolation.h.

Referenced by goodHitEnergy().

eThresHB_

arrayHB EgammaHcalIsolation::eThresHB_

private

Definition at line 159 of file EgammaHcalIsolation.h.

Referenced by goodHitEnergy().

eThresHE_

arrayHE EgammaHcalIsolation::eThresHE_

private

Definition at line 163 of file EgammaHcalIsolation.h.

Referenced by goodHitEnergy().

etThresHB_

arrayHB EgammaHcalIsolation::etThresHB_

private

Definition at line 160 of file EgammaHcalIsolation.h.

Referenced by goodHitEnergy().

etThresHE_

arrayHE EgammaHcalIsolation::etThresHE_

private

Definition at line 164 of file EgammaHcalIsolation.h.

Referenced by goodHitEnergy().

extIncRule_

InclusionRule EgammaHcalIsolation::extIncRule_

private

Definition at line 154 of file EgammaHcalIsolation.h.

Referenced by getHcalESumBc(), getHcalEtSumBc(), and goodHitEnergy().

extRadius_

double EgammaHcalIsolation::extRadius_

private

Definition at line 155 of file EgammaHcalIsolation.h.

Referenced by goodHitEnergy().

hcalChStatus_

const HcalChannelQuality& EgammaHcalIsolation::hcalChStatus_

private

Definition at line 170 of file EgammaHcalIsolation.h.

Referenced by goodHitEnergy().

hcalSevLvlComputer_

const HcalSeverityLevelComputer& EgammaHcalIsolation::hcalSevLvlComputer_

private

Definition at line 171 of file EgammaHcalIsolation.h.

Referenced by goodHitEnergy().

hcalTopology_

const HcalTopology& EgammaHcalIsolation::hcalTopology_

private

Definition at line 169 of file EgammaHcalIsolation.h.

Referenced by goodHitEnergy().

intIncRule_

InclusionRule EgammaHcalIsolation::intIncRule_

private

Definition at line 156 of file EgammaHcalIsolation.h.

Referenced by getHcalESumBc(), getHcalEtSumBc(), and goodHitEnergy().

intRadius_

double EgammaHcalIsolation::intRadius_

private

Definition at line 157 of file EgammaHcalIsolation.h.

Referenced by goodHitEnergy().

maxSeverityHB_

int EgammaHcalIsolation::maxSeverityHB_

private

Definition at line 161 of file EgammaHcalIsolation.h.

Referenced by goodHitEnergy().

maxSeverityHE_

int EgammaHcalIsolation::maxSeverityHE_

private

Definition at line 165 of file EgammaHcalIsolation.h.

Referenced by goodHitEnergy().

mhbhe_

const HBHERecHitCollection& EgammaHcalIsolation::mhbhe_

private

Definition at line 167 of file EgammaHcalIsolation.h.

Referenced by getHcalSum().

towerMap_

const CaloTowerConstituentsMap& EgammaHcalIsolation::towerMap_

private

Definition at line 172 of file EgammaHcalIsolation.h.

Referenced by getHcalESumBc(), and getHcalEtSumBc().