CMS 3D CMS Logo
reco::CaloCluster

reco::CaloCluster Class Reference

Base class for all types calorimeter clusters. More...

#include <DataFormats/CaloRecHit/interface/CaloCluster.h>

Inheritance diagram for reco::CaloCluster:

reco::BasicCluster reco::PFCluster reco::PreshowerCluster reco::SuperCluster

List of all members.

Public Member Functions

 CaloCluster (double energy, const math::XYZPoint &position, const CaloID &caloID)
 constructor from values
 CaloCluster (double energy, const math::XYZPoint &position)
 constructor from values
 CaloCluster ()
 default constructor. Sets energy and position to zero
const CaloID & caloID () const
CaloID & caloID ()
double energy () const
 cluster energy
double eta () const
 pseudorapidity of cluster centroid
bool operator< (const CaloCluster &rhs) const
 comparison <= operator
bool operator<= (const CaloCluster &rhs) const
 comparison <= operator
CaloCluster & operator= (const CaloCluster &rhs)
bool operator> (const CaloCluster &rhs) const
 comparison > operator
bool operator>= (const CaloCluster &rhs) const
 comparison >= operator
double phi () const
 azimuthal angle of cluster centroid
const math::XYZPoint & position () const
 cluster centroid position
double x () const
 x coordinate of cluster centroid
double y () const
 y coordinate of cluster centroid
double z () const
 z coordinate of cluster centroid
virtual ~CaloCluster ()
 destructor

Protected Attributes

CaloID caloID_
 bitmask for detector information
double energy_
 cluster energy
math::XYZPoint position_
 cluster centroid position

Detailed Description

Base class for all types calorimeter clusters.

Author:
Shahram Rahatlou, INFN
Version:
Id
CaloCluster.h,v 1.4 2008/05/05 11:06:13 cbern Exp

Definition at line 18 of file CaloCluster.h.

Constructor & Destructor Documentation

reco::CaloCluster::CaloCluster (  )  [inline]

default constructor. Sets energy and position to zero

Definition at line 23 of file CaloCluster.h.

00023 : energy_(0.) { }

reco::CaloCluster::CaloCluster ( double  energy,
const math::XYZPoint &  position 
) [inline]

constructor from values

Definition at line 26 of file CaloCluster.h.

00027                                                 :
00028       energy_ (energy), position_ (position) {}

reco::CaloCluster::CaloCluster ( double  energy,
const math::XYZPoint &  position,
const CaloID &  caloID 
) [inline]

constructor from values

Definition at line 31 of file CaloCluster.h.

00033                                        :
00034       energy_ (energy), position_ (position), caloID_(caloID) {}

virtual reco::CaloCluster::~CaloCluster (  )  [inline, virtual]

destructor

Definition at line 37 of file CaloCluster.h.

00037 {}

Member Function Documentation

const CaloID& reco::CaloCluster::caloID (  )  const [inline]

Definition at line 82 of file CaloCluster.h.

References caloID_.

00082 {return caloID_;}

CaloID& reco::CaloCluster::caloID (  )  [inline]

Definition at line 81 of file CaloCluster.h.

References caloID_.

Referenced by reco::PFCluster::layer().

00081 {return caloID_;}

double reco::CaloCluster::energy (  )  const [inline]

cluster energy

Reimplemented in reco::PFCluster.

Definition at line 40 of file CaloCluster.h.

References energy_.

Referenced by ElectronCalibrationUniv::analyze(), ElectronCalibration::analyze(), EgammaSCEnergyCorrectionAlgo::applyCorrection(), ConversionTrackCandidateProducer::buildCollections(), EcalClusterTools::calc_AbsZernikeMoment(), ClusterShapeAlgo::calc_AbsZernikeMoment(), ClusterShapeAlgo::Calculate_BarrelBasketEnergyFraction(), SuperClusterShapeAlgo::Calculate_Covariances(), ClusterShapeAlgo::Calculate_EnergyDepTopology(), converter::SuperClusterToCandidate::convert(), HFRecoEcalCandidateAlgo::correctEPosition(), egammaisolation::EgammaEcalExtractor::deposit(), EcalClusterTools::energyBasketFractionEta(), EcalClusterTools::energyBasketFractionPhi(), reco::PreshowerCluster::et(), ClusterShapeAlgo::fast_AbsZernikeMoment(), EcalClusterTools::fast_AbsZernikeMoment(), ZeeCalibration::fillEleInfo(), ElectronPixelSeedProducer::filterClusters(), ElectronGSPixelSeedProducer::filterClusters(), EgammaEcalIsolation::getEcalEtSum(), EcalClusterTools::getEnergyDepTopology(), EgammaHLTEcalIsolation::isolPtSum(), PreshowerClusterAlgo::makeOneCluster(), HybridClusterAlgo::makeSuperClusters(), SuperClusterEt::operator()(), SuperClusterEtHeepSkim::operator()(), HoECalculator::operator()(), ClusterEtLess::operator()(), reco::BasicCluster::operator<(), reco::PreshowerCluster::operator<(), reco::BasicCluster::operator==(), GsfElectronAlgo::preSelection(), GlobalGsfElectronAlgo::preSelection(), SoftElectronProducer::produce(), EgammaSCCorrectionMaker::produce(), ElectronRecalibSuperClusterAssociator::produce(), PreshowerClusterProducer::produce(), HFRecoEcalCandidateAlgo::produce(), SiStripElectronProducer::produce(), and SubSeedGenerator::run().

00040 { return energy_; }

double reco::CaloCluster::eta (  )  const [inline]

pseudorapidity of cluster centroid

Definition at line 75 of file CaloCluster.h.

References position_.

Referenced by ElectronCalibration::analyze(), EgammaSCEnergyCorrectionAlgo::applyCorrection(), HFRecoEcalCandidateAlgo::correctEPosition(), egammaisolation::EgammaEcalExtractor::deposit(), reco::PreshowerCluster::et(), ElectronPixelSeedProducer::filterClusters(), ElectronGSPixelSeedProducer::filterClusters(), EgammaEcalIsolation::getEcalEtSum(), EgammaHLTEcalIsolation::isolPtSum(), PreshowerClusterAlgo::makeOneCluster(), GsfElectronAlgo::preSelection(), GlobalGsfElectronAlgo::preSelection(), and HFRecoEcalCandidateAlgo::produce().

00075 { return position_.eta(); }

bool reco::CaloCluster::operator< ( const CaloCluster &  rhs  )  const [inline]

comparison <= operator

Definition at line 61 of file CaloCluster.h.

References energy_.

00061                                                    { 
00062       return (energy_< rhs.energy_); 
00063     }

bool reco::CaloCluster::operator<= ( const CaloCluster &  rhs  )  const [inline]

comparison <= operator

Definition at line 56 of file CaloCluster.h.

References energy_.

00056                                                    { 
00057       return (energy_<=rhs.energy_); 
00058     }

CaloCluster& reco::CaloCluster::operator= ( const CaloCluster &  rhs  )  [inline]

Definition at line 84 of file CaloCluster.h.

References caloID_, energy_, and position_.

Referenced by reco::PFCluster::operator=().

00084                                                     {
00085       energy_ = rhs.energy_;
00086       position_ = rhs.position_;
00087       caloID_ = rhs.caloID_;
00088       return *this;
00089     }

bool reco::CaloCluster::operator> ( const CaloCluster &  rhs  )  const [inline]

comparison > operator

Definition at line 51 of file CaloCluster.h.

References energy_.

00051                                                    { 
00052       return (energy_> rhs.energy_); 
00053     }

bool reco::CaloCluster::operator>= ( const CaloCluster &  rhs  )  const [inline]

comparison >= operator

Definition at line 46 of file CaloCluster.h.

References energy_.

00046                                                    { 
00047       return (energy_>=rhs.energy_); 
00048     }

double reco::CaloCluster::phi (  )  const [inline]

azimuthal angle of cluster centroid

Definition at line 78 of file CaloCluster.h.

References position_.

Referenced by HFRecoEcalCandidateAlgo::correctEPosition(), egammaisolation::EgammaEcalExtractor::deposit(), EgammaHLTEcalIsolation::isolPtSum(), PreshowerClusterAlgo::makeOneCluster(), reco::PreshowerCluster::operator==(), GsfElectronAlgo::preSelection(), GlobalGsfElectronAlgo::preSelection(), and HFRecoEcalCandidateAlgo::produce().

00078 { return position_.phi(); }

const math::XYZPoint& reco::CaloCluster::position (  )  const [inline]

cluster centroid position

Definition at line 43 of file CaloCluster.h.

References position_.

Referenced by EgammaSCEnergyCorrectionAlgo::applyCorrection(), ConversionTrackCandidateProducer::buildCollections(), SuperClusterShapeAlgo::Calculate_Covariances(), ClusterShapeAlgo::Calculate_EnergyDepTopology(), converter::SuperClusterToCandidate::convert(), DisplayManager::createGCluster(), egammaisolation::EgammaEcalExtractor::deposit(), ZeeCalibration::fillEleInfo(), InOutConversionSeedFinder::findSeeds(), EgammaEcalIsolation::getEcalEtSum(), EcalClusterTools::getEnergyDepTopology(), PreshowerClusterAlgo::makeOneCluster(), HybridClusterAlgo::makeSuperClusters(), SuperClusterEt::operator()(), SuperClusterEtHeepSkim::operator()(), ClusterEtLess::operator()(), reco::PreshowerCluster::operator<(), reco::operator<<(), reco::PreshowerCluster::operator==(), EgammaSCCorrectionMaker::produce(), ElectronRecalibSuperClusterAssociator::produce(), PFAlgo::reconstructCluster(), SubSeedGenerator::run(), InOutConversionSeedFinder::startSeed(), PFBlockAlgo::testPS1AndPS2(), PFBlockAlgo::testPSAndECAL(), and PFBlockAlgo::testTrackAndPS().

00043 { return position_; }

double reco::CaloCluster::x (  )  const [inline]

x coordinate of cluster centroid

Definition at line 66 of file CaloCluster.h.

References position_.

Referenced by GlobalGsfElectronAlgo::calculateTSOS(), GsfElectronAlgo::calculateTSOS(), PreshowerClusterAlgo::makeOneCluster(), HoECalculator::operator()(), GsfElectronAlgo::preSelection(), GlobalGsfElectronAlgo::preSelection(), SoftElectronProducer::produce(), and SubSeedGenerator::run().

00066 { return position_.x(); }

double reco::CaloCluster::y (  )  const [inline]

y coordinate of cluster centroid

Definition at line 69 of file CaloCluster.h.

References position_.

Referenced by GlobalGsfElectronAlgo::calculateTSOS(), GsfElectronAlgo::calculateTSOS(), PreshowerClusterAlgo::makeOneCluster(), HoECalculator::operator()(), GsfElectronAlgo::preSelection(), GlobalGsfElectronAlgo::preSelection(), SoftElectronProducer::produce(), and SubSeedGenerator::run().

00069 { return position_.y(); }

double reco::CaloCluster::z (  )  const [inline]

z coordinate of cluster centroid

Definition at line 72 of file CaloCluster.h.

References position_.

Referenced by GlobalGsfElectronAlgo::calculateTSOS(), GsfElectronAlgo::calculateTSOS(), DisplayManager::createGCluster(), PreshowerClusterAlgo::makeOneCluster(), HoECalculator::operator()(), GsfElectronAlgo::preSelection(), GlobalGsfElectronAlgo::preSelection(), SoftElectronProducer::produce(), and SubSeedGenerator::run().

00072 { return position_.z(); }

Member Data Documentation

CaloID reco::CaloCluster::caloID_ [protected]

bitmask for detector information

Definition at line 102 of file CaloCluster.h.

Referenced by caloID(), operator=(), and reco::PFCluster::setLayer().

double reco::CaloCluster::energy_ [protected]

cluster energy

Definition at line 96 of file CaloCluster.h.

Referenced by PFClusterAlgo::calculateClusterPosition(), reco::PFCluster::energy(), energy(), operator<(), operator<=(), reco::PFCluster::operator=(), operator=(), operator>(), operator>=(), and reco::PFCluster::reset().

math::XYZPoint reco::CaloCluster::position_ [protected]

cluster centroid position

Definition at line 99 of file CaloCluster.h.

Referenced by PFClusterAlgo::calculateClusterPosition(), reco::PFCluster::calculatePositionREP(), eta(), reco::PFCluster::operator=(), operator=(), phi(), position(), reco::PFCluster::reset(), x(), y(), and z().

The documentation for this class was generated from the following file:
Generated on Tue Jun 9 18:50:59 2009 for CMSSW by  doxygen 1.5.4