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...

#include <ECAL2DPositionCalcWithDepthCorr.h>

Inheritance diagram for ECAL2DPositionCalcWithDepthCorr:
PFCPositionCalculatorBase

Public Member Functions

void calculateAndSetPosition (reco::PFCluster &) override
 
void calculateAndSetPositions (reco::PFClusterCollection &) override
 
 ECAL2DPositionCalcWithDepthCorr (const edm::ParameterSet &conf)
 
 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)
 
 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
 
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 17 of file ECAL2DPositionCalcWithDepthCorr.h.

Constructor & Destructor Documentation

ECAL2DPositionCalcWithDepthCorr::ECAL2DPositionCalcWithDepthCorr ( const edm::ParameterSet conf)
inline

Definition at line 19 of file ECAL2DPositionCalcWithDepthCorr.h.

References _timeResolutionCalc, calculateAndSetPosition(), calculateAndSetPositions(), edm::ParameterSet::exists(), edm::ParameterSet::getParameterSet(), operator=(), and update().

19  :
21  _param_T0_EB(conf.getParameter<double>("T0_EB")),
22  _param_T0_EE(conf.getParameter<double>("T0_EE")),
23  _param_T0_ES(conf.getParameter<double>("T0_ES")),
24  _param_W0(conf.getParameter<double>("W0")),
25  _param_X0(conf.getParameter<double>("X0")),
26  _minAllowedNorm(conf.getParameter<double>("minAllowedNormalization")),
27  _ebGeom(nullptr),
28  _eeGeom(nullptr),
29  _esGeom(nullptr),
30  _esPlus(false),
31  _esMinus(false) {
32  _timeResolutionCalc.reset(nullptr);
33  if( conf.exists("timeResolutionCalc") ) {
34  const edm::ParameterSet& timeResConf =
35  conf.getParameterSet("timeResolutionCalc");
36  _timeResolutionCalc.reset(new CaloRecHitResolutionProvider(timeResConf));
37  }
38  }
T getParameter(std::string const &) const
bool exists(std::string const &parameterName) const
checks if a parameter exists
std::unique_ptr< CaloRecHitResolutionProvider > _timeResolutionCalc
ParameterSet const & getParameterSet(std::string const &) const
const CaloSubdetectorGeometry * _ebGeom
const CaloSubdetectorGeometry * _esGeom
const CaloSubdetectorGeometry * _eeGeom
PFCPositionCalculatorBase(const edm::ParameterSet &conf)
ECAL2DPositionCalcWithDepthCorr::ECAL2DPositionCalcWithDepthCorr ( const ECAL2DPositionCalcWithDepthCorr )
delete

Member Function Documentation

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

Definition at line 52 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(), constexpr, particleFlowClusterECALTimeSelected_cfi::depth, PFLayer::ECAL_BARREL, PFLayer::ECAL_ENDCAP, reco::PFCluster::energy(), CaloCellGeometry::etaPos(), Exception, objects.autophobj::float, CaloSubdetectorGeometry::getGeometry(), CaloCellGeometry::getPosition(), edm::isFinite(), PV3DBase< T, PVType, FrameType >::mag(), hpstanc_transforms::max, CMSBoostedTauSeedingParameters_cfi::maxDepth, PFLayer::NONE, reco::PFCluster::recHitFractions(), reco::CaloCluster::seed(), reco::CaloCluster::setEnergy(), reco::PFCluster::setLayer(), reco::CaloCluster::setPosition(), reco::PFCluster::setTime(), mps_merge::weight, x, PV3DBase< T, PVType, FrameType >::x(), y, PV3DBase< T, PVType, FrameType >::y(), z, and PV3DBase< T, PVType, FrameType >::z().

Referenced by calculateAndSetPosition(), and calculateAndSetPositions().

52  {
53  constexpr double preshowerStartEta = 1.653;
54  constexpr double preshowerEndEta = 2.6;
55  if( !cluster.seed() ) {
56  throw cms::Exception("ClusterWithNoSeed")
57  << " Found a cluster with no seed: " << cluster;
58  }
59  double cl_energy = 0;
60  double cl_energy_float = 0;
61  double cl_time = 0;
62  double cl_timeweight=0.0;
63  double max_e = 0.0;
64  double clusterT0 = 0.0;
65  PFLayer::Layer max_e_layer = PFLayer::NONE;
66  reco::PFRecHitRef refmax;
67  // find the seed and max layer
68  for( const reco::PFRecHitFraction& rhf : cluster.recHitFractions() ) {
69  const reco::PFRecHitRef& refhit = rhf.recHitRef();
70  const double rh_fraction = rhf.fraction();
71  const double rh_rawenergy = refhit->energy();
72  const double rh_energy = rh_rawenergy * rh_fraction;
73  const double rh_energyf = ((float)rh_rawenergy) * ((float) rh_fraction);
74  if( !edm::isFinite(rh_energy) ) {
75  throw cms::Exception("PFClusterAlgo")
76  <<"rechit " << refhit->detId() << " has non-finite energy... "
77  << "The input of the particle flow clustering seems to be corrupted.";
78  }
79  cl_energy += rh_energy;
80  cl_energy_float += rh_energyf;
81  // If time resolution is given, calculate weighted average
82  if (_timeResolutionCalc) {
83  const double res2 = 1./_timeResolutionCalc->timeResolution2(rh_rawenergy);
84  cl_time += rh_fraction*refhit->time()*res2;
85  cl_timeweight += rh_fraction*res2;
86  }
87  else { // assume resolution ~ 1/E**2
88  const double rh_rawenergy2 = rh_rawenergy*rh_rawenergy;
89  cl_timeweight+=rh_rawenergy2*rh_fraction;
90  cl_time += rh_rawenergy2*rh_fraction*refhit->time();
91  }
92  if( rh_energy > max_e ) {
93  max_e = rh_energy;
94  max_e_layer = rhf.recHitRef()->layer();
95  refmax = refhit;
96  }
97  }
98  cluster.setEnergy(cl_energy);
99  cluster.setTime(cl_time/cl_timeweight);
100  cluster.setLayer(max_e_layer);
101  const CaloSubdetectorGeometry* ecal_geom = nullptr;
102  // get seed geometry information
103  switch(max_e_layer){
105  ecal_geom = _ebGeom;
106  clusterT0 = _param_T0_EB;
107  break;
109  ecal_geom = _eeGeom;
110  clusterT0 = _param_T0_EE;
111  break;
112  default:
113  throw cms::Exception("InvalidLayer")
114  << "ECAL Position Calc only accepts ECAL_BARREL or ECAL_ENDCAP";
115  }
116 
117  const CaloCellGeometry* center_cell =
118  ecal_geom->getGeometry(refmax->detId());
119  const double ctreta = center_cell->etaPos();
120  const double actreta = std::abs(ctreta);
121  // need to change T0 if in ES
122  if( actreta > preshowerStartEta && actreta < preshowerEndEta ) {
123  if(ctreta > 0 && _esPlus ) clusterT0 = _param_T0_ES;
124  if(ctreta < 0 && _esMinus) clusterT0 = _param_T0_ES;
125  }
126  // floats to reproduce exactly the EGM code
127  const float maxDepth = _param_X0*(clusterT0 + vdt::fast_log(cl_energy_float));
128  const float maxToFront = center_cell->getPosition().mag();
129  // calculate the position
130  const double logETot_inv = -vdt::fast_log(cl_energy_float);
131  double position_norm = 0.0;
132  double x(0.0),y(0.0),z(0.0);
133  for( const reco::PFRecHitFraction& rhf : cluster.recHitFractions() ) {
134  double weight = 0.0;
135  const reco::PFRecHitRef& refhit = rhf.recHitRef();
136  const double rh_energy = ((float)refhit->energy()) * ((float)rhf.fraction());
137  if( rh_energy > 0.0 ) weight = std::max(0.0,( _param_W0 +
138  vdt::fast_log(rh_energy) +
139  logETot_inv ));
140  const CaloCellGeometry* cell = ecal_geom->getGeometry(refhit->detId());
141  const float depth = maxDepth + maxToFront - cell->getPosition().mag();
142  const GlobalPoint pos =
143  static_cast<const TruncatedPyramid*>(cell)->getPosition(depth);
144 
145  x += weight*pos.x() ;
146  y += weight*pos.y() ;
147  z += weight*pos.z() ;
148 
149  position_norm += weight ;
150  }
151 
152  // FALL BACK to LINEAR WEIGHTS
153  if (position_norm == 0.) {
154  for( const reco::PFRecHitFraction& rhf : cluster.recHitFractions() ) {
155  double weight = 0.0;
156  const reco::PFRecHitRef& refhit = rhf.recHitRef();
157  const double rh_energy = ((float)refhit->energy()) * ((float)rhf.fraction());
158  if( rh_energy > 0.0 )
159  weight = rh_energy/cluster.energy();
160 
161  const CaloCellGeometry* cell = ecal_geom->getGeometry(refhit->detId());
162  const float depth = maxDepth + maxToFront - cell->getPosition().mag();
163  const GlobalPoint pos = static_cast<const TruncatedPyramid*>(cell)->getPosition(depth);
164 
165  x += weight*pos.x() ;
166  y += weight*pos.y() ;
167  z += weight*pos.z() ;
168 
169  position_norm += weight ;
170  }
171  }
172 
173  if( position_norm < _minAllowedNorm ) {
174  edm::LogError("WeirdClusterNormalization")
175  << "PFCluster too far from seeding cell: set position to (0,0,0).";
176  cluster.setPosition(math::XYZPoint(0,0,0));
177  } else {
178  const double norm_inverse = 1.0/position_norm;
179  x *= norm_inverse;
180  y *= norm_inverse;
181  z *= norm_inverse;
182 
183  cluster.setPosition(math::XYZPoint(x,y,z));
184  cluster.calculatePositionREP();
185  }
186 }
void setLayer(PFLayer::Layer layer)
set layer
Definition: PFCluster.cc:120
void setPosition(const math::XYZPoint &p)
Definition: CaloCluster.h:115
void setTime(float time, float timeError=0)
Definition: PFCluster.h:92
T y() const
Definition: PV3DBase.h:63
Fraction of a PFRecHit (rechits can be shared between several PFCluster&#39;s)
std::unique_ptr< CaloRecHitResolutionProvider > _timeResolutionCalc
void setEnergy(double energy)
Definition: CaloCluster.h:111
Definition: weight.py:1
#define constexpr
virtual const CaloCellGeometry * getGeometry(const DetId &id) const
Get the cell geometry of a given detector id. Should return false if not found.
bool isFinite(T x)
T mag() const
Definition: PV3DBase.h:67
void calculatePositionREP()
computes posrep_ once and for all
Definition: PFCluster.h:100
T z() const
Definition: PV3DBase.h:64
Abs< T >::type abs(const T &t)
Definition: Abs.h:22
double energy() const
cluster energy
Definition: PFCluster.h:82
Layer
layer definition
Definition: PFLayer.h:31
DetId seed() const
return DetId of seed
Definition: CaloCluster.h:205
XYZPointD XYZPoint
point in space with cartesian internal representation
Definition: Point3D.h:12
const CaloSubdetectorGeometry * _ebGeom
A base class to handle the particular shape of Ecal Xtals. Taken from ORCA Calorimetry Code...
const CaloSubdetectorGeometry * _eeGeom
float etaPos() const
const std::vector< reco::PFRecHitFraction > & recHitFractions() const
vector of rechit fractions
Definition: PFCluster.h:72
const GlobalPoint & getPosition() const
Returns the position of reference for this cell.
T x() const
Definition: PV3DBase.h:62
void ECAL2DPositionCalcWithDepthCorr::calculateAndSetPositions ( reco::PFClusterCollection clusters)
overridevirtual

Implements PFCPositionCalculatorBase.

Definition at line 45 of file ECAL2DPositionCalcWithDepthCorr.cc.

References calculateAndSetPositionActual().

Referenced by calculateAndSetPosition(), and ECAL2DPositionCalcWithDepthCorr().

45  {
46  for( reco::PFCluster& cluster : clusters ) {
48  }
49 }
Particle flow cluster, see clustering algorithm in PFClusterAlgo.
Definition: PFCluster.h:47
void calculateAndSetPositionActual(reco::PFCluster &) const
ECAL2DPositionCalcWithDepthCorr& ECAL2DPositionCalcWithDepthCorr::operator= ( const ECAL2DPositionCalcWithDepthCorr )
delete
void ECAL2DPositionCalcWithDepthCorr::update ( const edm::EventSetup es)
overridevirtual

Reimplemented from PFCPositionCalculatorBase.

Definition at line 19 of file ECAL2DPositionCalcWithDepthCorr.cc.

References _ebGeom, _eeGeom, _esGeom, _esMinus, _esPlus, calculateAndSetPosition(), DetId::Ecal, EcalBarrel, EcalEndcap, EcalPreshower, edm::EventSetup::get(), edm::eventsetup::EventSetupRecord::get(), CaloSubdetectorGeometry::getGeometry(), CaloSubdetectorGeometry::getValidDetIds(), and z.

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), Vispa.Gui.VispaWidget.VispaWidget::autosize(), Vispa.Views.LineDecayView.LineDecayContainer::createObject(), Vispa.Views.LineDecayView.LineDecayContainer::deselectAllObjects(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::deselectAllWidgets(), ECAL2DPositionCalcWithDepthCorr(), Vispa.Gui.VispaWidget.VispaWidget::enableAutosizing(), progressbar.ProgressBar::finish(), Vispa.Gui.MenuWidget.MenuWidget::leaveEvent(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::mouseMoveEvent(), Vispa.Gui.MenuWidget.MenuWidget::mouseMoveEvent(), Vispa.Views.LineDecayView.LineDecayContainer::mouseMoveEvent(), Vispa.Gui.VispaWidgetOwner.VispaWidgetOwner::mouseReleaseEvent(), Vispa.Views.LineDecayView.LineDecayContainer::objectMoved(), MatrixUtil.Steps::overwrite(), Vispa.Views.LineDecayView.LineDecayContainer::removeObject(), Vispa.Gui.ConnectableWidget.ConnectableWidget::removePorts(), Vispa.Gui.FindDialog.FindDialog::reset(), Vispa.Gui.PortConnection.PointToPointConnection::select(), Vispa.Gui.VispaWidget.VispaWidget::select(), Vispa.Views.LineDecayView.LineDecayContainer::select(), Vispa.Gui.VispaWidget.VispaWidget::setText(), Vispa.Gui.VispaWidget.VispaWidget::setTitle(), Vispa.Gui.ZoomableWidget.ZoomableWidget::setZoom(), Vispa.Views.LineDecayView.LineDecayContainer::setZoom(), and Vispa.Gui.PortConnection.PointToPointConnection::updateConnection().

19  {
20 
21  const CaloGeometryRecord& caloGeom = es.get<CaloGeometryRecord>();
23  caloGeom.get(geohandle);
24  _ebGeom = geohandle->getSubdetectorGeometry(DetId::Ecal,EcalBarrel);
25  _eeGeom = geohandle->getSubdetectorGeometry(DetId::Ecal,EcalEndcap);
26  _esGeom = geohandle->getSubdetectorGeometry(DetId::Ecal,EcalPreshower);
27  if(_esGeom){
28  // ripped from RecoEcal/EgammaCoreTools
29  for( uint32_t ic = 0;
30  ic < _esGeom->getValidDetIds().size() &&
31  ( !_esPlus || !_esMinus ); ++ic ) {
32  const double z = _esGeom->getGeometry( _esGeom->getValidDetIds()[ic] )->getPosition().z();
33  _esPlus = _esPlus || ( 0 < z ) ;
34  _esMinus = _esMinus || ( 0 > z ) ;
35  }
36  }
37 }
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)
virtual const CaloCellGeometry * getGeometry(const DetId &id) const
Get the cell geometry of a given detector id. Should return false if not found.
void get(HolderT &iHolder) const
const T & get() const
Definition: EventSetup.h:56
const CaloSubdetectorGeometry * _ebGeom
const CaloSubdetectorGeometry * _esGeom
const CaloSubdetectorGeometry * _eeGeom

Member Data Documentation

const CaloSubdetectorGeometry* ECAL2DPositionCalcWithDepthCorr::_ebGeom
private

Definition at line 57 of file ECAL2DPositionCalcWithDepthCorr.h.

Referenced by calculateAndSetPositionActual(), and update().

const CaloSubdetectorGeometry* ECAL2DPositionCalcWithDepthCorr::_eeGeom
private

Definition at line 58 of file ECAL2DPositionCalcWithDepthCorr.h.

Referenced by calculateAndSetPositionActual(), and update().

const CaloSubdetectorGeometry* ECAL2DPositionCalcWithDepthCorr::_esGeom
private

Definition at line 59 of file ECAL2DPositionCalcWithDepthCorr.h.

Referenced by update().

bool ECAL2DPositionCalcWithDepthCorr::_esMinus
private

Definition at line 60 of file ECAL2DPositionCalcWithDepthCorr.h.

Referenced by calculateAndSetPositionActual(), and update().

bool ECAL2DPositionCalcWithDepthCorr::_esPlus
private

Definition at line 60 of file ECAL2DPositionCalcWithDepthCorr.h.

Referenced by calculateAndSetPositionActual(), and update().

const double ECAL2DPositionCalcWithDepthCorr::_minAllowedNorm
private

Definition at line 53 of file ECAL2DPositionCalcWithDepthCorr.h.

Referenced by calculateAndSetPositionActual().

const double ECAL2DPositionCalcWithDepthCorr::_param_T0_EB
private

Definition at line 48 of file ECAL2DPositionCalcWithDepthCorr.h.

Referenced by calculateAndSetPositionActual().

const double ECAL2DPositionCalcWithDepthCorr::_param_T0_EE
private

Definition at line 49 of file ECAL2DPositionCalcWithDepthCorr.h.

Referenced by calculateAndSetPositionActual().

const double ECAL2DPositionCalcWithDepthCorr::_param_T0_ES
private

Definition at line 50 of file ECAL2DPositionCalcWithDepthCorr.h.

Referenced by calculateAndSetPositionActual().

const double ECAL2DPositionCalcWithDepthCorr::_param_W0
private

Definition at line 51 of file ECAL2DPositionCalcWithDepthCorr.h.

Referenced by calculateAndSetPositionActual().

const double ECAL2DPositionCalcWithDepthCorr::_param_X0
private

Definition at line 52 of file ECAL2DPositionCalcWithDepthCorr.h.

Referenced by calculateAndSetPositionActual().

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