CMS 3D CMS Logo

List of all members | Public Member Functions | Private Member Functions | Private Attributes
ECAL2DPositionCalcWithDepthCorr Class Reference

This is EGM version of the ECAL position + depth correction calculation. More...

Inheritance diagram for ECAL2DPositionCalcWithDepthCorr:
PFCPositionCalculatorBase

Public Member Functions

void calculateAndSetPosition (reco::PFCluster &, const HcalPFCuts *) override
 
void calculateAndSetPositions (reco::PFClusterCollection &, const HcalPFCuts *) override
 
 ECAL2DPositionCalcWithDepthCorr (const edm::ParameterSet &conf, edm::ConsumesCollector &cc)
 
 ECAL2DPositionCalcWithDepthCorr (const ECAL2DPositionCalcWithDepthCorr &)=delete
 
ECAL2DPositionCalcWithDepthCorroperator= (const ECAL2DPositionCalcWithDepthCorr &)=delete
 
void update (const edm::EventSetup &es) override
 
- Public Member Functions inherited from PFCPositionCalculatorBase
const std::string & name () const
 
PosCalcoperator= (const PosCalc &)=delete
 
 PFCPositionCalculatorBase (const edm::ParameterSet &conf, edm::ConsumesCollector &cc)
 
 PFCPositionCalculatorBase (const PosCalc &)=delete
 
virtual ~PFCPositionCalculatorBase ()=default
 

Private Member Functions

void calculateAndSetPositionActual (reco::PFCluster &) const
 

Private Attributes

const CaloSubdetectorGeometry_ebGeom
 
const CaloSubdetectorGeometry_eeGeom
 
const CaloSubdetectorGeometry_esGeom
 
bool _esMinus
 
bool _esPlus
 
edm::ESGetToken< CaloGeometry, CaloGeometryRecord_geomToken
 
const double _minAllowedNorm
 
const double _param_T0_EB
 
const double _param_T0_EE
 
const double _param_T0_ES
 
const double _param_W0
 
const double _param_X0
 
std::unique_ptr< CaloRecHitResolutionProvider_timeResolutionCalc
 

Additional Inherited Members

- Protected Attributes inherited from PFCPositionCalculatorBase
const float _minFractionInCalc
 

Detailed Description

This is EGM version of the ECAL position + depth correction calculation.

Definition at line 24 of file ECAL2DPositionCalcWithDepthCorr.cc.

Constructor & Destructor Documentation

◆ ECAL2DPositionCalcWithDepthCorr() [1/2]

ECAL2DPositionCalcWithDepthCorr::ECAL2DPositionCalcWithDepthCorr ( const edm::ParameterSet conf,
edm::ConsumesCollector cc 
)
inline

Definition at line 26 of file ECAL2DPositionCalcWithDepthCorr.cc.

References _timeResolutionCalc, edm::ParameterSet::exists(), and edm::ParameterSet::getParameterSet().

28  _param_T0_EB(conf.getParameter<double>("T0_EB")),
29  _param_T0_EE(conf.getParameter<double>("T0_EE")),
30  _param_T0_ES(conf.getParameter<double>("T0_ES")),
31  _param_W0(conf.getParameter<double>("W0")),
32  _param_X0(conf.getParameter<double>("X0")),
33  _minAllowedNorm(conf.getParameter<double>("minAllowedNormalization")),
34  _ebGeom(nullptr),
35  _eeGeom(nullptr),
36  _esGeom(nullptr),
37  _esPlus(false),
38  _esMinus(false),
39  _geomToken(cc.esConsumes<edm::Transition::BeginRun>()) {
40  _timeResolutionCalc.reset(nullptr);
41  if (conf.exists("timeResolutionCalc")) {
42  const edm::ParameterSet& timeResConf = conf.getParameterSet("timeResolutionCalc");
43  _timeResolutionCalc = std::make_unique<CaloRecHitResolutionProvider>(timeResConf);
44  }
45  }
PFCPositionCalculatorBase(const edm::ParameterSet &conf, edm::ConsumesCollector &cc)
T getParameter(std::string const &) const
Definition: ParameterSet.h:307
uint32_t cc[maxCellsPerHit]
Definition: gpuFishbone.h:49
bool exists(std::string const &parameterName) const
checks if a parameter exists
ParameterSet const & getParameterSet(std::string const &) const
std::unique_ptr< CaloRecHitResolutionProvider > _timeResolutionCalc
edm::ESGetToken< CaloGeometry, CaloGeometryRecord > _geomToken

◆ ECAL2DPositionCalcWithDepthCorr() [2/2]

ECAL2DPositionCalcWithDepthCorr::ECAL2DPositionCalcWithDepthCorr ( const ECAL2DPositionCalcWithDepthCorr )
delete

Member Function Documentation

◆ calculateAndSetPosition()

void ECAL2DPositionCalcWithDepthCorr::calculateAndSetPosition ( reco::PFCluster cluster,
const HcalPFCuts  
)
overridevirtual

Implements PFCPositionCalculatorBase.

Definition at line 95 of file ECAL2DPositionCalcWithDepthCorr.cc.

References calculateAndSetPositionActual().

95  {
97 }
void calculateAndSetPositionActual(reco::PFCluster &) const

◆ calculateAndSetPositionActual()

void ECAL2DPositionCalcWithDepthCorr::calculateAndSetPositionActual ( reco::PFCluster cluster) const
private

Definition at line 105 of file ECAL2DPositionCalcWithDepthCorr.cc.

References _ebGeom, _eeGeom, _esMinus, _esPlus, _minAllowedNorm, _param_T0_EB, _param_T0_EE, _param_T0_ES, _param_W0, _param_X0, _timeResolutionCalc, funct::abs(), reco::PFCluster::calculatePositionREP(), ALPAKA_ACCELERATOR_NAMESPACE::brokenline::constexpr(), hcalRecHitTable_cff::depth, PFLayer::ECAL_BARREL, PFLayer::ECAL_ENDCAP, reco::PFCluster::energy(), Exception, f, nano_mu_digi_cff::float, CaloSubdetectorGeometry::getGeometry(), edm::isFinite(), SiStripPI::max, HLT_2024v10_cff::maxDepth, PFLayer::NONE, reco::PFCluster::recHitFractions(), reco::CaloCluster::seed(), reco::CaloCluster::setEnergy(), reco::PFCluster::setLayer(), reco::CaloCluster::setPosition(), reco::PFCluster::setTime(), reco::PFCluster::setTimeError(), mathSSE::sqrt(), mps_merge::weight, x, y, and z.

Referenced by calculateAndSetPosition(), and calculateAndSetPositions().

105  {
106  constexpr double preshowerStartEta = 1.653;
107  constexpr double preshowerEndEta = 2.6;
108  if (!cluster.seed()) {
109  throw cms::Exception("ClusterWithNoSeed") << " Found a cluster with no seed: " << cluster;
110  }
111  double cl_energy = 0;
112  double cl_energy_float = 0;
113  double cl_time = 0;
114  double cl_timeweight = 0.0;
115  double max_e = 0.0;
116  double clusterT0 = 0.0;
117  PFLayer::Layer max_e_layer = PFLayer::NONE;
118  reco::PFRecHitRef refmax;
119  // find the seed and max layer
120  for (const reco::PFRecHitFraction& rhf : cluster.recHitFractions()) {
121  const reco::PFRecHitRef& refhit = rhf.recHitRef();
122  const double rh_fraction = rhf.fraction();
123  const double rh_rawenergy = refhit->energy();
124  const double rh_energy = rh_rawenergy * rh_fraction;
125  const double rh_energyf = ((float)rh_rawenergy) * ((float)rh_fraction);
126  if (!edm::isFinite(rh_energy)) {
127  throw cms::Exception("PFClusterAlgo") << "rechit " << refhit->detId() << " has non-finite energy... "
128  << "The input of the particle flow clustering seems to be corrupted.";
129  }
130  cl_energy += rh_energy;
131  cl_energy_float += rh_energyf;
132  // If time resolution is given, calculate weighted average
133  if (_timeResolutionCalc) {
134  const double res2 = 1. / _timeResolutionCalc->timeResolution2(rh_rawenergy);
135  cl_time += rh_fraction * refhit->time() * res2;
136  cl_timeweight += rh_fraction * res2;
137  } else { // assume resolution ~ 1/E**2
138  const double rh_rawenergy2 = rh_rawenergy * rh_rawenergy;
139  cl_timeweight += rh_rawenergy2 * rh_fraction;
140  cl_time += rh_rawenergy2 * rh_fraction * refhit->time();
141  }
142  if (rh_energy > max_e) {
143  max_e = rh_energy;
144  max_e_layer = rhf.recHitRef()->layer();
145  refmax = refhit;
146  }
147  }
148  cluster.setEnergy(cl_energy);
149  cluster.setTime(cl_time / cl_timeweight);
150  if (_timeResolutionCalc) {
151  cluster.setTimeError(std::sqrt(1.0f / float(cl_timeweight)));
152  }
153  cluster.setLayer(max_e_layer);
154  const CaloSubdetectorGeometry* ecal_geom = nullptr;
155  // get seed geometry information
156  switch (max_e_layer) {
158  ecal_geom = _ebGeom;
159  clusterT0 = _param_T0_EB;
160  break;
162  ecal_geom = _eeGeom;
163  clusterT0 = _param_T0_EE;
164  break;
165  default:
166  throw cms::Exception("InvalidLayer") << "ECAL Position Calc only accepts ECAL_BARREL or ECAL_ENDCAP";
167  }
168 
169  auto center_cell = ecal_geom->getGeometry(refmax->detId());
170  const double ctreta = center_cell->etaPos();
171  const double actreta = std::abs(ctreta);
172  // need to change T0 if in ES
173  if (actreta > preshowerStartEta && actreta < preshowerEndEta) {
174  if (ctreta > 0 && _esPlus)
175  clusterT0 = _param_T0_ES;
176  if (ctreta < 0 && _esMinus)
177  clusterT0 = _param_T0_ES;
178  }
179  // floats to reproduce exactly the EGM code
180  const float maxDepth = _param_X0 * (clusterT0 + vdt::fast_log(cl_energy_float));
181  const float maxToFront = center_cell->getPosition().mag();
182  // calculate the position
183  const double logETot_inv = -vdt::fast_log(cl_energy_float);
184  double position_norm = 0.0;
185  double x(0.0), y(0.0), z(0.0);
186  for (const reco::PFRecHitFraction& rhf : cluster.recHitFractions()) {
187  double weight = 0.0;
188  const reco::PFRecHitRef& refhit = rhf.recHitRef();
189  const double rh_energy = ((float)refhit->energy()) * ((float)rhf.fraction());
190  if (rh_energy > 0.0)
191  weight = std::max(0.0, (_param_W0 + vdt::fast_log(rh_energy) + logETot_inv));
192  auto cell = ecal_geom->getGeometry(refhit->detId());
193  const float depth = maxDepth + maxToFront - cell->getPosition().mag();
194  const GlobalPoint pos = static_cast<const TruncatedPyramid*>(cell.get())->getPosition(depth);
195 
196  x += weight * pos.x();
197  y += weight * pos.y();
198  z += weight * pos.z();
199 
200  position_norm += weight;
201  }
202 
203  // FALL BACK to LINEAR WEIGHTS
204  if (position_norm == 0.) {
205  for (const reco::PFRecHitFraction& rhf : cluster.recHitFractions()) {
206  double weight = 0.0;
207  const reco::PFRecHitRef& refhit = rhf.recHitRef();
208  const double rh_energy = ((float)refhit->energy()) * ((float)rhf.fraction());
209  if (rh_energy > 0.0)
210  weight = rh_energy / cluster.energy();
211 
212  auto cell = ecal_geom->getGeometry(refhit->detId());
213  const float depth = maxDepth + maxToFront - cell->getPosition().mag();
214  const GlobalPoint pos = cell->getPosition(depth);
215 
216  x += weight * pos.x();
217  y += weight * pos.y();
218  z += weight * pos.z();
219 
220  position_norm += weight;
221  }
222  }
223 
224  if (position_norm < _minAllowedNorm) {
225  edm::LogError("WeirdClusterNormalization") << "PFCluster too far from seeding cell: set position to (0,0,0).";
226  cluster.setPosition(math::XYZPoint(0, 0, 0));
227  } else {
228  const double norm_inverse = 1.0 / position_norm;
229  x *= norm_inverse;
230  y *= norm_inverse;
231  z *= norm_inverse;
232 
233  cluster.setPosition(math::XYZPoint(x, y, z));
234  cluster.calculatePositionREP();
235  }
236 }
void setLayer(PFLayer::Layer layer)
set layer
Definition: PFCluster.cc:49
void setPosition(const math::XYZPoint &p)
Definition: CaloCluster.h:139
DetId seed() const
return DetId of seed
Definition: CaloCluster.h:218
void setTime(float time, float timeError=0)
Definition: PFCluster.h:84
Fraction of a PFRecHit (rechits can be shared between several PFCluster&#39;s)
std::unique_ptr< CaloRecHitResolutionProvider > _timeResolutionCalc
const std::vector< reco::PFRecHitFraction > & recHitFractions() const
vector of rechit fractions
Definition: PFCluster.h:65
void setEnergy(double energy)
Definition: CaloCluster.h:135
Definition: weight.py:1
Log< level::Error, false > LogError
constexpr bool isFinite(T x)
void calculatePositionREP()
computes posrep_ once and for all
Definition: PFCluster.h:95
T sqrt(T t)
Definition: SSEVec.h:19
double energy() const
cluster energy
Definition: PFCluster.h:74
Abs< T >::type abs(const T &t)
Definition: Abs.h:22
double f[11][100]
virtual std::shared_ptr< const CaloCellGeometry > getGeometry(const DetId &id) const
Get the cell geometry of a given detector id. Should return false if not found.
Layer
layer definition
Definition: PFLayer.h:29
void setTimeError(float timeError)
Definition: PFCluster.h:88
XYZPointD XYZPoint
point in space with cartesian internal representation
Definition: Point3D.h:12
A base class to handle the particular shape of Ecal Xtals. Taken from ORCA Calorimetry Code...

◆ calculateAndSetPositions()

void ECAL2DPositionCalcWithDepthCorr::calculateAndSetPositions ( reco::PFClusterCollection clusters,
const HcalPFCuts  
)
overridevirtual

Implements PFCPositionCalculatorBase.

Definition at line 99 of file ECAL2DPositionCalcWithDepthCorr.cc.

References calculateAndSetPositionActual(), and bsc_activity_cfg::clusters.

99  {
100  for (reco::PFCluster& cluster : clusters) {
102  }
103 }
Particle flow cluster, see clustering algorithm in PFClusterAlgo.
Definition: PFCluster.h:42
void calculateAndSetPositionActual(reco::PFCluster &) const

◆ operator=()

ECAL2DPositionCalcWithDepthCorr& ECAL2DPositionCalcWithDepthCorr::operator= ( const ECAL2DPositionCalcWithDepthCorr )
delete

◆ update()

void ECAL2DPositionCalcWithDepthCorr::update ( const edm::EventSetup es)
overridevirtual

Reimplemented from PFCPositionCalculatorBase.

Definition at line 80 of file ECAL2DPositionCalcWithDepthCorr.cc.

References _ebGeom, _eeGeom, _esGeom, _esMinus, _esPlus, _geomToken, DetId::Ecal, EcalBarrel, EcalEndcap, EcalPreshower, CaloSubdetectorGeometry::getGeometry(), edm::EventSetup::getHandle(), CaloGeometry::getSubdetectorGeometry(), CaloSubdetectorGeometry::getValidDetIds(), and z.

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), progressbar.ProgressBar::finish(), and MatrixUtil.Steps::overwrite().

80  {
85  if (_esGeom) {
86  // ripped from RecoEcal/EgammaCoreTools
87  for (uint32_t ic = 0; ic < _esGeom->getValidDetIds().size() && (!_esPlus || !_esMinus); ++ic) {
88  const double z = _esGeom->getGeometry(_esGeom->getValidDetIds()[ic])->getPosition().z();
89  _esPlus = _esPlus || (0 < z);
90  _esMinus = _esMinus || (0 > z);
91  }
92  }
93 }
edm::ESGetToken< CaloGeometry, CaloGeometryRecord > _geomToken
virtual const std::vector< DetId > & getValidDetIds(DetId::Detector det=DetId::Detector(0), int subdet=0) const
Get a list of valid detector ids (for the given subdetector)
ESHandle< T > getHandle(const ESGetToken< T, R > &iToken) const
Definition: EventSetup.h:130
virtual std::shared_ptr< const CaloCellGeometry > getGeometry(const DetId &id) const
Get the cell geometry of a given detector id. Should return false if not found.
const CaloSubdetectorGeometry * getSubdetectorGeometry(const DetId &id) const
access the subdetector geometry for the given subdetector directly
Definition: CaloGeometry.cc:34

Member Data Documentation

◆ _ebGeom

const CaloSubdetectorGeometry* ECAL2DPositionCalcWithDepthCorr::_ebGeom
private

Definition at line 63 of file ECAL2DPositionCalcWithDepthCorr.cc.

Referenced by calculateAndSetPositionActual(), and update().

◆ _eeGeom

const CaloSubdetectorGeometry* ECAL2DPositionCalcWithDepthCorr::_eeGeom
private

Definition at line 64 of file ECAL2DPositionCalcWithDepthCorr.cc.

Referenced by calculateAndSetPositionActual(), and update().

◆ _esGeom

const CaloSubdetectorGeometry* ECAL2DPositionCalcWithDepthCorr::_esGeom
private

Definition at line 65 of file ECAL2DPositionCalcWithDepthCorr.cc.

Referenced by update().

◆ _esMinus

bool ECAL2DPositionCalcWithDepthCorr::_esMinus
private

Definition at line 66 of file ECAL2DPositionCalcWithDepthCorr.cc.

Referenced by calculateAndSetPositionActual(), and update().

◆ _esPlus

bool ECAL2DPositionCalcWithDepthCorr::_esPlus
private

Definition at line 66 of file ECAL2DPositionCalcWithDepthCorr.cc.

Referenced by calculateAndSetPositionActual(), and update().

◆ _geomToken

edm::ESGetToken<CaloGeometry, CaloGeometryRecord> ECAL2DPositionCalcWithDepthCorr::_geomToken
private

Definition at line 72 of file ECAL2DPositionCalcWithDepthCorr.cc.

Referenced by update().

◆ _minAllowedNorm

const double ECAL2DPositionCalcWithDepthCorr::_minAllowedNorm
private

Definition at line 60 of file ECAL2DPositionCalcWithDepthCorr.cc.

Referenced by calculateAndSetPositionActual().

◆ _param_T0_EB

const double ECAL2DPositionCalcWithDepthCorr::_param_T0_EB
private

Definition at line 55 of file ECAL2DPositionCalcWithDepthCorr.cc.

Referenced by calculateAndSetPositionActual().

◆ _param_T0_EE

const double ECAL2DPositionCalcWithDepthCorr::_param_T0_EE
private

Definition at line 56 of file ECAL2DPositionCalcWithDepthCorr.cc.

Referenced by calculateAndSetPositionActual().

◆ _param_T0_ES

const double ECAL2DPositionCalcWithDepthCorr::_param_T0_ES
private

Definition at line 57 of file ECAL2DPositionCalcWithDepthCorr.cc.

Referenced by calculateAndSetPositionActual().

◆ _param_W0

const double ECAL2DPositionCalcWithDepthCorr::_param_W0
private

Definition at line 58 of file ECAL2DPositionCalcWithDepthCorr.cc.

Referenced by calculateAndSetPositionActual().

◆ _param_X0

const double ECAL2DPositionCalcWithDepthCorr::_param_X0
private

Definition at line 59 of file ECAL2DPositionCalcWithDepthCorr.cc.

Referenced by calculateAndSetPositionActual().

◆ _timeResolutionCalc

std::unique_ptr<CaloRecHitResolutionProvider> ECAL2DPositionCalcWithDepthCorr::_timeResolutionCalc
private