reco::PFRecHit Class Reference

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

#include <PFRecHit.h>

Classes
struct	Neighbours

Public Types
enum	{ NONE = 0 }
using	CornersVec = CaloCellGeometry::CornersVec
using	PositionType = GlobalPoint::BasicVectorType
using	RepCorners = CaloCellGeometry::RepCorners
using	REPPoint = RhoEtaPhi
using	REPPointVector = RepCorners

Public Member Functions
void	addNeighbour (short x, short y, short z, unsigned int)
CaloCellGeometry const &	caloCell () const
	calo cell More...
void	clearNeighbours ()
int	depth () const
	depth for segemntation More...
unsigned	detId () const
	rechit detId More...
float	energy () const
	rechit energy More...
uint32_t	flags () const
RepCorners const &	getCornersREP () const
CornersVec const &	getCornersXYZ () const
	rechit corners More...
unsigned int	getNeighbour (short x, short y, short z) const
bool	hasCaloCell () const
PFLayer::Layer	layer () const
	rechit layer More...
const std::vector< unsigned short > &	neighbourInfos ()
Neighbours	neighbours () const
Neighbours	neighbours4 () const
Neighbours	neighbours8 () const
bool	operator< (const PFRecHit &rhs) const
	comparison < operator More...
bool	operator<= (const PFRecHit &rhs) const
	comparison <= operator More...
PFRecHit &	operator= (const PFRecHit &other)=default
PFRecHit &	operator= (PFRecHit &&other)=default
bool	operator> (const PFRecHit &rhs) const
	comparison > operator More...
bool	operator>= (const PFRecHit &rhs) const
	comparison >= operator More...
	PFRecHit ()
	default constructor. Sets energy and position to zero More...
	PFRecHit (std::shared_ptr< const CaloCellGeometry > caloCell, unsigned int detId, PFLayer::Layer layer, float energy, uint32_t flags=0)
	PFRecHit (const PFRecHit &other)=default
	copy More...
	PFRecHit (PFRecHit &&other)=default
PositionType const &	position () const
	rechit cell centre x, y, z More...
RhoEtaPhi const &	positionREP () const
double	pt2 () const
	rechit momentum transverse to the beam, squared. More...
void	setDepth (int depth)
void	setEnergy (float energy)
void	setFlags (uint32_t flags)
void	setTime (double time)
float	time () const
	timing for cleaned hits More...
	~PFRecHit ()=default
	destructor More...

Private Member Functions
Neighbours	buildNeighbours (unsigned int n) const

Private Attributes
std::shared_ptr< const CaloCellGeometry >	caloCell_ = nullptr
	cell geometry More...
int	depth_ = 0
	depth More...
unsigned int	detId_ = 0
	cell detid More...
float	energy_ = 0
	rechit energy More...
uint32_t	flags_ = 0
PFLayer::Layer	layer_ = PFLayer::NONE
	rechit layer More...
std::vector< unsigned short >	neighbourInfos_
unsigned int	neighbours4_ = 0
unsigned int	neighbours8_ = 0
std::vector< unsigned int >	neighbours_
	indices to existing neighbours (1 common side) More...
float	time_ = -1
	time More...

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 31 of file PFRecHit.h.

Member Typedef Documentation

using reco::PFRecHit::CornersVec = CaloCellGeometry::CornersVec

Definition at line 37 of file PFRecHit.h.

using reco::PFRecHit::PositionType = GlobalPoint::BasicVectorType

Definition at line 33 of file PFRecHit.h.

using reco::PFRecHit::RepCorners = CaloCellGeometry::RepCorners

Definition at line 35 of file PFRecHit.h.

using reco::PFRecHit::REPPoint = RhoEtaPhi

Definition at line 34 of file PFRecHit.h.

using reco::PFRecHit::REPPointVector = RepCorners

Definition at line 36 of file PFRecHit.h.

Member Enumeration Documentation

anonymous enum

Enumerator
NONE

Definition at line 49 of file PFRecHit.h.

{ NONE = 0 };

Constructor & Destructor Documentation

reco::PFRecHit::PFRecHit ( )

inline

default constructor. Sets energy and position to zero

Definition at line 51 of file PFRecHit.h.

{}

reco::PFRecHit::PFRecHit ( std::shared_ptr< const CaloCellGeometry >  caloCell, unsigned int  detId, PFLayer::Layer  layer, float  energy, uint32_t  flags = 0  )

inline

Definition at line 53 of file PFRecHit.h.

        : caloCell_(std::move(caloCell)), detId_(detId), layer_(layer), energy_(energy), flags_(flags) {}

reco::PFRecHit::PFRecHit ( const PFRecHit &  other )

default

copy

reco::PFRecHit::PFRecHit ( PFRecHit &&  other )

default

reco::PFRecHit::~PFRecHit ( )

default

destructor

Member Function Documentation

void reco::PFRecHit::addNeighbour	(	short	x,
		short	y,
		short	z,
		unsigned int	ref
	)

Definition at line 5 of file PFRecHit.cc.

References funct::abs(), cms::cuda::assert(), neighbourInfos_, neighbours4_, neighbours8_, and neighbours_.

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 = std::abs(x);
    unsigned short absy = std::abs(y);
    unsigned short absz = std::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);

    auto pos = neighbours_.size();
    if (z == 0) {
      pos = neighbours8_++;
      //find only the 4 neighbours
      if (absx + absy == 1)
        pos = neighbours4_++;
    }
    neighbours_.insert(neighbours_.begin() + pos, ref);
    neighbourInfos_.insert(neighbourInfos_.begin() + pos, bitmask);

    assert(neighbours4_ < 5);
    assert(neighbours8_ < 9);
    assert(neighbours4_ <= neighbours8_);
    assert(neighbours8_ <= neighbours_.size());
  }

Neighbours reco::PFRecHit::buildNeighbours ( unsigned int  n ) const

inlineprivate

Definition at line 139 of file PFRecHit.h.

References dqmiodumpmetadata::n, and neighbours_.

Referenced by neighbours(), neighbours4(), and neighbours8().

{ return Neighbours(neighbours_.data(), n); }

CaloCellGeometry const& reco::PFRecHit::caloCell ( ) const

inline

calo cell

Definition at line 89 of file PFRecHit.h.

References caloCell_.

Referenced by getCornersREP(), getCornersXYZ(), position(), and positionREP().

{ return *(caloCell_.get()); }

void reco::PFRecHit::clearNeighbours ( )

inline

Definition at line 75 of file PFRecHit.h.

References neighbourInfos_, neighbours4_, neighbours8_, and neighbours_.

                           {
      neighbours_.clear();
      neighbourInfos_.clear();
      neighbours4_ = neighbours8_ = 0;
    }

int reco::PFRecHit::depth ( ) const

inline

depth for segemntation

Definition at line 105 of file PFRecHit.h.

References depth_.

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

{ return depth_; }

unsigned reco::PFRecHit::detId ( ) const

inline

rechit detId

Definition at line 93 of file PFRecHit.h.

References detId_.

Referenced by PFAnalysis::associateClusterToSimCluster(), PFRecHitCaloNavigator< CaloTowerDetId, CaloTowerTopology >::associateNeighbours(), PFRecHitCaloNavigatorWithTime< EEDetId, EcalEndcapTopology >::associateNeighbours(), PFECALHashNavigator::associateNeighbours(), HGCRecHitNavigator< D1, hgcee, D2, hgchef, D3, hgcheb >::associateNeighbours(), PFHCALDenseIdNavigator< HcalDetId, HcalTopology, false >::associateNeighbours(), Basic2DGenericPFlowPositionCalc::calculateAndSetPositionActual(), ECALPFSeedCleaner::clean(), RBXAndHPDCleaner::clean(), SpikeAndDoubleSpikeCleaner::clean(), PFlow2DClusterizerWithTime::clusterTimeResolutionFromSeed(), PFHFRecHitCreator::DetIDSorter::operator()(), operator<<(), PFRecHitQTestDBThreshold::pass(), PFRecHitQTestECALMultiThreshold::pass(), PFRecHitQTestDBSeedingThreshold::pass(), FWPFCandidateWithHitsProxyBuilder::scaleProduct(), and PFRecHitQTestHCALCalib29::test().

{ return detId_; }

float reco::PFRecHit::energy ( ) const

inline

rechit energy

Definition at line 99 of file PFRecHit.h.

References energy_.

Referenced by FWPFCandidateWithHitsProxyBuilder::addHitsForCandidate(), PFAnalysis::associateClusterToSimCluster(), PFRecHitCaloNavigatorWithTime< EEDetId, EcalEndcapTopology >::associateNeighbour(), PFAlgo::checkCleaning(), ECALPFSeedCleaner::clean(), RBXAndHPDCleaner::clean(), SpikeAndDoubleSpikeCleaner::clean(), PFlow2DClusterizerWithTime::clusterTimeResolution(), PFlow2DClusterizerWithTime::clusterTimeResolutionFromSeed(), operator<<(), PFRecHitQTestThreshold::pass(), PFRecHitQTestDBThreshold::pass(), PFRecHitQTestECALMultiThreshold::pass(), PFRecHitQTestThresholdInMIPs::pass(), PFRecHitQTestThresholdInThicknessNormalizedMIPs::pass(), PFRecHitQTestDBSeedingThreshold::pass(), Jet.Jet::rawEnergy(), FWPFCandidateWithHitsProxyBuilder::scaleProduct(), setEnergy(), HGCalShowerShapeHelper::ShowerShapeCalc::setFilteredHitsAndFractions(), PFRecHitQTestHOThreshold::test(), and PFRecHitQTestHCALCalib29::test().

{ return energy_; }

uint32_t reco::PFRecHit::flags ( ) const

inline

Definition at line 111 of file PFRecHit.h.

References flags_.

Referenced by FlagsCleanerECAL::checkFlags(), and setFlags().

{ return flags_; }

RepCorners const& reco::PFRecHit::getCornersREP ( ) const

inline

Definition at line 124 of file PFRecHit.h.

References caloCell(), and CaloCellGeometry::getCornersREP().

{ return caloCell().getCornersREP(); }

CornersVec const& reco::PFRecHit::getCornersXYZ ( ) const

inline

rechit corners

Definition at line 122 of file PFRecHit.h.

References caloCell(), and CaloCellGeometry::getCorners().

Referenced by LinkByRecHit::testECALAndPSByRecHit().

{ return caloCell().getCorners(); }

unsigned int reco::PFRecHit::getNeighbour	(	short	x,
		short	y,
		short	z
	)		const

Definition at line 46 of file PFRecHit.cc.

References funct::abs(), mps_fire::i, SiStripPI::max, neighbourInfos_, and neighbours_.

                                                                     {
    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);

    for (unsigned int i = 0; i < neighbourInfos_.size(); ++i) {
      if (neighbourInfos_[i] == bitmask)
        return neighbours_[i];
    }
    return std::numeric_limits<unsigned int>::max();
  }

bool reco::PFRecHit::hasCaloCell ( ) const

inline

Definition at line 90 of file PFRecHit.h.

References caloCell_.

Referenced by operator<<().

{ return (caloCell_ != nullptr); }

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

inline

rechit layer

Definition at line 96 of file PFRecHit.h.

References layer_.

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

{ return layer_; }

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

inline

Definition at line 86 of file PFRecHit.h.

References neighbourInfos_.

{ return neighbourInfos_; }

Neighbours reco::PFRecHit::neighbours ( ) const

inline

Definition at line 84 of file PFRecHit.h.

References buildNeighbours(), and neighbours_.

{ return buildNeighbours(neighbours_.size()); }

Neighbours reco::PFRecHit::neighbours4 ( ) const

inline

Definition at line 81 of file PFRecHit.h.

References buildNeighbours(), and neighbours4_.

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

{ return buildNeighbours(neighbours4_); }

Neighbours reco::PFRecHit::neighbours8 ( ) const

inline

Definition at line 82 of file PFRecHit.h.

References buildNeighbours(), and neighbours8_.

{ return buildNeighbours(neighbours8_); }

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

inline

comparison < operator

Definition at line 136 of file PFRecHit.h.

References energy_.

{ return (energy_ < rhs.energy_); }

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

inline

comparison <= operator

Definition at line 133 of file PFRecHit.h.

References energy_.

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

PFRecHit& reco::PFRecHit::operator= ( const PFRecHit &  other )

default

PFRecHit& reco::PFRecHit::operator= ( PFRecHit &&  other )

default

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

inline

comparison > operator

Definition at line 130 of file PFRecHit.h.

References energy_.

{ return (energy_ > rhs.energy_); }

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

inline

comparison >= operator

Definition at line 127 of file PFRecHit.h.

References energy_.

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

PositionType const& reco::PFRecHit::position ( ) const

inline

rechit cell centre x, y, z

Definition at line 117 of file PFRecHit.h.

References PV3DBase< T, PVType, FrameType >::basicVector(), caloCell(), and CaloCellGeometry::getPosition().

Referenced by KDTreeLinkerPSEcal::buildTree(), Basic2DGenericPFlowPositionCalc::calculateAndSetPositionActual(), PFAlgo::checkCleaning(), pt2(), and LinkByRecHit::testECALAndPSByRecHit().

{ return caloCell().getPosition().basicVector(); }

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

inline

Definition at line 119 of file PFRecHit.h.

References caloCell(), and CaloCellGeometry::repPos().

Referenced by SpikeAndDoubleSpikeCleaner::clean(), and operator<<().

{ return caloCell().repPos(); }

double reco::PFRecHit::pt2 ( ) const

inline

rechit momentum transverse to the beam, squared.

Definition at line 108 of file PFRecHit.h.

References energy_, Basic3DVector< T >::mag2(), Basic3DVector< T >::perp2(), and position().

Referenced by HGCalShowerShapeHelper::ShowerShapeCalc::setFilteredHitsAndFractions().

{ return energy_ * energy_ * (position().perp2() / position().mag2()); }

void reco::PFRecHit::setDepth ( int  depth )

inline

Definition at line 74 of file PFRecHit.h.

References depth(), and depth_.

{ depth_ = depth; }

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

inline

Definition at line 69 of file PFRecHit.h.

References energy(), and energy_.

Referenced by PFHFRecHitCreator::importRecHits(), PFRecHitQTestHCALCalib29::test(), PFRecHitQTestThresholdInMIPs::test(), and PFRecHitQTestThresholdInThicknessNormalizedMIPs::test().

{ energy_ = energy; }

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

inline

Definition at line 114 of file PFRecHit.h.

References flags(), and flags_.

{ flags_ = flags; }

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

inline

Definition at line 73 of file PFRecHit.h.

References time(), and time_.

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

{ time_ = time; }

float reco::PFRecHit::time ( ) const

inline

timing for cleaned hits

Definition at line 102 of file PFRecHit.h.

References time_.

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

{ return time_; }

Member Data Documentation

std::shared_ptr<const CaloCellGeometry> reco::PFRecHit::caloCell_ = nullptr

private

cell geometry

Definition at line 142 of file PFRecHit.h.

Referenced by caloCell(), and hasCaloCell().

int reco::PFRecHit::depth_ = 0

private

depth

Definition at line 157 of file PFRecHit.h.

Referenced by depth(), and setDepth().

unsigned int reco::PFRecHit::detId_ = 0

private

cell detid

Definition at line 145 of file PFRecHit.h.

Referenced by detId().

float reco::PFRecHit::energy_ = 0

private

rechit energy

Definition at line 151 of file PFRecHit.h.

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

uint32_t reco::PFRecHit::flags_ = 0

private

Definition at line 168 of file PFRecHit.h.

Referenced by flags(), and setFlags().

PFLayer::Layer reco::PFRecHit::layer_ = PFLayer::NONE

private

rechit layer

Definition at line 148 of file PFRecHit.h.

Referenced by layer().

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

private

Definition at line 161 of file PFRecHit.h.

Referenced by addNeighbour(), clearNeighbours(), getNeighbour(), and neighbourInfos().

unsigned int reco::PFRecHit::neighbours4_ = 0

private

Definition at line 164 of file PFRecHit.h.

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

unsigned int reco::PFRecHit::neighbours8_ = 0

private

Definition at line 165 of file PFRecHit.h.

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

std::vector<unsigned int> reco::PFRecHit::neighbours_

private

indices to existing neighbours (1 common side)

Definition at line 160 of file PFRecHit.h.

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

float reco::PFRecHit::time_ = -1

private

time

Definition at line 154 of file PFRecHit.h.

Referenced by setTime(), and time().