reco::PFRecHit Class Reference

Particle flow rechit (rechit + geometry and topology information). See clustering algorithm in PFClusterAlgo. More...

#include <PFRecHit.h>

Public Types
enum	{ NONE =0 }
typedef ROOT::Math::PositionVector3D < ROOT::Math::CylindricalEta3D < Double32_t > >	REPPoint
typedef std::vector< REPPoint >	REPPointVector

Public Member Functions
void	addNeighbour (short x, short y, short z, const PFRecHitRef &)
void	calculatePositionREP ()
void	clearNeighbours ()
unsigned	detId () const
	rechit detId More...
double	energy () const
	rechit energy More...
const math::XYZVector &	getAxisXYZ () const
	rechit cell axis x, y, z More...
const std::vector< REPPoint > &	getCornersREP () const
const std::vector < math::XYZPoint > &	getCornersXYZ () const
	rechit corners More...
PFLayer::Layer	layer () const
	rechit layer More...
const std::vector< unsigned short > &	neighbourInfos ()
const PFRecHitRefVector &	neighbours () const
const PFRecHitRefVector &	neighbours4 () const
const PFRecHitRefVector &	neighbours8 () const
bool	operator< (const PFRecHit &rhs) const
	comparison < operator More...
bool	operator<= (const PFRecHit &rhs) const
	comparison <= operator More...
bool	operator> (const PFRecHit &rhs) const
	comparison > operator More...
bool	operator>= (const PFRecHit &rhs) const
	comparison >= operator More...
const edm::RefToBase < CaloRecHit > &	originalRecHit () const
	PFRecHit ()
	default constructor. Sets energy and position to zero More...
	PFRecHit (unsigned detId, PFLayer::Layer layer, double energy, const math::XYZPoint &posxyz, const math::XYZVector &axisxyz, const std::vector< math::XYZPoint > &cornersxyz)
	constructor from values More...
	PFRecHit (unsigned detId, PFLayer::Layer layer, double energy, double posx, double posy, double posz, double axisx, double axisy, double axisz)
	PFRecHit (const PFRecHit &other)
	copy More...
const math::XYZPoint &	position () const
	rechit cell centre x, y, z More...
const REPPoint &	positionREP () const
double	pt2 () const
	rechit momentum transverse to the beam, squared. More...
void	setEnergy (double energy)
void	setNECorner (double posx, double posy, double posz)
void	setNWCorner (double posx, double posy, double posz)
template<typename T >
void	setOriginalRecHit (const T &rh)
void	setSECorner (double posx, double posy, double posz)
void	setSWCorner (double posx, double posy, double posz)
void	setTime (double time)
void	size (double &deta, double &dphi) const
double	time () const
	timing for cleaned hits More...
virtual	~PFRecHit ()
	destructor More...

Private Member Functions
void	setCorner (unsigned i, double posx, double posy, double posz)
	set position of one of the corners More...

Private Attributes
math::XYZVector	axisxyz_
	rechit cell axisxyz More...
std::vector< REPPoint >	cornersrep_
	rechit cell corners rho/eta/phi More...
std::vector< math::XYZPoint >	cornersxyz_
	rechit cell corners More...
unsigned	detId_
	C cell detid - should be detid or index in collection ? More...
double	energy_
	rechit energy More...
PFLayer::Layer	layer_
	rechit layer More...
std::vector< unsigned short >	neighbourInfos_
PFRecHitRefVector	neighbours4_
PFRecHitRefVector	neighbours8_
PFRecHitRefVector	neighbours_
	indices to existing neighbours (1 common side) More...
edm::RefToBase< CaloRecHit >	originalRecHit_
math::XYZPoint	position_
	rechit cell centre: x, y, z More...
REPPoint	positionrep_
	rechit cell centre: rho, eta, phi (transient) More...
double	time_
	time More...

Static Private Attributes
static const unsigned	nCorners_ = 4
	number of corners More...

Friends
std::ostream &	operator<< (std::ostream &out, const reco::PFRecHit &hit)

Detailed Description

Particle flow rechit (rechit + geometry and topology information). See clustering algorithm in PFClusterAlgo.

Author

Colin Bernet

Date

July 2006

Feb 2014 [Michalis: 8 years later!Modifying the class to be able to generalize the neighbours for 3D calorimeters ]

Definition at line 35 of file PFRecHit.h.

Member Typedef Documentation

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

Definition at line 39 of file PFRecHit.h.

typedef std::vector<REPPoint> reco::PFRecHit::REPPointVector

Definition at line 41 of file PFRecHit.h.

Member Enumeration Documentation

anonymous enum

Enumerator
NONE

Definition at line 43 of file PFRecHit.h.

         {
      NONE=0
    };

Constructor & Destructor Documentation

PFRecHit::PFRecHit

(

)

default constructor. Sets energy and position to zero

Definition at line 7 of file PFRecHit.cc.

References calculatePositionREP(), cornersxyz_, i, nCorners_, and position_.

                   : 
  detId_(0),
  layer_(PFLayer::NONE),
  energy_(0.), 
  time_(-1.),
  position_(math::XYZPoint(0.,0.,0.))
{
  
  cornersxyz_.reserve( nCorners_ );
  for(unsigned i=0; i<nCorners_; i++) { 
    cornersxyz_.push_back( position_ );    
  }
  calculatePositionREP();
}

PFRecHit::PFRecHit	(	unsigned	detId,
		PFLayer::Layer	layer,
		double	energy,
		const math::XYZPoint &	posxyz,
		const math::XYZVector &	axisxyz,
		const std::vector< math::XYZPoint > &	cornersxyz
	)

constructor from values

Definition at line 23 of file PFRecHit.cc.

References calculatePositionREP().

                                                             : 
  detId_(detId),
  layer_(layer),
  energy_(energy), 
  time_(-1.),
  position_(position),
  axisxyz_(axisxyz),
  cornersxyz_(cornersxyz) 
{
  calculatePositionREP();
}

PFRecHit::PFRecHit	(	unsigned	detId,
		PFLayer::Layer	layer,
		double	energy,
		double	posx,
		double	posy,
		double	posz,
		double	axisx,
		double	axisy,
		double	axisz
	)

Definition at line 40 of file PFRecHit.cc.

References calculatePositionREP(), cornersxyz_, i, nCorners_, and position_.

                                                             :

  detId_(detId),
  layer_(layer),
  energy_(energy), 
  time_(-1.),
  position_(posx, posy, posz),
  axisxyz_(axisx, axisy, axisz) {

  cornersxyz_.reserve( nCorners_ );
  for(unsigned i=0; i<nCorners_; i++) { 
    cornersxyz_.push_back( position_ );    
  } 

  calculatePositionREP();

}    

PFRecHit::PFRecHit

(

const PFRecHit &

other

)

copy

Definition at line 63 of file PFRecHit.cc.

                                        :
  originalRecHit_(other.originalRecHit_),
  detId_(other.detId_), 
  layer_(other.layer_), 
  energy_(other.energy_), 
  time_(other.time_), 
  position_(other.position_), 
  positionrep_(other.positionrep_),
  axisxyz_(other.axisxyz_),
  cornersxyz_(other.cornersxyz_),
  cornersrep_(other.cornersrep_),
  neighbours_(other.neighbours_),
  neighbourInfos_(other.neighbourInfos_),
  neighbours4_(other.neighbours4_),
  neighbours8_(other.neighbours8_)
{}

PFRecHit::~PFRecHit ( )

virtual

destructor

Definition at line 82 of file PFRecHit.cc.

{}

Member Function Documentation

void PFRecHit::addNeighbour	(	short	x,
		short	y,
		short	z,
		const PFRecHitRef &	ref
	)

Definition at line 129 of file PFRecHit.cc.

References funct::abs(), neighbourInfos_, neighbours4_, neighbours8_, neighbours_, and edm::RefVector< C, T, F >::push_back().

Referenced by PFRecHitNavigatorBase::associateNeighbour(), and PFRecHitCaloNavigatorWithTime< EEDetId, EcalEndcapTopology >::associateNeighbour().

                                                                          {
  //bitmask interface  to accomodate more advanced naighbour finding [i.e in z as well]
  //bit 0 side for eta [0 for <=0 , 1 for >0]
  //bits 1,2,3 : abs(eta) wrt the center
  //bit 4 side for phi 
  //bits 5,6,7 : abs(phi) wrt the center
  //bit 8 side for z 
  //bits 9,10,11 : abs(z) wrt the center

  unsigned short absx = abs(x);
  unsigned short absy = abs(y);
  unsigned short absz = abs(z);

  unsigned short bitmask=0;


  if (x>0)
    bitmask = bitmask | 1 ;
  bitmask = bitmask | (absx << 1);
  if (y>0)
    bitmask = bitmask | (1<<4) ;
  bitmask = bitmask | (absy << 5);
  if (z>0)
    bitmask = bitmask | (1<<8) ;
  bitmask = bitmask | (absz << 9);
  
  neighbours_.push_back(ref);
  neighbourInfos_.push_back(bitmask);

  if (z==0) {
    neighbours8_.push_back(ref);
    //find only the 4 neighbours
    if (absx+absy==1)
      neighbours4_.push_back(ref);
  }
}

void PFRecHit::calculatePositionREP

(

)

Definition at line 117 of file PFRecHit.cc.

References cornersrep_, cornersxyz_, reco::tau::disc::Eta(), i, colinearityKinematic::Phi, position_, and positionrep_.

Referenced by PFRecHit().

                               {
  positionrep_.SetCoordinates( position_.Rho(), 
                   position_.Eta(), 
                   position_.Phi() );
  cornersrep_.resize(cornersxyz_.size());
  for( unsigned i = 0; i < cornersxyz_.size(); ++i ) {
    cornersrep_[i].SetCoordinates(cornersxyz_[i].Rho(),
                  cornersxyz_[i].Eta(),
                  cornersxyz_[i].Phi());
  }
}

void reco::PFRecHit::clearNeighbours ( )

inline

Definition at line 75 of file PFRecHit.h.

References edm::RefVector< C, T, F >::clear(), and neighbours_.

                           {
      neighbours_.clear();
    }

unsigned reco::PFRecHit::detId ( ) const

inline

rechit detId

Definition at line 101 of file PFRecHit.h.

References detId_.

Referenced by PFRecHitCaloNavigator< CaloTowerDetId, CaloTowerTopology >::associateNeighbours(), PFRecHitCaloNavigatorWithTime< EEDetId, EcalEndcapTopology >::associateNeighbours(), PFECALHashNavigator::associateNeighbours(), RBXAndHPDCleaner::clean(), PFlow2DClusterizerWithTime::clusterTimeResolutionFromSeed(), FWPFCandidateWithHitsProxyBuilder::scaleProduct(), and PFRecHitQTestHCALCalib29::test().

{return detId_;}

double reco::PFRecHit::energy ( ) const

inline

rechit energy

Definition at line 107 of file PFRecHit.h.

References energy_.

Referenced by FWPFCandidateWithHitsProxyBuilder::addHitsForCandidate(), PFRecHitCaloNavigatorWithTime< EEDetId, EcalEndcapTopology >::associateNeighbour(), PFAlgo::checkCleaning(), RBXAndHPDCleaner::clean(), SpikeAndDoubleSpikeCleaner::clean(), PFlow2DClusterizerWithTime::clusterTimeResolution(), PFlow2DClusterizerWithTime::clusterTimeResolutionFromSeed(), LocalMaximumSeedFinder::findSeeds(), PFRecHitQTestThreshold::pass(), FWPFCandidateWithHitsProxyBuilder::scaleProduct(), setEnergy(), PFRecHitQTestHOThreshold::test(), PFRecHitQTestHCALCalib29::test(), and LinkByRecHit::testTrackAndClusterByRecHit().

{ return energy_; }

const math::XYZVector& reco::PFRecHit::getAxisXYZ ( ) const

inline

rechit cell axis x, y, z

Definition at line 129 of file PFRecHit.h.

References axisxyz_.

{ return axisxyz_; }    

const std::vector<REPPoint>& reco::PFRecHit::getCornersREP ( ) const

inline

Definition at line 135 of file PFRecHit.h.

References cornersrep_.

Referenced by LinkByRecHit::testTrackAndClusterByRecHit().

{ return cornersrep_; }

const std::vector< math::XYZPoint >& reco::PFRecHit::getCornersXYZ ( ) const

inline

rechit corners

Definition at line 132 of file PFRecHit.h.

References cornersxyz_.

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

      { return cornersxyz_; }    

PFLayer::Layer reco::PFRecHit::layer ( ) const

inline

rechit layer

Definition at line 104 of file PFRecHit.h.

References layer_.

Referenced by PFRecHitDualNavigator< D1, barrel, D2, endcap >::associateNeighbours(), PFAlgo::checkCleaning(), RBXAndHPDCleaner::clean(), SpikeAndDoubleSpikeCleaner::clean(), PFlow2DClusterizerWithTime::clusterTimeResolution(), PFlow2DClusterizerWithTime::clusterTimeResolutionFromSeed(), LocalMaximumSeedFinder::findSeeds(), geometryXMLparser.DTAlignable::index(), and geometryXMLparser.CSCAlignable::index().

{ return layer_; }

const std::vector<unsigned short>& reco::PFRecHit::neighbourInfos ( )

inline

Definition at line 90 of file PFRecHit.h.

References neighbourInfos_.

                                                      {
      return neighbourInfos_;
    }

const PFRecHitRefVector& reco::PFRecHit::neighbours ( ) const

inline

Definition at line 86 of file PFRecHit.h.

References neighbours_.

Referenced by LocalMaximumSeedFinder::findSeeds().

                                                {
      return neighbours_;
    }

const PFRecHitRefVector& reco::PFRecHit::neighbours4 ( ) const

inline

Definition at line 79 of file PFRecHit.h.

References neighbours4_.

Referenced by RBXAndHPDCleaner::clean(), SpikeAndDoubleSpikeCleaner::clean(), and LocalMaximumSeedFinder::findSeeds().

                                                 {
      return neighbours4_;
    }

const PFRecHitRefVector& reco::PFRecHit::neighbours8 ( ) const

inline

Definition at line 82 of file PFRecHit.h.

References neighbours8_.

Referenced by LocalMaximumSeedFinder::findSeeds().

                                                 {
      return neighbours8_;
    }

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

inline

comparison < operator

Definition at line 149 of file PFRecHit.h.

References energy_.

{ return (energy_< rhs.energy_); }

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

inline

comparison <= operator

Definition at line 146 of file PFRecHit.h.

References energy_.

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

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

inline

comparison > operator

Definition at line 143 of file PFRecHit.h.

References energy_.

{ return (energy_> rhs.energy_); }

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

inline

comparison >= operator

Definition at line 140 of file PFRecHit.h.

References energy_.

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

const edm::RefToBase<CaloRecHit>& reco::PFRecHit::originalRecHit ( ) const

inline

Definition at line 154 of file PFRecHit.h.

References originalRecHit_.

                                                           {
      return originalRecHit_;
    }

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

inline

rechit cell centre x, y, z

Definition at line 123 of file PFRecHit.h.

References position_.

Referenced by KDTreeLinkerPSEcal::buildTree(), PFAlgo::checkCleaning(), RBXAndHPDCleaner::clean(), LinkByRecHit::testECALAndPSByRecHit(), and LinkByRecHit::testTrackAndClusterByRecHit().

{ return position_; }

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

inline

Definition at line 125 of file PFRecHit.h.

References positionrep_.

Referenced by SpikeAndDoubleSpikeCleaner::clean(), LocalMaximumSeedFinder::findSeeds(), and LinkByRecHit::testTrackAndClusterByRecHit().

{ return positionrep_; }

double reco::PFRecHit::pt2 ( ) const

inline

rechit momentum transverse to the beam, squared.

Definition at line 114 of file PFRecHit.h.

References energy_, and position_.

Referenced by LocalMaximumSeedFinder::findSeeds().

                       { return energy_ * energy_ *
               ( position_.X()*position_.X() + 
                 position_.Y()*position_.Y() ) / 
               ( position_.X()*position_.X() +
                 position_.Y()*position_.Y() + 
                 position_.Z()*position_.Z()) ; }

void PFRecHit::setCorner ( unsigned  i, double  posx, double  posy, double  posz  )

private

set position of one of the corners

Definition at line 106 of file PFRecHit.cc.

References cornersrep_, cornersxyz_, reco::tau::disc::Eta(), i, nCorners_, and colinearityKinematic::Phi.

Referenced by setNECorner(), setNWCorner(), setSECorner(), and setSWCorner().

                                                                            {
  assert( cornersxyz_.size() == nCorners_);
  assert( i<cornersxyz_.size() );

  cornersxyz_[i] = math::XYZPoint( posx, posy, posz);
  cornersrep_[i] = REPPoint( cornersxyz_[i].Rho(),
                 cornersxyz_[i].Eta(),
                 cornersxyz_[i].Phi() );
}

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

inline

Definition at line 69 of file PFRecHit.h.

References energy(), and energy_.

Referenced by PFRecHitQTestHCALCalib29::test().

{ energy_ = energy; }

void PFRecHit::setNECorner	(	double	posx,
		double	posy,
		double	posz
	)

Definition at line 101 of file PFRecHit.cc.

References setCorner().

Referenced by PFCTRecHitProducer::createHcalRecHit(), and PFPSRecHitCreator::importRecHits().

                                                                  {
  setCorner(3, posx, posy, posz);
}

void PFRecHit::setNWCorner	(	double	posx,
		double	posy,
		double	posz
	)

Definition at line 86 of file PFRecHit.cc.

References setCorner().

Referenced by PFCTRecHitProducer::createHcalRecHit(), and PFPSRecHitCreator::importRecHits().

                                                                  {
  setCorner(0, posx, posy, posz);
}

template<typename T >

void reco::PFRecHit::setOriginalRecHit ( const T &  rh )

inline

Definition at line 159 of file PFRecHit.h.

References originalRecHit_.

                                        {
      originalRecHit_ = edm::RefToBase<CaloRecHit>(rh);
    }

void PFRecHit::setSECorner	(	double	posx,
		double	posy,
		double	posz
	)

Definition at line 96 of file PFRecHit.cc.

References setCorner().

Referenced by PFCTRecHitProducer::createHcalRecHit(), and PFPSRecHitCreator::importRecHits().

                                                                  {
  setCorner(2, posx, posy, posz);
}

void PFRecHit::setSWCorner	(	double	posx,
		double	posy,
		double	posz
	)

Definition at line 91 of file PFRecHit.cc.

References setCorner().

Referenced by PFCTRecHitProducer::createHcalRecHit(), and PFPSRecHitCreator::importRecHits().

                                                                  {
  setCorner(1, posx, posy, posz);
}

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

inline

Definition at line 74 of file PFRecHit.h.

References time(), and time_.

Referenced by PFHcalRecHitCreator< Digi, Geometry, Layer, Detector >::importRecHits(), and PFCTRecHitProducer::produce().

{ time_ = time; }

void PFRecHit::size	(	double &	deta,
		double &	dphi
	)		const

Definition at line 166 of file PFRecHit.cc.

References cornersxyz_, eta(), and phi.

                                                    {

  double minphi=9999;
  double maxphi=-9999;
  double mineta=9999;
  double maxeta=-9999;
  for ( unsigned ic=0; ic<cornersxyz_.size(); ++ic ) { 
    double eta = cornersxyz_[ic].Eta();
    double phi = cornersxyz_[ic].Phi();
    
    if(phi>maxphi) maxphi=phi;
    if(phi<minphi) minphi=phi;
    if(eta>maxeta) maxeta=eta;
    if(eta<mineta) mineta=eta;    
  }

  deta = maxeta - mineta;
  dphi = maxphi - minphi;
}

double reco::PFRecHit::time ( ) const

inline

timing for cleaned hits

Definition at line 111 of file PFRecHit.h.

References time_.

Referenced by PFRecHitCaloNavigatorWithTime< EEDetId, EcalEndcapTopology >::associateNeighbour(), PFAlgo::checkCleaning(), PFlow2DClusterizerWithTime::clusterTimeResolution(), PFlow2DClusterizerWithTime::clusterTimeResolutionFromSeed(), and setTime().

{ return time_; }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out, const reco::PFRecHit &  hit  )

friend

Member Data Documentation

math::XYZVector reco::PFRecHit::axisxyz_

private

rechit cell axisxyz

Definition at line 187 of file PFRecHit.h.

Referenced by getAxisXYZ().

std::vector< REPPoint > reco::PFRecHit::cornersrep_

private

rechit cell corners rho/eta/phi

Definition at line 193 of file PFRecHit.h.

Referenced by calculatePositionREP(), getCornersREP(), and setCorner().

std::vector< math::XYZPoint > reco::PFRecHit::cornersxyz_

private

rechit cell corners

Definition at line 190 of file PFRecHit.h.

Referenced by calculatePositionREP(), getCornersXYZ(), PFRecHit(), setCorner(), and size().

unsigned reco::PFRecHit::detId_

private

C cell detid - should be detid or index in collection ?

Definition at line 169 of file PFRecHit.h.

Referenced by detId().

double reco::PFRecHit::energy_

private

rechit energy

Definition at line 175 of file PFRecHit.h.

Referenced by energy(), operator<(), operator<=(), operator>(), operator>=(), pt2(), and setEnergy().

PFLayer::Layer reco::PFRecHit::layer_

private

rechit layer

Definition at line 172 of file PFRecHit.h.

Referenced by layer().

const unsigned PFRecHit::nCorners_ = 4

staticprivate

number of corners

Definition at line 205 of file PFRecHit.h.

Referenced by PFRecHit(), and setCorner().

std::vector< unsigned short > reco::PFRecHit::neighbourInfos_

private

Definition at line 197 of file PFRecHit.h.

Referenced by addNeighbour(), and neighbourInfos().

PFRecHitRefVector reco::PFRecHit::neighbours4_

private

Definition at line 200 of file PFRecHit.h.

Referenced by addNeighbour(), and neighbours4().

PFRecHitRefVector reco::PFRecHit::neighbours8_

private

Definition at line 201 of file PFRecHit.h.

Referenced by addNeighbour(), and neighbours8().

PFRecHitRefVector reco::PFRecHit::neighbours_

private

indices to existing neighbours (1 common side)

Definition at line 196 of file PFRecHit.h.

Referenced by addNeighbour(), clearNeighbours(), and neighbours().

edm::RefToBase<CaloRecHit> reco::PFRecHit::originalRecHit_

private

Definition at line 166 of file PFRecHit.h.

Referenced by originalRecHit(), and setOriginalRecHit().

math::XYZPoint reco::PFRecHit::position_

private

rechit cell centre: x, y, z

Definition at line 181 of file PFRecHit.h.

Referenced by calculatePositionREP(), PFRecHit(), position(), and pt2().

REPPoint reco::PFRecHit::positionrep_

private

rechit cell centre: rho, eta, phi (transient)

Definition at line 184 of file PFRecHit.h.

Referenced by calculatePositionREP(), and positionREP().

double reco::PFRecHit::time_

private

time

Definition at line 178 of file PFRecHit.h.

Referenced by setTime(), and time().