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

#include <PFCluster.h>

Inheritance diagram for reco::PFCluster:

Public Types
typedef std::vector< std::pair < CaloClusterPtr::key_type, edm::Ptr< PFCluster > > >	EEtoPSAssociation

typedef ROOT::Math::PositionVector3D < ROOT::Math::CylindricalEta3D < Double32_t > >	REPPoint

Public Types inherited from reco::CaloCluster
enum	AlgoId { island = 0, hybrid = 1, fixedMatrix = 2, dynamicHybrid = 3, multi5x5 = 4, particleFlow = 5, undefined = 1000 }

typedef AlgoId	AlgoID

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	energy () const
	cluster energy More...

PFLayer::Layer	layer () const
	cluster layer, see PFLayer.h in this directory More...

PFCluster &	operator= (const PFCluster &)

	PFCluster ()

	PFCluster (PFLayer::Layer layer, double energy, double x, double y, double z)
	constructor More...

const REPPoint &	positionREP () 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	setLayer (PFLayer::Layer layer)
	set layer More...

void	setTime (double time)

double	theta () const
	angle More...

double	time () const
	cluster time More...

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 CaloID &	caloID () const

double	correctedEnergy () 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	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...

PFLayer::Layer	layer_
	transient layer More...

REPPoint	posrep_
	cluster position: rho, eta, phi (transient) More...

std::vector < reco::PFRecHitFraction >	rechits_
	vector of rechit fractions (transient) More...

double	time_
	Michalis :Add timing information. More...

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_

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

Additional Inherited Members
Protected Attributes inherited from reco::CaloCluster
AlgoID	algoID_

CaloID	caloID_
	bitmask for detector information More...

double	correctedEnergy_

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

typedef std::vector<std::pair<CaloClusterPtr::key_type,edm::Ptr<PFCluster> > > reco::PFCluster::EEtoPSAssociation

Definition at line 50 of file PFCluster.h.

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

Definition at line 51 of file PFCluster.h.

Constructor & Destructor Documentation

reco::PFCluster::PFCluster ( )

inline

Definition at line 53 of file PFCluster.h.

53 : CaloCluster(CaloCluster::particleFlow), time_(-99.0), layer_(PFLayer::NONE), color_(1) {}

reco::CaloCluster::particleFlow

Definition: CaloCluster.h:32

reco::PFCluster::layer_

PFLayer::Layer layer_

transient layer

Definition: PFCluster.h:176

reco::PFCluster::time_

double time_

Michalis :Add timing information.

Definition: PFCluster.h:173

reco::CaloCluster::CaloCluster

CaloCluster()

default constructor. Sets energy and position to zero

Definition: CaloCluster.h:42

reco::PFCluster::color_

int color_

color (transient)

Definition: PFCluster.h:213

PFLayer::NONE

Definition: PFLayer.h:35

PFCluster::PFCluster	(	PFLayer::Layer	layer,
		double	energy,
		double	x,
		double	y,
		double	z
	)

constructor

Definition at line 23 of file PFCluster.cc.

                                                     : 
   CaloCluster( energy, 
            math::XYZPoint(x,y,z), 
            PFLayer::toCaloID(layer),
            CaloCluster::particleFlow ),
   posrep_( position_.Rho(), position_.Eta(), position_.Phi() ),
   time_(-99.),
   layer_(layer),
   color_(2)
 {  }

Member Function Documentation

void PFCluster::addRecHitFraction ( const reco::PFRecHitFraction & frac )

add a given fraction of the rechit

Definition at line 56 of file PFCluster.cc.

References reco::CaloCluster::addHitAndFraction(), reco::PFRecHitFraction::fraction(), reco::PFRecHitFraction::recHitRef(), and rechits_.

Referenced by Basic2DGenericTopoClusterizer::buildTopoCluster(), Basic2DGenericPFlowClusterizer::seedPFClustersFromTopo(), and PFlow2DClusterizerWithTime::seedPFClustersFromTopo().

                                                                     {
 
   rechits_.push_back( frac );
 
   addHitAndFraction( frac.recHitRef()->detId(), 
              frac.fraction() );
 }

void reco::PFCluster::calculatePositionREP ( )

inline

computes posrep_ once and for all

Definition at line 90 of file PFCluster.h.

References reco::CaloCluster::position_, and posrep_.

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

                                 {
       posrep_.SetCoordinates( position_.Rho(), 
                   position_.Eta(), 
                   position_.Phi() ); 
     }

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 129 of file PFCluster.h.

129 { return 0;}

int reco::PFCluster::color ( ) const

inline

Returns: color

Definition at line 104 of file PFCluster.h.

References color_.

Referenced by cuy.plotElement::__init__(), cuy.superimposeElement::__init__(), cuy.graphElement::__init__(), and setColor().

104 {return color_;}

reco::PFCluster::color_

int color_

color (transient)

Definition: PFCluster.h:213

double reco::PFCluster::energy ( ) const

inline

cluster energy

Definition at line 79 of file PFCluster.h.

References reco::CaloCluster::energy_.

Referenced by FWPFClusterRPZProxyBuilder::build(), FWPFClusterRPZUtils::buildRhoPhiClusterLineSet(), FWPFClusterRPZUtils::buildRhoZClusterLineSet(), PFPhotonTranslator::createBasicCluster(), PFEnergyCalibration::energyEm(), CalibratableTest::extractCandidate(), PFlow2DClusterizerWithTime::growPFClusters(), PFElecTkProducer::isSharingEcalEnergyWithEgSC(), EgammaHLTHcalPFClusterIsolationProducer::produce(), pt(), FWPFBlockProxyBuilder::setupClusterElement(), FWPFClusterRPZProxyBuilder::sharedBuild(), and FWPFClusterLegoProxyBuilder::sharedBuild().

79 {return energy_;}

reco::CaloCluster::energy_

double energy_

cluster energy

Definition: CaloCluster.h:205

double PFCluster::getDepthCorrection	(	double	energy,
		bool	isBelowPS = `false`,
		bool	isHadron = `false`
	)

static

Definition at line 65 of file PFCluster.cc.

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

 {
   double corrA = depthCorA_;
   double corrB = depthCorB_;
   if (isBelowPS) {
     corrA = depthCorAp_;
     corrB = depthCorBp_;
   }
   return isHadron ? corrA : corrA*(corrB + log(energy));
 }

PFLayer::Layer PFCluster::layer ( ) const

cluster layer, see PFLayer.h in this directory

Definition at line 85 of file PFCluster.cc.

References reco::CaloCluster::caloID(), PFLayer::fromCaloID(), layer_, and PFLayer::NONE.

Referenced by FWPFEcalClusterRPZProxyBuilder::build(), FWPFEcalClusterLegoProxyBuilder::build(), FWPFHcalClusterLegoProxyBuilder::build(), PFClusterEMEnergyCorrector::correctEnergyActual(), CalibratableTest::extractCandidate(), geometryXMLparser.DTAlignable::index(), geometryXMLparser.CSCAlignable::index(), PFAlgo::reconstructCluster(), KDTreeLinkerPSEcal::searchLinks(), setLayer(), LinkByRecHit::testECALAndPSByRecHit(), and LinkByRecHit::testTrackAndClusterByRecHit().

                                      {
   
   // cout<<"calling PFCluster::layer "<<caloID()<<" "<<PFLayer::fromCaloID( caloID() )<<endl;
   if( layer_ != PFLayer::NONE ) return layer_;
   return PFLayer::fromCaloID( caloID() );
 }     

PFCluster & PFCluster::operator= ( const PFCluster & other )

Definition at line 93 of file PFCluster.cc.

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

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

                                                       {
 
   CaloCluster::operator=(other); 
   rechits_ = other.rechits_;
   energy_ = other.energy_;
   position_ = other.position_;
   posrep_ = other.posrep_;
   color_ = other.color_;
 
   return *this;
 }

const REPPoint& reco::PFCluster::positionREP ( ) const

inline

cluster position: rho, eta, phi

Definition at line 87 of file PFCluster.h.

References posrep_.

Referenced by PFEnergyCalibration::energyEm(), CalibratableTest::extractCandidate(), KDTreeLinkerPSEcal::searchLinks(), and LinkByRecHit::testTrackAndClusterByRecHit().

87 {return posrep_;}

reco::PFCluster::posrep_

REPPoint posrep_

cluster position: rho, eta, phi (transient)

Definition: PFCluster.h:170

template<typename pruner >

void reco::PFCluster::pruneUsing ( pruner prune )

inline

Definition at line 151 of file PFCluster.h.

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

                                     {
       hitsAndFractions_.clear();
       std::vector<reco::PFRecHitFraction>::iterator iter = 
     std::stable_partition(rechits_.begin(),rechits_.end(),prune);
       rechits_.erase(iter,rechits_.end());
       hitsAndFractions_.reserve(rechits_.size());
       for( const auto& hitfrac : rechits_ ) {
     hitsAndFractions_.emplace_back(hitfrac.recHitRef()->detId(),
                        hitfrac.fraction());
       }
     }

double reco::PFCluster::pt ( ) const

inline

transverse momentum, massless approximation

Definition at line 132 of file PFCluster.h.

References energy(), reco::CaloCluster::position_, and funct::sin().

Referenced by EgammaHLTHcalPFClusterIsolationProducer::produce().

                       { 
       return (energy() * sin(position_.theta()));
     }

const std::vector< reco::PFRecHitFraction >& reco::PFCluster::recHitFractions ( ) const

inline

vector of rechit fractions

Definition at line 69 of file PFCluster.h.

References rechits_.

Referenced by Basic2DGenericTopoClusterizer::buildClusters(), Basic2DGenericPFlowPositionCalc::calculateAndSetPositionActual(), ECAL2DPositionCalcWithDepthCorr::calculateAndSetPositionActual(), PFlow2DClusterizerWithTime::clusterTimeResolution(), PFlow2DClusterizerWithTime::clusterTimeResolutionFromSeed(), Basic2DGenericPFlowClusterizer::growPFClusters(), PFlow2DClusterizerWithTime::growPFClusters(), Basic2DGenericPFlowClusterizer::seedPFClustersFromTopo(), PFlow2DClusterizerWithTime::seedPFClustersFromTopo(), LinkByRecHit::testECALAndPSByRecHit(), and LinkByRecHit::testTrackAndClusterByRecHit().

70 { return rechits_; }

reco::PFCluster::rechits_

std::vector< reco::PFRecHitFraction > rechits_

vector of rechit fractions (transient)

Definition: PFCluster.h:167

void PFCluster::reset ( void )

resets clusters parameters

Definition at line 36 of file PFCluster.cc.

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

Referenced by Basic2DGenericTopoClusterizer::buildClusters(), and reco::PFSuperCluster::reset().

                       {
   
   energy_ = 0;
   position_ *= 0;
   posrep_ *= 0;
   time_=-99.;
   layer_ = PFLayer::NONE;
   rechits_.clear();
 
   CaloCluster::reset();
   
 }

void PFCluster::resetHitsAndFractions ( )

reset only hits and fractions

Definition at line 49 of file PFCluster.cc.

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

                                       {
 
   rechits_.clear();
   hitsAndFractions_.clear();
   
 }

void reco::PFCluster::setColor ( int color )

inline

set cluster color (for the PFRootEventManager display)

Definition at line 101 of file PFCluster.h.

References color(), and color_.

101 {color_ = color;}

reco::PFCluster::color

int color() const

Definition: PFCluster.h:104

reco::PFCluster::color_

int color_

color (transient)

Definition: PFCluster.h:213

static void reco::PFCluster::setDepthCorParameters	(	int	mode,
		double	a,
		double	b,
		double	ap,
		double	bp
	)

inlinestatic

Definition at line 113 of file PFCluster.h.

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

                                              {
       depthCorMode_ = mode;
       depthCorA_ = a; 
       depthCorB_ = b; 
       depthCorAp_ = ap; 
       depthCorBp_ = bp; 
     } 

void PFCluster::setLayer ( PFLayer::Layer layer )

set layer

Definition at line 77 of file PFCluster.cc.

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

Referenced by Basic2DGenericPFlowPositionCalc::calculateAndSetPositionActual(), and ECAL2DPositionCalcWithDepthCorr::calculateAndSetPositionActual().

                                             {
   // cout<<"calling PFCluster::setLayer "<<layer<<endl;
   layer_ = layer;
   caloID_ = PFLayer::toCaloID( layer );
   // cout<<"done "<<caloID_<<endl;
 }

void reco::PFCluster::setTime ( double time )

inline

Definition at line 84 of file PFCluster.h.

References time(), and time_.

Referenced by Basic2DGenericPFlowPositionCalc::calculateAndSetPositionActual(), ECAL2DPositionCalcWithDepthCorr::calculateAndSetPositionActual(), PFlow2DClusterizerWithTime::clusterTimeResolution(), and PFlow2DClusterizerWithTime::clusterTimeResolutionFromSeed().

84 {time_ = time;}

reco::PFCluster::time_

double time_

Michalis :Add timing information.

Definition: PFCluster.h:173

reco::PFCluster::time

double time() const

cluster time

Definition: PFCluster.h:82

double reco::PFCluster::theta ( ) const

inline

angle

Definition at line 137 of file PFCluster.h.

References reco::CaloCluster::position_.

                          { 
       return position_.theta();
     }

double reco::PFCluster::time ( ) const

inline

cluster time

Definition at line 82 of file PFCluster.h.

References time_.

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

82 {return time_;}

reco::PFCluster::time_

double time_

Michalis :Add timing information.

Definition: PFCluster.h:173

math::XYZPoint const& reco::PFCluster::vertex ( ) const

inline

dummy vertex access

Definition at line 142 of file PFCluster.h.

References dummyVtx_.

Referenced by vx(), vy(), and vz().

                                         { 
       return dummyVtx_;      
     }

double reco::PFCluster::vx ( ) const

inline

Definition at line 145 of file PFCluster.h.

References vertex().

145 { return vertex().x(); }

reco::PFCluster::vertex

math::XYZPoint const & vertex() const

dummy vertex access

Definition: PFCluster.h:142

double reco::PFCluster::vy ( ) const

inline

Definition at line 146 of file PFCluster.h.

References vertex().

146 { return vertex().y(); }

reco::PFCluster::vertex

math::XYZPoint const & vertex() const

dummy vertex access

Definition: PFCluster.h:142

double reco::PFCluster::vz ( ) const

inline

Definition at line 147 of file PFCluster.h.

References vertex().

147 { return vertex().z(); }

reco::PFCluster::vertex

math::XYZPoint const & vertex() const

dummy vertex access

Definition: PFCluster.h:142

Friends And Related Function Documentation

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

friend

Member Data Documentation

int reco::PFCluster::color_

private

color (transient)

Definition at line 213 of file PFCluster.h.

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

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

staticprivate

Definition at line 183 of file PFCluster.h.

Referenced by getDepthCorrection(), and setDepthCorParameters().

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

staticprivate

Definition at line 189 of file PFCluster.h.

Referenced by getDepthCorrection(), and setDepthCorParameters().

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

staticprivate

Definition at line 186 of file PFCluster.h.

Referenced by getDepthCorrection(), and setDepthCorParameters().

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

staticprivate

Definition at line 192 of file PFCluster.h.

Referenced by getDepthCorrection(), and setDepthCorParameters().

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

staticprivate

Definition at line 180 of file PFCluster.h.

Referenced by setDepthCorParameters().

const math::XYZPoint PFCluster::dummyVtx_

staticprivate

Definition at line 210 of file PFCluster.h.

Referenced by vertex().

PFLayer::Layer reco::PFCluster::layer_

private

transient layer

Definition at line 176 of file PFCluster.h.

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

REPPoint reco::PFCluster::posrep_

private

cluster position: rho, eta, phi (transient)

Definition at line 170 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 167 of file PFCluster.h.

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

double reco::PFCluster::time_

private

Michalis :Add timing information.

Definition at line 173 of file PFCluster.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation