reco::CaloCluster Class Reference

#include <CaloCluster.h>

Inheritance diagram for reco::CaloCluster:

Public Types
enum	AlgoId {   island = 0, hybrid = 1, fixedMatrix = 2, dynamicHybrid = 3,   multi5x5 = 4, particleFlow = 5, hgcal_em = 6, hgcal_had = 7,   hfnose = 9, undefined = 1000 }
typedef AlgoId	AlgoID
enum	HCalFlags { badHcalMarker = 1 }
enum	SCFlags { cleanOnly = 0, common = 100, uncleanOnly = 200 }

Public Member Functions
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 CaloID &	caloID () 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::XYZPoint &	position () 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...

Protected Attributes
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
static const uint32_t	flagsMask_ = 0x0FFFFFFF
static const uint32_t	flagsOffset_ = 28

Friends
std::ostream &	operator<< (std::ostream &out, const CaloCluster &cluster)
	print me More...

Detailed Description

Base class for all types calorimeter clusters

Author

Shahram Rahatlou, INFN

Comments: modified AlgoId enumeration to include cleaning status flags In summary: algoID_ < 200 object is in clean collection algoID_ >=100 object is in unclean collection

Definition at line 31 of file CaloCluster.h.

Member Typedef Documentation

AlgoID

typedef AlgoId reco::CaloCluster::AlgoID

Definition at line 53 of file CaloCluster.h.

Member Enumeration Documentation

AlgoId

enum reco::CaloCluster::AlgoId

Enumerator
island
hybrid
fixedMatrix
dynamicHybrid
multi5x5
particleFlow
hgcal_em
hgcal_had
hfnose
undefined

Definition at line 33 of file CaloCluster.h.

                {
      island = 0,
      hybrid = 1,
      fixedMatrix = 2,
      dynamicHybrid = 3,
      multi5x5 = 4,
      particleFlow = 5,
      hgcal_em = 6,
      hgcal_had = 7,
      hfnose = 9,
      undefined = 1000
    };

HCalFlags

enum reco::CaloCluster::HCalFlags

Enumerator
badHcalMarker

Definition at line 49 of file CaloCluster.h.

{ badHcalMarker = 1 };

SCFlags

enum reco::CaloCluster::SCFlags

Enumerator
cleanOnly
common
uncleanOnly

Definition at line 47 of file CaloCluster.h.

{ cleanOnly = 0, common = 100, uncleanOnly = 200 };

Constructor & Destructor Documentation

CaloCluster() [1/7]

reco::CaloCluster::CaloCluster ( )

inline

default constructor. Sets energy and position to zero

Definition at line 56 of file CaloCluster.h.

        : energy_(0), correctedEnergy_(-1.0), correctedEnergyUncertainty_(-1.0), algoID_(undefined), flags_(0) {}

CaloCluster() [2/7]

reco::CaloCluster::CaloCluster ( AlgoID  algoID )

inline

constructor with algoId, to be used in all child classes

Definition at line 60 of file CaloCluster.h.

        : energy_(0), correctedEnergy_(-1.0), correctedEnergyUncertainty_(-1.0), algoID_(algoID), flags_(0) {}

CaloCluster() [3/7]

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

inline

Definition at line 63 of file CaloCluster.h.

        : energy_(energy),
          correctedEnergy_(-1.0),
          correctedEnergyUncertainty_(-1.0),
          position_(position),
          caloID_(caloID),
          algoID_(undefined),
          flags_(0) {}

CaloCluster() [4/7]

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

inline

constructor from values

Definition at line 76 of file CaloCluster.h.

        : energy_(energy),
          correctedEnergy_(-1.0),
          correctedEnergyUncertainty_(-1.0),
          position_(position),
          algoID_(undefined),
          flags_(0) {}

CaloCluster() [5/7]

reco::CaloCluster::CaloCluster ( double  energy, const math::XYZPoint &  position, const CaloID &  caloID, const AlgoID &  algoID, uint32_t  flags = 0  )

inline

Definition at line 84 of file CaloCluster.h.

References flags(), flags_, and flagsMask_.

        : energy_(energy),
          correctedEnergy_(-1.0),
          correctedEnergyUncertainty_(-1.0),
          position_(position),
          caloID_(caloID),
          algoID_(algoID) {
      flags_ = flags & flagsMask_;
    }

CaloCluster() [6/7]

reco::CaloCluster::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  )

inline

Definition at line 95 of file CaloCluster.h.

References flags(), flags_, and flagsMask_.

        : energy_(energy),
          correctedEnergy_(-1.0),
          correctedEnergyUncertainty_(-1.0),
          position_(position),
          caloID_(caloID),
          hitsAndFractions_(usedHitsAndFractions),
          algoID_(algoId),
          seedId_(seedId) {
      flags_ = flags & flagsMask_;
    }

CaloCluster() [7/7]

reco::CaloCluster::CaloCluster ( double  energy, const math::XYZPoint &  position, float  chi2, const std::vector< DetId > &  usedHits, const AlgoId  algoId, uint32_t  flags = 0  )

inline

temporary compatibility constructor

Definition at line 115 of file CaloCluster.h.

References flags(), flags_, flagsMask_, hitsAndFractions_, and mps_fire::i.

        : energy_(energy),
          correctedEnergy_(-1.0),
          correctedEnergyUncertainty_(-1.0),
          position_(position),
          algoID_(algoId) {
      hitsAndFractions_.reserve(usedHits.size());
      for (size_t i = 0; i < usedHits.size(); i++)
        hitsAndFractions_.push_back(std::pair<DetId, float>(usedHits[i], 1.));
      flags_ = flags & flagsMask_;
    }

~CaloCluster()

virtual reco::CaloCluster::~CaloCluster ( )

inlinevirtual

destructor

Definition at line 133 of file CaloCluster.h.

{}

Member Function Documentation

addHitAndFraction()

void reco::CaloCluster::addHitAndFraction ( DetId  id, float  fraction  )

inline

Definition at line 202 of file CaloCluster.h.

References HLT_2024v10_cff::fraction, and hitsAndFractions_.

Referenced by reco::PFCluster::addRecHitFraction(), PFEGammaAlgo::buildRefinedSuperCluster(), PFElectronTranslator::createSuperClusters(), and PFECALSuperClusterAlgo::finalizeSuperCluster().

                                                     {
      hitsAndFractions_.push_back(std::pair<DetId, float>(id, fraction));
    }

algo()

AlgoId reco::CaloCluster::algo ( ) const

inline

algorithm identifier

Definition at line 189 of file CaloCluster.h.

References algoID_.

Referenced by algoID(), FWCaloClusterProxyBuilder::build(), PFElectronTranslator::createBasicCluster(), egammaisolation::EgammaEcalExtractor::deposit(), and EgammaEcalIsolation::getEcalEtSum().

{ return algoID_; }

algoID()

AlgoID reco::CaloCluster::algoID ( ) const

inline

Definition at line 190 of file CaloCluster.h.

References algo().

Referenced by reco::operator<<().

{ return algo(); }

caloID()

const CaloID& reco::CaloCluster::caloID ( ) const

inline

Definition at line 200 of file CaloCluster.h.

References caloID_.

Referenced by reco::EcalClustersGraph::clusterPosition(), reco::EcalClustersGraph::computeCovariances(), reco::EcalClustersGraph::computeShowerShapes(), PFElectronTranslator::createBasicCluster(), reco::PFCluster::layer(), and reco::operator<<().

{ return caloID_; }

correctedEnergy()

double reco::CaloCluster::correctedEnergy ( ) const

inline

Definition at line 149 of file CaloCluster.h.

References correctedEnergy_.

Referenced by CalibratedPFCluster::energy(), EcalRegressionData::fill(), and reco::operator<<().

{ return correctedEnergy_; }

correctedEnergyUncertainty()

float reco::CaloCluster::correctedEnergyUncertainty ( ) const

inline

Definition at line 150 of file CaloCluster.h.

References correctedEnergyUncertainty_.

{ return correctedEnergyUncertainty_; }

energy()

double reco::CaloCluster::energy ( ) const

inline

cluster energy

Definition at line 148 of file CaloCluster.h.

References energy_.

Referenced by ESRecoSummary::analyze(), ElectronCalibration::analyze(), ElectronCalibrationUniv::analyze(), FWCaloClusterProxyBuilder::build(), FWTracksterHitsProxyBuilder::build(), FWTracksterLayersProxyBuilder::build(), ConversionTrackCandidateProducer::buildCollections(), ClusterShapeAlgo::calc_AbsZernikeMoment(), EcalClusterToolsT< noZS >::calc_AbsZernikeMoment(), HLTEcalResonanceFilter::calcPaircluster(), HLTRegionalEcalResonanceFilter::calcPaircluster(), ClusterShapeAlgo::Calculate_BarrelBasketEnergyFraction(), SuperClusterShapeAlgo::Calculate_Covariances(), ClusterShapeAlgo::Calculate_EnergyDepTopology(), reco::EcalClustersGraph::computeCovariances(), reco::EcalClustersGraph::computeShowerShapes(), reco::EcalClustersGraph::computeVariables(), converter::SuperClusterToCandidate::convert(), EGEnergyCorrector::CorrectedEnergyWithError(), GsfElectronAlgo::createElectron(), TrackingRegionsFromSuperClustersProducer::createTrackingRegion(), egammaisolation::EgammaEcalExtractor::deposit(), egamma::ecalClusterEnergyUncertaintyElectronSpecific(), EcalClusterToolsT< noZS >::energyBasketFractionEta(), EcalClusterToolsT< noZS >::energyBasketFractionPhi(), ticl::PatternRecognitionbyCLUE3D< TILES >::energyRegressionAndID(), ticl::PatternRecognitionbyCA< TILES >::energyRegressionAndID(), ticl::PatternRecognitionbyFastJet< TILES >::energyRegressionAndID(), TrackstersMergeProducerV3::energyRegressionAndID(), TrackstersMergeProducer::energyRegressionAndID(), reco::PreshowerCluster::et(), ClusterShapeAlgo::fast_AbsZernikeMoment(), EcalClusterToolsT< noZS >::fast_AbsZernikeMoment(), ZeeCalibration::fillEleInfo(), PFEGammaAlgo::fillPFCandidates(), PFECALSuperClusterAlgo::finalizeSuperCluster(), EcalClusterSeverityLevelAlgo::fractionAroundClosestProblematic(), EcalClusterIsoCalculator::getBkgSubEcalClusterIso(), EcalClusterIsoCalculator::getEcalClusterIso(), EgammaEcalIsolation::getEcalEtSum(), EcalClusterToolsT< noZS >::getEnergyDepTopology(), SCEnergyCorrectorSemiParm::getRegDataECALV1(), SCEnergyCorrectorSemiParm::getRegDataHGCALV1(), EcalClusterEnergyCorrection::getValue(), EcalClusterEnergyUncertainty::getValue(), EcalClusterCrackCorrection::getValue(), hgcal::ClusterTools::getWidths(), EcalClusterSeverityLevelAlgo::goodFraction(), PFElecTkProducer::isSharingEcalEnergyWithEgSC(), egammaTools::localEcalClusterCoordsEB(), egammaTools::localEcalClusterCoordsEE(), Multi5x5BremRecoveryClusterAlgo::makeIslandSuperClusters(), PreshowerClusterAlgo::makeOneCluster(), OutInConversionSeedFinder::makeSeeds(), HybridClusterAlgo::makeSuperClusters(), EGRegressionModifierV1::modifyObject(), EcalBasicClusterLocalContCorrection::operator()(), reco::PreshowerCluster::operator<(), reco::operator<<(), HFRecoEcalCandidateAlgo::produce(), EcalDigiSelector::produce(), UncleanSCRecoveryProducer::produce(), HiEgammaSCCorrectionMaker::produce(), EgammaSCCorrectionMaker::produce(), UnifiedSCCollectionProducer::produce(), PreshowerPhiClusterProducer::produce(), PreshowerClusterProducer::produce(), Jet.Jet::rawEnergy(), SuperClusterHelper::seedEnergy(), setEnergy(), SuperClusterHelper::sortClusters(), and SuperClusterHelper::SuperClusterHelper().

{ return energy_; }

eta()

double reco::CaloCluster::eta ( ) const

inline

pseudorapidity of cluster centroid

Definition at line 180 of file CaloCluster.h.

References position_.

Referenced by Particle.Particle::__str__(), EgammaIsoESDetIdCollectionProducer::addDetIds(), ElectronCalibration::analyze(), ConversionTrackCandidateProducer::buildCollections(), HLTEcalResonanceFilter::calcPaircluster(), EgammaSuperClusters::closestMCParticle(), EgammaTowerIsolationNew< NC >::compute(), hgcal::EGammaPCAHelper::computeShowerWidth(), reco::EcalClustersGraph::computeVariables(), EGEnergyCorrector::CorrectedEnergyWithError(), datamodel.Object::DeltaR(), egammaisolation::EgammaEcalExtractor::deposit(), egamma::ecalClusterEnergyUncertaintyElectronSpecific(), PFEnergyCalibration::energyEm(), ticl::PatternRecognitionbyCLUE3D< TILES >::energyRegressionAndID(), ticl::PatternRecognitionbyCA< TILES >::energyRegressionAndID(), ticl::PatternRecognitionbyFastJet< TILES >::energyRegressionAndID(), TrackstersMergeProducerV3::energyRegressionAndID(), TrackstersMergeProducer::energyRegressionAndID(), EcalClusterLazyToolsBase::eseffsirir(), EcalClusterLazyToolsBase::eseffsixix(), EcalClusterLazyToolsBase::eseffsiyiy(), reco::PreshowerCluster::et(), SuperClusterHelper::eta(), EcalRegressionData::fill(), HGVHistoProducerAlgo::fill_cluster_histos(), EgammaEcalIsolation::getEcalEtSum(), EGRegressionModifierV3::getRegData(), SCEnergyCorrectorSemiParm::getRegDataECALHLTV1(), SCEnergyCorrectorSemiParm::getRegDataECALV1(), SCEnergyCorrectorSemiParm::getRegDataHGCALHLTV1(), SCEnergyCorrectorSemiParm::getRegDataHGCALV1(), EcalClusterEnergyCorrection::getValue(), EcalClusterEnergyCorrectionObjectSpecific::getValue(), EcalClusterEnergyUncertainty::getValue(), EcalClusterCrackCorrection::getValue(), Jet.Jet::jetID(), egammaTools::localEcalClusterCoordsEE(), PreshowerClusterAlgo::makeOneCluster(), EGRegressionModifierV1::modifyObject(), datamodel.Object::p4(), HFRecoEcalCandidateAlgo::produce(), EcalDigiSelector::produce(), UncleanSCRecoveryProducer::produce(), UnifiedSCCollectionProducer::produce(), AlCaECALRecHitReducer::produce(), Jet.Jet::puJetId(), SuperClusterHelper::seedEta(), FWPFBlockProxyBuilder::setupClusterElement(), FWPFClusterLegoProxyBuilder::sharedBuild(), FWECALCaloDataDetailViewBuilder::superClusterEtaLess(), FWECALDetailViewBuilder::superClusterEtaLess(), and SuperClusterHelper::SuperClusterHelper().

{ return position_.eta(); }

flags()

uint32_t reco::CaloCluster::flags ( ) const

inline

Definition at line 192 of file CaloCluster.h.

References flags_, and flagsMask_.

Referenced by CaloCluster(), isInClean(), isInUnclean(), setFlags(), and reco::SuperCluster::setPreshowerPlanesStatus().

{ return flags_ & flagsMask_; }

hitsAndFractions()

const std::vector<std::pair<DetId, float> >& reco::CaloCluster::hitsAndFractions ( ) const

inline

replace getHitsByDetId() : return hits by DetId and their corresponding fraction of energy considered to compute the total cluster energy

Definition at line 209 of file CaloCluster.h.

References hitsAndFractions_.

Referenced by FWPFCandidateWithHitsProxyBuilder::addHitsForCandidate(), AlCaECALRecHitReducer::AddMiniRecHitCollection(), ElectronCalibration::analyze(), ElectronCalibrationUniv::analyze(), FWCaloClusterProxyBuilder::build(), FWTracksterHitsProxyBuilder::build(), GenericSimClusterMapper::buildClusters(), PFClusterFromHGCalTrackster::buildClusters(), RealisticSimClusterMapper::buildClusters(), HLTEcalResonanceFilter::calcShowerShape(), HLTRegionalEcalResonanceFilter::calcShowerShape(), PhotonIsolationCalculator::calculate(), ClusterShapeAlgo::Calculate_2ndEnergy(), ClusterShapeAlgo::Calculate_BarrelBasketEnergyFraction(), SuperClusterShapeAlgo::Calculate_Covariances(), ClusterShapeAlgo::Calculate_EnergyDepTopology(), ClusterShapeAlgo::Calculate_TopEnergy(), GsfElectronAlgo::calculateShowerShape(), PhotonIsolationCalculator::classify(), EcalClusterToolsT< noZS >::cluster2ndMoments(), reco::EcalClustersGraph::computeCovariances(), reco::EcalClustersGraph::computeShowerShapes(), reco::EcalClustersGraph::computeVariables(), EcalClusterToolsT< noZS >::covariances(), PFElectronTranslator::createBasicCluster(), HGCalShowerShapeHelper::createCalc(), GsfElectronAlgo::createElectron(), EcalClusterToolsT< noZS >::e1x3(), EcalClusterToolsT< noZS >::e1x5(), EcalClusterToolsT< noZS >::e2nd(), EcalClusterToolsT< noZS >::e2x2(), EcalClusterToolsT< noZS >::e2x5Bottom(), EcalClusterToolsT< noZS >::e2x5Left(), EcalClusterToolsT< noZS >::e2x5Max(), EcalClusterToolsT< noZS >::e2x5Right(), EcalClusterToolsT< noZS >::e2x5Top(), EcalClusterToolsT< noZS >::e3x1(), EcalClusterToolsT< noZS >::e3x2(), EcalClusterToolsT< noZS >::e3x3(), EcalClusterToolsT< noZS >::e4x4(), EcalClusterToolsT< noZS >::e5x1(), EcalClusterToolsT< noZS >::e5x5(), EcalClusterToolsT< noZS >::eBottom(), EcalClusterToolsT< noZS >::eLeft(), EcalClusterToolsT< noZS >::eMax(), EcalClusterToolsT< noZS >::energyBasketFractionEta(), EcalClusterToolsT< noZS >::energyBasketFractionPhi(), ticl::PatternRecognitionbyCLUE3D< TILES >::energyRegressionAndID(), ticl::PatternRecognitionbyCA< TILES >::energyRegressionAndID(), ticl::PatternRecognitionbyFastJet< TILES >::energyRegressionAndID(), TrackstersMergeProducerV3::energyRegressionAndID(), TrackstersMergeProducer::energyRegressionAndID(), EcalClusterToolsT< noZS >::eRight(), EcalClusterToolsT< noZS >::eTop(), egHLT::OffHelper::fillClusShapeData(), reco::EcalClustersGraph::fillHits(), HGVHistoProducerAlgo::findmaxhit(), EcalClusterSeverityLevelAlgo::fractionAroundClosestProblematic(), hgcal::ClusterTools::getClusterHadronFraction(), EcalClusterLazyToolsBase::getEcalRecHitCollection(), EcalClusterToolsT< noZS >::getEnergyDepTopology(), EcalClusterToolsT< noZS >::getMaximum(), SCEnergyCorrectorSemiParm::getRegDataECALHLTV1(), SCEnergyCorrectorSemiParm::getRegDataECALV1(), SCEnergyCorrectorSemiParm::getRegDataHGCALV1(), EcalClusterCrackCorrection::getValue(), hgcal::ClusterTools::getWidths(), EcalClusterSeverityLevelAlgo::goodFraction(), EcalClusterToolsT< noZS >::localCovariances(), egammaTools::localEcalClusterCoordsEB(), egammaTools::localEcalClusterCoordsEE(), EcalClusterToolsT< noZS >::matrixEnergy(), EcalClusterToolsT< noZS >::matrixSize(), EcalClusterToolsT< noZS >::mean5x5PositionInLocalCrysCoord(), EcalClusterToolsT< noZS >::mean5x5PositionInXY(), EcalClusterToolsT< noZS >::meanClusterPosition(), EcalClusterToolsT< noZS >::n5x5(), EcalBasicClusterLocalContCorrection::operator()(), reco::operator<<(), ClusterClusterMapping::overlap(), reco::PreshowerCluster::PreshowerCluster(), HGCalLayerClusterProducer::produce(), EcalClusterToolsT< noZS >::roundnessBarrelSuperClusters(), EcalClusterToolsT< noZS >::roundnessBarrelSuperClustersUserExtended(), EcalClusterToolsT< noZS >::scLocalCovariances(), GsfElectronAlgo::setCutBasedPreselectionFlag(), egamma::sharedEnergy(), FWECALCaloDataDetailViewBuilder::showSuperCluster(), FWECALDetailViewBuilder::showSuperCluster(), hgcal::EGammaPCAHelper::storeRecHits(), and egamma::towerOf().

{ return hitsAndFractions_; }

isInClean()

bool reco::CaloCluster::isInClean ( ) const

inline

Definition at line 197 of file CaloCluster.h.

References flags(), and uncleanOnly.

Referenced by UncleanSCRecoveryProducer::produce(), and UnifiedSCCollectionProducer::produce().

{ return flags() < uncleanOnly; }

isInUnclean()

bool reco::CaloCluster::isInUnclean ( ) const

inline

Definition at line 198 of file CaloCluster.h.

References common, and flags().

Referenced by UncleanSCRecoveryProducer::produce(), and UnifiedSCCollectionProducer::produce().

{ return flags() >= common; }

operator<()

bool reco::CaloCluster::operator< ( const CaloCluster &  rhs ) const

inline

comparison < operator

Definition at line 165 of file CaloCluster.h.

References energy_.

{ return (energy_ < rhs.energy_); }

operator<=()

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

inline

comparison <= operator

Definition at line 162 of file CaloCluster.h.

References energy_.

{ return (energy_ <= rhs.energy_); }

operator==()

bool reco::CaloCluster::operator== ( const CaloCluster &  rhs ) const

inline

comparison == operator

Definition at line 168 of file CaloCluster.h.

References energy_.

{ return (energy_ == rhs.energy_); };

operator>()

bool reco::CaloCluster::operator> ( const CaloCluster &  rhs ) const

inline

comparison > operator

Definition at line 159 of file CaloCluster.h.

References energy_.

{ return (energy_ > rhs.energy_); }

operator>=()

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

inline

comparison >= operator

Definition at line 156 of file CaloCluster.h.

References energy_.

{ return (energy_ >= rhs.energy_); }

phi()

double reco::CaloCluster::phi ( ) const

inline

azimuthal angle of cluster centroid

Definition at line 183 of file CaloCluster.h.

References position_.

Referenced by Particle.Particle::__str__(), EgammaIsoESDetIdCollectionProducer::addDetIds(), HLTEcalResonanceFilter::calcPaircluster(), EgammaSuperClusters::closestMCParticle(), EgammaTowerIsolationNew< NC >::compute(), hgcal::EGammaPCAHelper::computeShowerWidth(), reco::EcalClustersGraph::computeVariables(), EGEnergyCorrector::CorrectedEnergyWithError(), datamodel.Object::DeltaR(), egammaisolation::EgammaEcalExtractor::deposit(), PFEnergyCalibration::energyEm(), ticl::PatternRecognitionbyCLUE3D< TILES >::energyRegressionAndID(), ticl::PatternRecognitionbyCA< TILES >::energyRegressionAndID(), ticl::PatternRecognitionbyFastJet< TILES >::energyRegressionAndID(), TrackstersMergeProducerV3::energyRegressionAndID(), TrackstersMergeProducer::energyRegressionAndID(), EcalRegressionData::fill(), EGRegressionModifierV3::getRegData(), SCEnergyCorrectorSemiParm::getRegDataECALV1(), SCEnergyCorrectorSemiParm::getRegDataHGCALV1(), PreshowerClusterAlgo::makeOneCluster(), EGRegressionModifierV1::modifyObject(), reco::PreshowerCluster::operator==(), datamodel.Object::p4(), SuperClusterHelper::phi(), ntupleDataFormat.Track::phiPull(), HFRecoEcalCandidateAlgo::produce(), SuperClusterHelper::seedPhi(), FWPFBlockProxyBuilder::setupClusterElement(), FWPFClusterLegoProxyBuilder::sharedBuild(), and SuperClusterHelper::SuperClusterHelper().

{ return position_.phi(); }

position()

const math::XYZPoint& reco::CaloCluster::position ( ) const

inline

cluster centroid position

Definition at line 153 of file CaloCluster.h.

References position_.

Referenced by ContainmentCorrectionAnalyzer::analyze(), FWCaloClusterProxyBuilder::build(), FWTracksterHitsProxyBuilder::build(), FWTracksterLayersProxyBuilder::build(), ConversionTrackCandidateProducer::buildCollections(), HLTRegionalEcalResonanceFilter::calcPaircluster(), SuperClusterShapeAlgo::Calculate_Covariances(), ClusterShapeAlgo::Calculate_EnergyDepTopology(), reco::EcalClustersGraph::clusterPosition(), reco::EcalClustersGraph::computeCovariances(), converter::SuperClusterToCandidate::convert(), PFElectronTranslator::createBasicCluster(), GsfElectronAlgo::createElectron(), TrackingRegionsFromSuperClustersProducer::createTrackingRegion(), egammaisolation::EgammaEcalExtractor::deposit(), ZeeCalibration::fillEleInfo(), PFEGammaAlgo::fillPFCandidates(), PFECALSuperClusterAlgo::finalizeSuperCluster(), InOutConversionSeedFinder::findSeeds(), EgammaEcalIsolation::getEcalEtSum(), EcalClusterToolsT< noZS >::getEnergyDepTopology(), EgammaHcalIsolation::getHcalESum(), EgammaHcalIsolation::getHcalESumBc(), EgammaHcalIsolation::getHcalEtSum(), EgammaHcalIsolation::getHcalEtSumBc(), EgammaRecHitIsolation::getSum_(), EcalClusterCrackCorrection::getValue(), hgcal::ClusterTools::getWidths(), PFlow2DClusterizerWithTime::growPFClusters(), PFElecTkProducer::isSharingEcalEnergyWithEgSC(), egammaTools::localEcalClusterCoordsEB(), egammaTools::localEcalClusterCoordsEE(), Multi5x5BremRecoveryClusterAlgo::makeIslandSuperClusters(), PreshowerClusterAlgo::makeOneCluster(), OutInConversionSeedFinder::makeSeeds(), HybridClusterAlgo::makeSuperClusters(), ConversionTools::matchesConversion(), EcalBasicClusterLocalContCorrection::operator()(), reco::PreshowerCluster::operator<(), reco::operator<<(), reco::PreshowerCluster::operator==(), UncleanSCRecoveryProducer::produce(), HiEgammaSCCorrectionMaker::produce(), EgammaSCCorrectionMaker::produce(), SimPFProducer::produce(), PFAlgo::reconstructCluster(), KDTreeLinkerPSEcal::searchLinks(), InOutConversionSeedFinder::startSeed(), LinkByRecHit::testECALAndPSByRecHit(), LinkByRecHit::testHFEMAndHFHADByRecHit(), and LinkByRecHit::testTrackAndClusterByRecHit().

{ return position_; }

printHitAndFraction()

string CaloCluster::printHitAndFraction

(

unsigned

i

)

const

print hitAndFraction

Definition at line 15 of file CaloCluster.cc.

References mps_fire::i, and MillePedeFileConverter_cfg::out.

Referenced by reco::operator<<().

                                                        {
  ostringstream out;
  if (i >= hitsAndFractions().size())  // i >= 0, since i is unsigned
    out << "out of range " << i;
  else
    out << "( " << hitsAndFractions()[i].first << ", " << hitsAndFractions()[i].second << " )";
  return out.str();
}

reset()

void CaloCluster::reset

(

void

)

resets the CaloCluster (position, energy, hitsAndFractions)

Definition at line 9 of file CaloCluster.cc.

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

                        {
  position_ = math::XYZPoint();
  energy_ = 0;
  hitsAndFractions_.clear();
}

seed()

DetId reco::CaloCluster::seed ( ) const

inline

return DetId of seed

Definition at line 218 of file CaloCluster.h.

References seedId_.

Referenced by PFMultiDepthClusterizer::absorbCluster(), EcalClusterLazyToolsBase::BasicClusterSeedTime(), FWCaloClusterProxyBuilder::build(), FWTracksterHitsProxyBuilder::build(), FWTracksterLayersProxyBuilder::build(), HLTEcalResonanceFilter::calcShowerShape(), HLTRegionalEcalResonanceFilter::calcShowerShape(), Cluster3DPCACalculator::calculateAndSetPositionActual(), ECAL2DPositionCalcWithDepthCorr::calculateAndSetPositionActual(), Basic2DGenericPFlowPositionCalc::calculateAndSetPositionActual(), GsfElectronAlgo::calculateSaturationInfo(), PFlow2DClusterizerWithTime::clusterTimeResolutionFromSeed(), PFClusterEMEnergyCorrector::correctEnergies(), PFElectronTranslator::createBasicCluster(), GEDPhotonProducer::fillPhotonCollection(), SCEnergyCorrectorSemiParm::getCorrections(), SCEnergyCorrectorSemiParm::getRegData(), SCEnergyCorrectorSemiParm::getRegDataECALV1(), EGRegressionModifierV3::getSeedCrysCoord(), PFlow2DClusterizerWithTime::growPFClusters(), EGRegressionModifierV1::modifyObject(), EcalBasicClusterLocalContCorrection::operator()(), and egamma::towerOf().

{ return seedId_; }

setAlgoId()

void reco::CaloCluster::setAlgoId ( const AlgoId &  id )

inline

Definition at line 143 of file CaloCluster.h.

References algoID_, and l1ctLayer2EG_cff::id.

{ algoID_ = id; }

setCaloId()

void reco::CaloCluster::setCaloId ( const CaloID &  id )

inline

Definition at line 141 of file CaloCluster.h.

References caloID_, and l1ctLayer2EG_cff::id.

{ caloID_ = id; }

setCorrectedEnergy()

void reco::CaloCluster::setCorrectedEnergy ( double  cenergy )

inline

Definition at line 136 of file CaloCluster.h.

References correctedEnergy_.

Referenced by GenericSimClusterMapper::buildClusters(), PFClusterFromHGCalTrackster::buildClusters(), RealisticSimClusterMapper::buildClusters(), PFEGammaAlgo::buildRefinedSuperCluster(), PFClusterEMEnergyCorrector::correctEnergies(), PFECALSuperClusterAlgo::finalizeSuperCluster(), SCEnergyCorrectorSemiParm::modifyObject(), and LowPtGsfElectronSCProducer::produce().

{ correctedEnergy_ = cenergy; }

setCorrectedEnergyUncertainty()

void reco::CaloCluster::setCorrectedEnergyUncertainty ( float  energyerr )

inline

Definition at line 137 of file CaloCluster.h.

References correctedEnergyUncertainty_.

Referenced by PFClusterEMEnergyCorrector::correctEnergies(), and SCEnergyCorrectorSemiParm::modifyObject().

{ correctedEnergyUncertainty_ = energyerr; }

setEnergy()

void reco::CaloCluster::setEnergy ( double  energy )

inline

Definition at line 135 of file CaloCluster.h.

References energy(), and energy_.

Referenced by EgammaSCEnergyCorrectionAlgo::applyCorrection(), EgammaSCEnergyCorrectionAlgo::applyCrackCorrection(), EgammaSCEnergyCorrectionAlgo::applyLocalContCorrection(), Basic2DClusterForEachSeed::buildClusters(), GenericSimClusterMapper::buildClusters(), PFClusterFromHGCalTrackster::buildClusters(), RealisticSimClusterMapper::buildClusters(), Cluster3DPCACalculator::calculateAndSetPositionActual(), ECAL2DPositionCalcWithDepthCorr::calculateAndSetPositionActual(), Basic2DGenericPFlowPositionCalc::calculateAndSetPositionActual(), and SCEnergyCorrectorSemiParm::modifyObject().

{ energy_ = energy; }

setFlags()

void reco::CaloCluster::setFlags ( uint32_t  flags )

inline

Definition at line 193 of file CaloCluster.h.

References flags(), flags_, and flagsMask_.

Referenced by HiEgammaSCEnergyCorrectionAlgo::applyCorrection(), UncleanSCRecoveryProducer::produce(), and UnifiedSCCollectionProducer::produce().

                                  {
      uint32_t reserved = (flags_ & ~flagsMask_);
      flags_ = (reserved) | (flags & flagsMask_);
    }

setPosition()

void reco::CaloCluster::setPosition ( const math::XYZPoint &  p )

inline

Definition at line 139 of file CaloCluster.h.

References AlCaHLTBitMon_ParallelJobs::p, and position_.

Referenced by Basic2DClusterForEachSeed::buildClusters(), Cluster3DPCACalculator::calculateAndSetPositionActual(), ECAL2DPositionCalcWithDepthCorr::calculateAndSetPositionActual(), Basic2DGenericPFlowPositionCalc::calculateAndSetPositionActual(), and HGCalLayerClusterProducer::produce().

{ position_ = p; }

setSeed()

void reco::CaloCluster::setSeed ( const DetId &  id )

inline

Definition at line 145 of file CaloCluster.h.

References l1ctLayer2EG_cff::id, and seedId_.

Referenced by Basic2DClusterForEachSeed::buildClusters(), GenericSimClusterMapper::buildClusters(), PFClusterFromHGCalTrackster::buildClusters(), RealisticSimClusterMapper::buildClusters(), Basic2DGenericPFlowClusterizer::seedPFClustersFromTopo(), and PFlow2DClusterizerWithTime::seedPFClustersFromTopo().

{ seedId_ = id; }

size()

size_t reco::CaloCluster::size ( void  ) const

inline

size in number of hits (e.g. in crystals for ECAL)

Definition at line 186 of file CaloCluster.h.

References hitsAndFractions_.

Referenced by ntupleDataFormat._Collection::__iter__(), ntupleDataFormat._Collection::__len__(), FWTracksterLayersProxyBuilder::build(), EcalClusterLazyToolsBase::getEcalRecHitCollection(), and HGCalLayerClusterProducer::produce().

{ return hitsAndFractions_.size(); }

x()

double reco::CaloCluster::x ( ) const

inline

x coordinate of cluster centroid

Definition at line 171 of file CaloCluster.h.

References position_.

Referenced by svgfig.Curve.Sample::__repr__(), svgfig.Ellipse::__repr__(), FWPFClusterRPZProxyBuilder::build(), FWPFClusterRPZUtils::buildRhoPhiClusterLineSet(), FWPFClusterRPZUtils::buildRhoZClusterLineSet(), EcalClusterLazyToolsBase::eseffsirir(), EcalClusterLazyToolsBase::eseffsixix(), EcalClusterLazyToolsBase::eseffsiyiy(), EcalClusterIsoCalculator::getBkgSubEcalClusterIso(), EcalClusterIsoCalculator::getEcalClusterIso(), PreshowerClusterAlgo::makeOneCluster(), EgammaHLTGsfTrackVarProducer::GsfTrackExtrapolations::operator()(), geometryXMLparser.Alignable::pos(), ntupleDataFormat._HitObject::r(), ntupleDataFormat._HitObject::r3D(), FWPFBlockProxyBuilder::setupClusterElement(), FWPFClusterRPZProxyBuilder::sharedBuild(), and FWPFClusterLegoProxyBuilder::sharedBuild().

{ return position_.x(); }

y()

double reco::CaloCluster::y ( ) const

inline

y coordinate of cluster centroid

Definition at line 174 of file CaloCluster.h.

References position_.

Referenced by svgfig.Ellipse::__repr__(), FWPFClusterRPZProxyBuilder::build(), FWPFClusterRPZUtils::buildRhoPhiClusterLineSet(), FWPFClusterRPZUtils::buildRhoZClusterLineSet(), EcalClusterLazyToolsBase::eseffsirir(), EcalClusterLazyToolsBase::eseffsixix(), EcalClusterLazyToolsBase::eseffsiyiy(), EcalClusterIsoCalculator::getBkgSubEcalClusterIso(), EcalClusterIsoCalculator::getEcalClusterIso(), PreshowerClusterAlgo::makeOneCluster(), EgammaHLTGsfTrackVarProducer::GsfTrackExtrapolations::operator()(), geometryXMLparser.Alignable::pos(), ntupleDataFormat._HitObject::r(), ntupleDataFormat._HitObject::r3D(), FWPFBlockProxyBuilder::setupClusterElement(), FWPFClusterRPZProxyBuilder::sharedBuild(), and FWPFClusterLegoProxyBuilder::sharedBuild().

{ return position_.y(); }

z()

double reco::CaloCluster::z ( ) const

inline

z coordinate of cluster centroid

Definition at line 177 of file CaloCluster.h.

References position_.

Referenced by FWPFClusterRPZProxyBuilder::build(), FWPFClusterRPZUtils::buildRhoPhiClusterLineSet(), FWPFClusterRPZUtils::buildRhoZClusterLineSet(), EcalClusterLazyToolsBase::eseffsirir(), EcalClusterLazyToolsBase::eseffsixix(), EcalClusterLazyToolsBase::eseffsiyiy(), EcalClusterIsoCalculator::getBkgSubEcalClusterIso(), EcalClusterIsoCalculator::getEcalClusterIso(), PreshowerClusterAlgo::makeOneCluster(), EgammaHLTGsfTrackVarProducer::GsfTrackExtrapolations::operator()(), geometryXMLparser.Alignable::pos(), ntupleDataFormat._HitObject::r3D(), FWPFBlockProxyBuilder::setupClusterElement(), FWPFClusterRPZProxyBuilder::sharedBuild(), and FWPFClusterLegoProxyBuilder::sharedBuild().

{ return position_.z(); }

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  out, const CaloCluster &  cluster  )

friend

print me

Member Data Documentation

algoID_

AlgoID reco::CaloCluster::algoID_

protected

Definition at line 236 of file CaloCluster.h.

Referenced by algo(), and setAlgoId().

caloID_

CaloID reco::CaloCluster::caloID_

protected

bitmask for detector information

Definition at line 230 of file CaloCluster.h.

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

correctedEnergy_

double reco::CaloCluster::correctedEnergy_

protected

Definition at line 223 of file CaloCluster.h.

Referenced by correctedEnergy(), and setCorrectedEnergy().

correctedEnergyUncertainty_

float reco::CaloCluster::correctedEnergyUncertainty_

protected

Definition at line 224 of file CaloCluster.h.

Referenced by correctedEnergyUncertainty(), and setCorrectedEnergyUncertainty().

energy_

double reco::CaloCluster::energy_

protected

cluster energy

Definition at line 222 of file CaloCluster.h.

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

flags_

uint32_t reco::CaloCluster::flags_

protected

flags (e.g. for handling of cleaned/uncleaned SC) 4 most significant bits reserved 28 bits for handling of cleaned/uncleaned

Definition at line 244 of file CaloCluster.h.

Referenced by CaloCluster(), flags(), reco::SuperCluster::getPreshowerPlanesStatus(), setFlags(), and reco::SuperCluster::setPreshowerPlanesStatus().

flagsMask_

const uint32_t reco::CaloCluster::flagsMask_ = 0x0FFFFFFF

staticprotected

Definition at line 246 of file CaloCluster.h.

Referenced by CaloCluster(), flags(), setFlags(), and reco::SuperCluster::setPreshowerPlanesStatus().

flagsOffset_

const uint32_t reco::CaloCluster::flagsOffset_ = 28

staticprotected

Definition at line 247 of file CaloCluster.h.

Referenced by reco::SuperCluster::getPreshowerPlanesStatus(), and reco::SuperCluster::setPreshowerPlanesStatus().

hitsAndFractions_

std::vector<std::pair<DetId, float> > reco::CaloCluster::hitsAndFractions_

protected

Definition at line 233 of file CaloCluster.h.

Referenced by addHitAndFraction(), CaloCluster(), reco::SuperCluster::clearHitsAndFractions(), hitsAndFractions(), reco::PreshowerCluster::nhits(), reco::PreshowerCluster::PreshowerCluster(), reco::PFCluster::pruneUsing(), reco::PFCluster::resetHitsAndFractions(), and size().

position_

math::XYZPoint reco::CaloCluster::position_

protected

cluster centroid position

Definition at line 227 of file CaloCluster.h.

Referenced by reco::PFCluster::calculatePositionREP(), eta(), phi(), position(), reco::PFCluster::pt(), reco::PFCluster::reset(), setPosition(), reco::PFCluster::theta(), x(), y(), and z().

seedId_

DetId reco::CaloCluster::seedId_

protected

DetId of seed.

Definition at line 239 of file CaloCluster.h.

Referenced by seed(), and setSeed().