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

#include <PFCluster.h>

Inheritance diagram for reco::PFCluster:

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

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	setColor (int color)
	set cluster color (for the PFRootEventManager display) More...

void	setLayer (PFLayer::Layer layer)
	set layer More...

double	theta () const
	angle 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	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	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)

Static Public Attributes
static unsigned	instanceCounter_ = 0
	counter More...

Private Attributes
int	color_
	color (transient) More...

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

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

Static Private Attributes
static double	depthCorA_ = 0.89

static double	depthCorAp_ = 0.89

static double	depthCorB_ = 7.3

static double	depthCorBp_ = 4.0

static int	depthCorMode_ = 0

Friends
class	::PFClusterAlgo

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

Member Typedef Documentation

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

Definition at line 46 of file PFCluster.h.

Constructor & Destructor Documentation

reco::PFCluster::PFCluster ( )

inline

Definition at line 48 of file PFCluster.h.

48 : CaloCluster(CaloCluster::particleFlow), color_(1) {}

reco::CaloCluster::particleFlow

Definition: CaloCluster.h:33

reco::CaloCluster::CaloCluster

CaloCluster()

default constructor. Sets energy and position to zero

Definition: CaloCluster.h:43

reco::PFCluster::color_

int color_

color (transient)

Definition: PFCluster.h:167

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

constructor

Definition at line 16 of file PFCluster.cc.

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

Member Function Documentation

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

add a given fraction of the rechit

Definition at line 40 of file PFCluster.cc.

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

Referenced by PFClusterAlgo::buildPFClusters().

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

void reco::PFCluster::calculatePositionREP ( )

inline

computes posrep_ once and for all

Definition at line 79 of file PFCluster.h.

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

Referenced by 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 120 of file PFCluster.h.

120 { return 0;}

int reco::PFCluster::color ( ) const

inline

Returns: color

Definition at line 93 of file PFCluster.h.

References color_.

Referenced by setColor().

93 {return color_;}

reco::PFCluster::color_

int color_

color (transient)

Definition: PFCluster.h:167

double reco::PFCluster::energy ( ) const

inline

cluster energy

Definition at line 73 of file PFCluster.h.

References reco::CaloCluster::energy_.

Referenced by FWPFClusterRPZProxyBuilder::build(), FWPFClusterRPZUtils::buildRhoPhiClusterLineSet(), FWPFClusterRPZUtils::buildRhoZClusterLineSet(), PFPhotonTranslator::createBasicCluster(), PFEnergyCalibration::energyEm(), CalibratableTest::extractCandidate(), GPFCluster::GPFCluster(), PFElecTkProducer::isSharingEcalEnergyWithEgSC(), PFRootEventManager::printCluster(), pt(), FWPFBlockProxyBuilder::setupClusterElement(), FWPFClusterRPZProxyBuilder::sharedBuild(), and FWPFClusterLegoProxyBuilder::sharedBuild().

73 {return energy_;}

reco::CaloCluster::energy_

double energy_

cluster energy

Definition: CaloCluster.h:204

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

static

Definition at line 49 of file PFCluster.cc.

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

 {
   double corrA = depthCorA_;
   double corrB = depthCorB_;
   if (isBelowPS) {
     corrA = depthCorAp_;
     corrB = depthCorBp_;
   }
   double depth = 0;
   switch(isHadron) {
   case 0: // e/gamma
     depth = corrA*(corrB + log(energy)); 
     break;
   case 1: // hadrons
     depth = corrA;
     break;
   default:
     assert(0);
     //     edm::LogError("PFCluster") << "unknown function for depth correction!"
     //                         << std::endl;
   }
   return depth;
 }

PFLayer::Layer PFCluster::layer ( ) const

cluster layer, see PFLayer.h in this directory

Definition at line 81 of file PFCluster.cc.

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

Referenced by FWPFEcalClusterRPZProxyBuilder::build(), FWPFEcalClusterLegoProxyBuilder::build(), FWPFHcalClusterLegoProxyBuilder::build(), PFClusterAlgo::calculateClusterPosition(), DisplayManager::createGCluster(), CalibratableTest::extractCandidate(), geometryXMLparser.DTAlignable::index(), geometryXMLparser.CSCAlignable::index(), PFAlgo::reconstructCluster(), KDTreeLinkerPSEcal::searchLinks(), LinkByRecHit::testECALAndPSByRecHit(), LinkByRecHit::testTrackAndClusterByRecHit(), and PFBlockAlgo::testTrackAndPS().

                                      {
   
   // cout<<"calling PFCluster::layer "<<caloID()<<" "<<PFLayer::fromCaloID( caloID() )<<endl;
   return PFLayer::fromCaloID( caloID() );
 }     

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

Definition at line 88 of file PFCluster.cc.

References color_, reco::CaloCluster::energy_, operator=(), reco::CaloCluster::position_, posrep_, and rechits_.

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

References posrep_.

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

76 {return posrep_;}

reco::PFCluster::posrep_

REPPoint posrep_

cluster position: rho, eta, phi (transient)

Definition: PFCluster.h:147

double reco::PFCluster::pt ( ) const

inline

transverse momentum, massless approximation

Definition at line 123 of file PFCluster.h.

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

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

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

inline

vector of rechit fractions

Definition at line 63 of file PFCluster.h.

References rechits_.

Referenced by LinkByRecHit::testECALAndPSByRecHit(), and LinkByRecHit::testTrackAndClusterByRecHit().

64 { return rechits_; }

reco::PFCluster::rechits_

std::vector< reco::PFRecHitFraction > rechits_

vector of rechit fractions (transient)

Definition: PFCluster.h:144

void PFCluster::reset ( void )

resets clusters parameters

Definition at line 27 of file PFCluster.cc.

References reco::CaloCluster::energy_, reco::CaloCluster::position_, posrep_, rechits_, and reco::CaloCluster::reset().

Referenced by BeautifulSoup.BeautifulStoneSoup::__init__().

                       {
   
   energy_ = 0;
   position_ *= 0;
   posrep_ *= 0;
   
   rechits_.clear();
 
   CaloCluster::reset();
   
 }

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

inline

set cluster color (for the PFRootEventManager display)

Definition at line 90 of file PFCluster.h.

References color(), and color_.

90 {color_ = color;}

reco::PFCluster::color

int color() const

Definition: PFCluster.h:93

reco::PFCluster::color_

int color_

color (transient)

Definition: PFCluster.h:167

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

inlinestatic

Definition at line 104 of file PFCluster.h.

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

Referenced by PFClusterProducer::PFClusterProducer(), and PFRootEventManager::readOptions().

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

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

set layer

Definition at line 74 of file PFCluster.cc.

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

Referenced by PFClusterAlgo::calculateClusterPosition().

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

double reco::PFCluster::theta ( ) const

inline

angle

Definition at line 128 of file PFCluster.h.

References reco::CaloCluster::position_.

                          { 
       return position_.theta();
     }

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

inline

dummy vertex access

Definition at line 133 of file PFCluster.h.

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

                                         { 
       static math::XYZPoint dummyVtx(0,0,0);
       return dummyVtx;      
     }

double reco::PFCluster::vx ( ) const

inline

Definition at line 137 of file PFCluster.h.

References vertex().

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

reco::PFCluster::vertex

math::XYZPoint const & vertex() const

dummy vertex access

Definition: PFCluster.h:133

double reco::PFCluster::vy ( ) const

inline

Definition at line 138 of file PFCluster.h.

References vertex().

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

reco::PFCluster::vertex

math::XYZPoint const & vertex() const

dummy vertex access

Definition: PFCluster.h:133

double reco::PFCluster::vz ( ) const

inline

Definition at line 139 of file PFCluster.h.

References vertex().

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

reco::PFCluster::vertex

math::XYZPoint const & vertex() const

dummy vertex access

Definition: PFCluster.h:133

Friends And Related Function Documentation

friend class ::PFClusterAlgo

friend

Definition at line 169 of file PFCluster.h.

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

friend

Member Data Documentation

int reco::PFCluster::color_

private

color (transient)

Definition at line 167 of file PFCluster.h.

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

double PFCluster::depthCorA_ = 0.89

staticprivate

Definition at line 154 of file PFCluster.h.

Referenced by PFClusterAlgo::calculateClusterPosition(), getDepthCorrection(), and setDepthCorParameters().

double PFCluster::depthCorAp_ = 0.89

staticprivate

Definition at line 160 of file PFCluster.h.

Referenced by PFClusterAlgo::calculateClusterPosition(), getDepthCorrection(), and setDepthCorParameters().

double PFCluster::depthCorB_ = 7.3

staticprivate

Definition at line 157 of file PFCluster.h.

Referenced by PFClusterAlgo::calculateClusterPosition(), getDepthCorrection(), and setDepthCorParameters().

double PFCluster::depthCorBp_ = 4.0

staticprivate

Definition at line 163 of file PFCluster.h.

Referenced by PFClusterAlgo::calculateClusterPosition(), getDepthCorrection(), and setDepthCorParameters().

int PFCluster::depthCorMode_ = 0

staticprivate

Definition at line 151 of file PFCluster.h.

Referenced by PFClusterAlgo::calculateClusterPosition(), and setDepthCorParameters().

unsigned PFCluster::instanceCounter_ = 0

static

counter

Definition at line 101 of file PFCluster.h.

REPPoint reco::PFCluster::posrep_

private

cluster position: rho, eta, phi (transient)

Definition at line 147 of file PFCluster.h.

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

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

private

vector of rechit fractions (transient)

Definition at line 144 of file PFCluster.h.

Referenced by addRecHitFraction(), PFClusterAlgo::calculateClusterPosition(), operator=(), recHitFractions(), and reset().

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

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