CMS 3D CMS Logo

List of all members | Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | Static Private Attributes
reco::PFCluster Class Reference

Particle flow cluster, see clustering algorithm in PFClusterAlgo. More...

#include <PFCluster.h>

Inheritance diagram for reco::PFCluster:
reco::CaloCluster reco::HGCalMultiCluster reco::PFSuperCluster

Public Types

typedef std::vector< std::pair< CaloClusterPtr::key_type, edm::Ptr< PFCluster > > > EEtoPSAssociation
 
typedef ROOT::Math::PositionVector3D< ROOT::Math::CylindricalEta3D< double > > REPPoint
 
- Public Types inherited from reco::CaloCluster
enum  AlgoId {
  island = 0, hybrid = 1, fixedMatrix = 2, dynamicHybrid = 3,
  multi5x5 = 4, particleFlow = 5, hgcal_em = 6, hgcal_had = 7,
  hgcal_mixed = 8, undefined = 1000
}
 
typedef AlgoId AlgoID
 
enum  HCalFlags { badHcalMarker = 1 }
 
enum  SCFlags { cleanOnly = 0, common = 100, uncleanOnly = 200 }
 

Public Member Functions

void addRecHitFraction (const reco::PFRecHitFraction &frac)
 add a given fraction of the rechit More...
 
void calculatePositionREP ()
 computes posrep_ once and for all More...
 
double charge () const
 dummy charge More...
 
int color () const
 
double depth () const
 cluster depth More...
 
double energy () const
 cluster energy More...
 
PFLayer::Layer layer () const
 cluster layer, see PFLayer.h in this directory More...
 
PFClusteroperator= (const PFCluster &)
 
 PFCluster ()
 
 PFCluster (PFLayer::Layer layer, double energy, double x, double y, double z)
 constructor More...
 
const REPPointpositionREP () const
 cluster position: rho, eta, phi More...
 
template<typename pruner >
void pruneUsing (pruner prune)
 
double pt () const
 transverse momentum, massless approximation More...
 
const std::vector< reco::PFRecHitFraction > & recHitFractions () const
 vector of rechit fractions More...
 
void reset ()
 resets clusters parameters More...
 
void resetHitsAndFractions ()
 reset only hits and fractions More...
 
void setColor (int color)
 set cluster color (for the PFRootEventManager display) More...
 
void setDepth (double depth)
 
void setLayer (PFLayer::Layer layer)
 set layer More...
 
void setTime (float time, float timeError=0)
 
void setTimeError (float timeError)
 
double theta () const
 angle More...
 
float time () const
 
float timeError () const
 
math::XYZPoint const & vertex () const
 dummy vertex access More...
 
double vx () const
 
double vy () const
 
double vz () const
 
- Public Member Functions inherited from reco::CaloCluster
void addHitAndFraction (DetId id, float fraction)
 
AlgoId algo () const
 algorithm identifier More...
 
AlgoID algoID () const
 
 CaloCluster ()
 default constructor. Sets energy and position to zero More...
 
 CaloCluster (AlgoID algoID)
 constructor with algoId, to be used in all child classes More...
 
 CaloCluster (double energy, const math::XYZPoint &position, const CaloID &caloID)
 
 CaloCluster (double energy, const math::XYZPoint &position)
 constructor from values More...
 
 CaloCluster (double energy, const math::XYZPoint &position, const CaloID &caloID, const AlgoID &algoID, uint32_t flags=0)
 
 CaloCluster (double energy, const math::XYZPoint &position, const CaloID &caloID, const std::vector< std::pair< DetId, float > > &usedHitsAndFractions, const AlgoId algoId, const DetId seedId=DetId(0), uint32_t flags=0)
 
 CaloCluster (double energy, const math::XYZPoint &position, float chi2, const std::vector< DetId > &usedHits, const AlgoId algoId, uint32_t flags=0)
 temporary compatibility constructor More...
 
const CaloIDcaloID () const
 
double correctedEnergy () const
 
float correctedEnergyUncertainty () const
 
double energy () const
 cluster energy More...
 
double eta () const
 pseudorapidity of cluster centroid More...
 
uint32_t flags () const
 
const std::vector< std::pair< DetId, float > > & hitsAndFractions () const
 
bool isInClean () const
 
bool isInUnclean () const
 
bool operator< (const CaloCluster &rhs) const
 comparison < operator More...
 
bool operator<= (const CaloCluster &rhs) const
 comparison <= operator More...
 
bool operator== (const CaloCluster &rhs) const
 comparison == operator More...
 
bool operator> (const CaloCluster &rhs) const
 comparison > operator More...
 
bool operator>= (const CaloCluster &rhs) const
 comparison >= operator More...
 
double phi () const
 azimuthal angle of cluster centroid More...
 
const math::XYZPointposition () const
 cluster centroid position More...
 
std::string printHitAndFraction (unsigned i) const
 print hitAndFraction More...
 
void reset ()
 resets the CaloCluster (position, energy, hitsAndFractions) More...
 
DetId seed () const
 return DetId of seed More...
 
void setAlgoId (const AlgoId &id)
 
void setCaloId (const CaloID &id)
 
void setCorrectedEnergy (double cenergy)
 
void setCorrectedEnergyUncertainty (float energyerr)
 
void setEnergy (double energy)
 
void setFlags (uint32_t flags)
 
void setPosition (const math::XYZPoint &p)
 
void setSeed (const DetId &id)
 
size_t size () const
 size in number of hits (e.g. in crystals for ECAL) More...
 
double x () const
 x coordinate of cluster centroid More...
 
double y () const
 y coordinate of cluster centroid More...
 
double z () const
 z coordinate of cluster centroid More...
 
virtual ~CaloCluster ()
 destructor More...
 

Static Public Member Functions

static double getDepthCorrection (double energy, bool isBelowPS=false, bool isHadron=false)
 
static void setDepthCorParameters (int mode, double a, double b, double ap, double bp)
 

Private Attributes

int color_
 color (transient) More...
 
double depth_
 
PFLayer::Layer layer_
 transient layer More...
 
REPPoint posrep_
 cluster position: rho, eta, phi (transient) More...
 
std::vector< reco::PFRecHitFractionrechits_
 vector of rechit fractions (transient) More...
 
float time_
 Michalis :Add timing and depth information. More...
 
float timeError_
 

Static Private Attributes

static std::atomic< double > depthCorA_ {0.89}
 
static std::atomic< double > depthCorAp_ {0.89}
 
static std::atomic< double > depthCorB_ {7.3}
 
static std::atomic< double > depthCorBp_ {4.0}
 
static std::atomic< int > depthCorMode_ {0}
 
static const math::XYZPoint dummyVtx_
 

Additional Inherited Members

- Protected Attributes inherited from reco::CaloCluster
AlgoID algoID_
 
CaloID caloID_
 bitmask for detector information More...
 
double correctedEnergy_
 
float correctedEnergyUncertainty_
 
double energy_
 cluster energy More...
 
uint32_t flags_
 
std::vector< std::pair< DetId, float > > hitsAndFractions_
 
math::XYZPoint position_
 cluster centroid position More...
 
DetId seedId_
 DetId of seed. More...
 
- Static Protected Attributes inherited from reco::CaloCluster
static const uint32_t flagsMask_ =0x0FFFFFFF
 
static const uint32_t flagsOffset_ =28
 

Detailed Description

Particle flow cluster, see clustering algorithm in PFClusterAlgo.

A particle flow cluster is defined by its energy and position, which are calculated from a vector of PFRecHitFraction. This calculation is performed in PFClusterAlgo.

Author
Colin Bernet
Date
July 2006

Definition at line 47 of file PFCluster.h.

Member Typedef Documentation

Definition at line 50 of file PFCluster.h.

typedef ROOT::Math::PositionVector3D<ROOT::Math::CylindricalEta3D<double> > reco::PFCluster::REPPoint

Definition at line 54 of file PFCluster.h.

Constructor & Destructor Documentation

reco::PFCluster::PFCluster ( )
inline

Definition at line 56 of file PFCluster.h.

References addRecHitFraction(), energy(), cropTnPTrees::frac, layer(), reset(), resetHitsAndFractions(), reco::CaloCluster::x(), reco::CaloCluster::y(), and reco::CaloCluster::z().

PFLayer::Layer layer_
transient layer
Definition: PFCluster.h:188
CaloCluster()
default constructor. Sets energy and position to zero
Definition: CaloCluster.h:47
int color_
color (transient)
Definition: PFCluster.h:225
float time_
Michalis :Add timing and depth information.
Definition: PFCluster.h:184
PFCluster::PFCluster ( PFLayer::Layer  layer,
double  energy,
double  x,
double  y,
double  z 
)

constructor

Definition at line 57 of file PFCluster.cc.

58  :
60  math::XYZPoint(x,y,z),
63  posrep_( position_.Rho(), position_.Eta(), position_.Phi() ),
64  time_(-99.),
65  depth_(0.),
66  layer_(layer),
67  color_(2)
68 { }
PFLayer::Layer layer() const
cluster layer, see PFLayer.h in this directory
Definition: PFCluster.cc:120
math::XYZPoint position_
cluster centroid position
Definition: CaloCluster.h:217
PFLayer::Layer layer_
transient layer
Definition: PFCluster.h:188
double z() const
z coordinate of cluster centroid
Definition: CaloCluster.h:165
double x() const
x coordinate of cluster centroid
Definition: CaloCluster.h:159
double energy() const
cluster energy
Definition: PFCluster.h:82
static reco::CaloID toCaloID(Layer layer)
Definition: PFLayer.cc:11
REPPoint posrep_
cluster position: rho, eta, phi (transient)
Definition: PFCluster.h:181
XYZPointD XYZPoint
point in space with cartesian internal representation
Definition: Point3D.h:12
CaloCluster()
default constructor. Sets energy and position to zero
Definition: CaloCluster.h:47
int color_
color (transient)
Definition: PFCluster.h:225
float time_
Michalis :Add timing and depth information.
Definition: PFCluster.h:184
double y() const
y coordinate of cluster centroid
Definition: CaloCluster.h:162

Member Function Documentation

void PFCluster::addRecHitFraction ( const reco::PFRecHitFraction frac)
void reco::PFCluster::calculatePositionREP ( )
inline

computes posrep_ once and for all

Definition at line 100 of file PFCluster.h.

References getDepthCorrection(), reco::CaloCluster::position_, and posrep_.

Referenced by Cluster3DPCACalculator::calculateAndSetPositionActual(), ECAL2DPositionCalcWithDepthCorr::calculateAndSetPositionActual(), Basic2DGenericPFlowPositionCalc::calculateAndSetPositionActual(), PFEnergyCalibration::energyEm(), PFElecTkProducer::isSharingEcalEnergyWithEgSC(), and ConvBremPFTrackFinder::runConvBremFinder().

100  {
101  posrep_.SetCoordinates( position_.Rho(),
102  position_.Eta(),
103  position_.Phi() );
104  }
math::XYZPoint position_
cluster centroid position
Definition: CaloCluster.h:217
REPPoint posrep_
cluster position: rho, eta, phi (transient)
Definition: PFCluster.h:181
double reco::PFCluster::charge ( ) const
inline

dummy charge

some classes to make this fit into a template footprint for RecoPFClusterRefCandidate so we can make jets and MET out of PFClusters.

Definition at line 136 of file PFCluster.h.

136 { return 0;}
int reco::PFCluster::color ( ) const
inline
Returns
color

Definition at line 114 of file PFCluster.h.

References color_, and operator=().

Referenced by setColor().

114 {return color_;}
int color_
color (transient)
Definition: PFCluster.h:225
double reco::PFCluster::depth ( ) const
inline

cluster depth

Definition at line 90 of file PFCluster.h.

References depth_.

Referenced by PFMultiDepthClusterizer::link(), and setDepth().

90 {return depth_;}
double reco::PFCluster::energy ( ) const
inline
double PFCluster::getDepthCorrection ( double  energy,
bool  isBelowPS = false,
bool  isHadron = false 
)
static

Definition at line 100 of file PFCluster.cc.

References depthCorA_, depthCorAp_, depthCorB_, depthCorBp_, and cmsBatch::log.

Referenced by calculatePositionREP().

102 {
103  double corrA = depthCorA_;
104  double corrB = depthCorB_;
105  if (isBelowPS) {
106  corrA = depthCorAp_;
107  corrB = depthCorBp_;
108  }
109  return isHadron ? corrA : corrA*(corrB + log(energy));
110 }
static std::atomic< double > depthCorAp_
Definition: PFCluster.h:201
static std::atomic< double > depthCorB_
Definition: PFCluster.h:198
double energy() const
cluster energy
Definition: PFCluster.h:82
static std::atomic< double > depthCorBp_
Definition: PFCluster.h:204
static std::atomic< double > depthCorA_
Definition: PFCluster.h:195
PFLayer::Layer PFCluster::layer ( ) const
PFCluster & PFCluster::operator= ( const PFCluster other)

Definition at line 128 of file PFCluster.cc.

References color_, reco::CaloCluster::energy_, reco::CaloCluster::position_, posrep_, and rechits_.

Referenced by color(), and reco::PFSuperCluster::operator=().

128  {
129 
130  CaloCluster::operator=(other);
131  rechits_ = other.rechits_;
132  energy_ = other.energy_;
133  position_ = other.position_;
134  posrep_ = other.posrep_;
135  color_ = other.color_;
136 
137  return *this;
138 }
math::XYZPoint position_
cluster centroid position
Definition: CaloCluster.h:217
double energy_
cluster energy
Definition: CaloCluster.h:212
std::vector< reco::PFRecHitFraction > rechits_
vector of rechit fractions (transient)
Definition: PFCluster.h:178
REPPoint posrep_
cluster position: rho, eta, phi (transient)
Definition: PFCluster.h:181
int color_
color (transient)
Definition: PFCluster.h:225
const REPPoint& reco::PFCluster::positionREP ( ) const
inline
template<typename pruner >
void reco::PFCluster::pruneUsing ( pruner  prune)
inline

Definition at line 158 of file PFCluster.h.

References plotBeamSpotDB::first, reco::CaloCluster::hitsAndFractions_, mps_fire::i, createfilelist::int, eostools::move(), and rechits_.

158  {
159  // remove_if+erase algo applied to both vectors...
160  auto iter = std::find_if_not(rechits_.begin(),rechits_.end(),prune);
161  if (iter==rechits_.end()) return;
162  auto first = iter-rechits_.begin();
163  for (auto i=first; ++i<int(rechits_.size());) {
164  if (prune(rechits_[i])) {
167  ++first;
168  }
169  }
170  rechits_.erase(rechits_.begin()+first,rechits_.end());
172  }
std::vector< reco::PFRecHitFraction > rechits_
vector of rechit fractions (transient)
Definition: PFCluster.h:178
std::vector< std::pair< DetId, float > > hitsAndFractions_
Definition: CaloCluster.h:223
def move(src, dest)
Definition: eostools.py:511
double reco::PFCluster::pt ( ) const
inline
const std::vector< reco::PFRecHitFraction >& reco::PFCluster::recHitFractions ( ) const
inline
void PFCluster::reset ( void  )

resets clusters parameters

Definition at line 71 of file PFCluster.cc.

References reco::CaloCluster::energy_, layer_, PFLayer::NONE, reco::CaloCluster::position_, posrep_, rechits_, reco::CaloCluster::reset(), and time_.

Referenced by PFCluster(), and reco::PFSuperCluster::reset().

71  {
72 
73  energy_ = 0;
74  position_ *= 0;
75  posrep_ *= 0;
76  time_=-99.;
78  rechits_.clear();
79 
81 
82 }
math::XYZPoint position_
cluster centroid position
Definition: CaloCluster.h:217
double energy_
cluster energy
Definition: CaloCluster.h:212
std::vector< reco::PFRecHitFraction > rechits_
vector of rechit fractions (transient)
Definition: PFCluster.h:178
PFLayer::Layer layer_
transient layer
Definition: PFCluster.h:188
REPPoint posrep_
cluster position: rho, eta, phi (transient)
Definition: PFCluster.h:181
float time_
Michalis :Add timing and depth information.
Definition: PFCluster.h:184
void reset()
resets the CaloCluster (position, energy, hitsAndFractions)
Definition: CaloCluster.cc:11
void PFCluster::resetHitsAndFractions ( )

reset only hits and fractions

Definition at line 84 of file PFCluster.cc.

References reco::CaloCluster::hitsAndFractions_, and rechits_.

Referenced by PFCluster().

84  {
85 
86  rechits_.clear();
87  hitsAndFractions_.clear();
88 
89 }
std::vector< reco::PFRecHitFraction > rechits_
vector of rechit fractions (transient)
Definition: PFCluster.h:178
std::vector< std::pair< DetId, float > > hitsAndFractions_
Definition: CaloCluster.h:223
void reco::PFCluster::setColor ( int  color)
inline

set cluster color (for the PFRootEventManager display)

Definition at line 111 of file PFCluster.h.

References color(), and color_.

111 {color_ = color;}
int color() const
Definition: PFCluster.h:114
int color_
color (transient)
Definition: PFCluster.h:225
void reco::PFCluster::setDepth ( double  depth)
inline

Definition at line 94 of file PFCluster.h.

References depth(), and depth_.

Referenced by Basic2DGenericPFlowPositionCalc::calculateAndSetPositionActual().

94 {depth_ = depth;}
double depth() const
cluster depth
Definition: PFCluster.h:90
static void reco::PFCluster::setDepthCorParameters ( int  mode,
double  a,
double  b,
double  ap,
double  bp 
)
inlinestatic

Definition at line 120 of file PFCluster.h.

References a, b, depthCorA_, depthCorAp_, depthCorB_, depthCorBp_, depthCorMode_, and ALCARECOPromptCalibProdSiPixelAli0T_cff::mode.

122  {
124  depthCorA_ = a;
125  depthCorB_ = b;
126  depthCorAp_ = ap;
127  depthCorBp_ = bp;
128  }
static std::atomic< double > depthCorAp_
Definition: PFCluster.h:201
static std::atomic< double > depthCorB_
Definition: PFCluster.h:198
static std::atomic< int > depthCorMode_
Definition: PFCluster.h:192
double b
Definition: hdecay.h:120
static std::atomic< double > depthCorBp_
Definition: PFCluster.h:204
double a
Definition: hdecay.h:121
static std::atomic< double > depthCorA_
Definition: PFCluster.h:195
void PFCluster::setLayer ( PFLayer::Layer  layer)

set layer

Definition at line 112 of file PFCluster.cc.

References reco::CaloCluster::caloID_, layer(), layer_, and PFLayer::toCaloID().

Referenced by Cluster3DPCACalculator::calculateAndSetPositionActual(), ECAL2DPositionCalcWithDepthCorr::calculateAndSetPositionActual(), Basic2DGenericPFlowPositionCalc::calculateAndSetPositionActual(), reco::HGCalMultiCluster::HGCalMultiCluster(), and recHitFractions().

112  {
113  // cout<<"calling PFCluster::setLayer "<<layer<<endl;
114  layer_ = layer;
116  // cout<<"done "<<caloID_<<endl;
117 }
PFLayer::Layer layer() const
cluster layer, see PFLayer.h in this directory
Definition: PFCluster.cc:120
CaloID caloID_
bitmask for detector information
Definition: CaloCluster.h:220
PFLayer::Layer layer_
transient layer
Definition: PFCluster.h:188
static reco::CaloID toCaloID(Layer layer)
Definition: PFLayer.cc:11
void reco::PFCluster::setTime ( float  time,
float  timeError = 0 
)
inline
void reco::PFCluster::setTimeError ( float  timeError)
inline
double reco::PFCluster::theta ( ) const
inline

angle

Definition at line 144 of file PFCluster.h.

References reco::CaloCluster::position_.

Referenced by Tau.Tau::zImpact().

144  {
145  return position_.theta();
146  }
math::XYZPoint position_
cluster centroid position
Definition: CaloCluster.h:217
float reco::PFCluster::time ( ) const
inline
Returns
cluster time

Definition at line 85 of file PFCluster.h.

References time_.

Referenced by PFlow2DClusterizerWithTime::dist2Time(), and setTime().

85 {return time_;}
float time_
Michalis :Add timing and depth information.
Definition: PFCluster.h:184
float reco::PFCluster::timeError ( ) const
inline
Returns
the timing uncertainty

Definition at line 87 of file PFCluster.h.

References timeError_.

Referenced by setTime(), and setTimeError().

87 { return timeError_; }
float timeError_
Definition: PFCluster.h:184
math::XYZPoint const& reco::PFCluster::vertex ( ) const
inline

dummy vertex access

Definition at line 149 of file PFCluster.h.

References dummyVtx_.

Referenced by Tau.Tau::dxy(), vx(), vy(), and vz().

149  {
150  return dummyVtx_;
151  }
static const math::XYZPoint dummyVtx_
Definition: PFCluster.h:222
double reco::PFCluster::vx ( ) const
inline

Definition at line 152 of file PFCluster.h.

References vertex().

152 { return vertex().x(); }
math::XYZPoint const & vertex() const
dummy vertex access
Definition: PFCluster.h:149
double reco::PFCluster::vy ( ) const
inline

Definition at line 153 of file PFCluster.h.

References vertex().

153 { return vertex().y(); }
math::XYZPoint const & vertex() const
dummy vertex access
Definition: PFCluster.h:149
double reco::PFCluster::vz ( ) const
inline

Definition at line 154 of file PFCluster.h.

References vertex().

154 { return vertex().z(); }
math::XYZPoint const & vertex() const
dummy vertex access
Definition: PFCluster.h:149

Member Data Documentation

int reco::PFCluster::color_
private

color (transient)

Definition at line 225 of file PFCluster.h.

Referenced by color(), operator=(), and setColor().

double reco::PFCluster::depth_
private

Definition at line 185 of file PFCluster.h.

Referenced by depth(), and setDepth().

std::atomic< double > PFCluster::depthCorA_ {0.89}
staticprivate

Definition at line 195 of file PFCluster.h.

Referenced by getDepthCorrection(), and setDepthCorParameters().

std::atomic< double > PFCluster::depthCorAp_ {0.89}
staticprivate

Definition at line 201 of file PFCluster.h.

Referenced by getDepthCorrection(), and setDepthCorParameters().

std::atomic< double > PFCluster::depthCorB_ {7.3}
staticprivate

Definition at line 198 of file PFCluster.h.

Referenced by getDepthCorrection(), and setDepthCorParameters().

std::atomic< double > PFCluster::depthCorBp_ {4.0}
staticprivate

Definition at line 204 of file PFCluster.h.

Referenced by getDepthCorrection(), and setDepthCorParameters().

std::atomic< int > PFCluster::depthCorMode_ {0}
staticprivate

Definition at line 192 of file PFCluster.h.

Referenced by setDepthCorParameters().

const math::XYZPoint PFCluster::dummyVtx_
staticprivate

Definition at line 222 of file PFCluster.h.

Referenced by vertex().

PFLayer::Layer reco::PFCluster::layer_
private

transient layer

Definition at line 188 of file PFCluster.h.

Referenced by layer(), reset(), and setLayer().

REPPoint reco::PFCluster::posrep_
private

cluster position: rho, eta, phi (transient)

Definition at line 181 of file PFCluster.h.

Referenced by calculatePositionREP(), operator=(), positionREP(), and reset().

std::vector< reco::PFRecHitFraction > reco::PFCluster::rechits_
private

vector of rechit fractions (transient)

Definition at line 178 of file PFCluster.h.

Referenced by addRecHitFraction(), operator=(), pruneUsing(), recHitFractions(), reset(), and resetHitsAndFractions().

float reco::PFCluster::time_
private

Michalis :Add timing and depth information.

Definition at line 184 of file PFCluster.h.

Referenced by reset(), setTime(), and time().

float reco::PFCluster::timeError_
private

Definition at line 184 of file PFCluster.h.

Referenced by setTime(), setTimeError(), and timeError().