reco::ElectronSeed Class Reference

#include <ElectronSeed.h>

Inheritance diagram for reco::ElectronSeed:

Classes
struct	PMVars

Public Types
typedef edm::RefToBase< CaloCluster >	CaloClusterRef
typedef edm::Ref< TrackCollection >	CtfTrackRef
Public Types inherited from TrajectorySeed
typedef edm::OwnVector< TrackingRecHit >	RecHitContainer
typedef edm::Range< RecHitContainer::const_iterator >	RecHitRange

Public Member Functions
void	addHitInfo (const PMVars &hitVars)
const CaloClusterRef &	caloCluster () const
ElectronSeed *	clone () const override
const CtfTrackRef &	ctfTrack () const
	Accessors. More...
int	detId (size_t hitNr) const
float	dPhiBest (size_t hitNr) const
float	dPhiNeg (size_t hitNr) const
float	dPhiPos (size_t hitNr) const
float	dRZBest (size_t hitNr) const
float	dRZNeg (size_t hitNr) const
float	dRZPos (size_t hitNr) const
	ElectronSeed ()
	Construction of base attributes. More...
	ElectronSeed (const TrajectorySeed &)
	ElectronSeed (PTrajectoryStateOnDet &pts, RecHitContainer &rh, PropagationDirection &dir)
TrackCharge	getCharge () const
	Utility. More...
const std::vector< PMVars > &	hitInfo () const
unsigned int	hitsMask () const
void	initTwoHitSeed (const unsigned char hitMask)
bool	isEcalDriven () const
bool	isTrackerDriven () const
int	layerOrDiskNr (size_t hitNr) const
int	nrLayersAlongTraj () const
void	setCaloCluster (const CaloClusterRef &clus)
void	setCtfTrack (const CtfTrackRef &)
	Set additional info. More...
void	setNegAttributes (const float dRZ2=std::numeric_limits< float >::infinity(), const float dPhi2=std::numeric_limits< float >::infinity(), const float dRZ1=std::numeric_limits< float >::infinity(), const float dPhi1=std::numeric_limits< float >::infinity())
void	setNrLayersAlongTraj (int val)
void	setPosAttributes (const float dRZ2=std::numeric_limits< float >::infinity(), const float dPhi2=std::numeric_limits< float >::infinity(), const float dRZ1=std::numeric_limits< float >::infinity(), const float dPhi1=std::numeric_limits< float >::infinity())
int	subDet (size_t hitNr) const
	~ElectronSeed () override
Public Member Functions inherited from TrajectorySeed
PropagationDirection	direction () const
unsigned int	nHits () const
TrajectorySeed &	operator= (TrajectorySeed const &o)=default
TrajectorySeed &	operator= (TrajectorySeed &&o) noexcept=default
RecHitRange	recHits () const
PTrajectoryStateOnDet const &	startingState () const
void	swap (PTrajectoryStateOnDet &ptsos, RecHitContainer &rh, PropagationDirection &dir) noexcept
void	swap (TrajectorySeed &rh) noexcept
	TrajectorySeed ()
	TrajectorySeed (PTrajectoryStateOnDet const &ptsos, RecHitContainer const &rh, PropagationDirection dir)
	TrajectorySeed (PTrajectoryStateOnDet const &ptsos, RecHitContainer &&rh, PropagationDirection dir) noexcept
	TrajectorySeed (TrajectorySeed const &o)=default
	TrajectorySeed (TrajectorySeed &&o) noexcept=default
virtual	~TrajectorySeed ()

Static Public Member Functions
static std::vector< PMVars >	createHitInfo (const float dPhi1Pos, const float dPhi1Neg, const float dRZ1Pos, const float dRZ1Neg, const float dPhi2Pos, const float dPhi2Neg, const float dRZ2Pos, const float dRZ2Neg, const char hitMask, TrajectorySeed::RecHitRange const &recHits)
static std::string const &	name ()

Private Member Functions
template<typename T >
T	getVal (unsigned int hitNr, T PMVars::*val) const

Static Private Member Functions
static float	bestVal (float val1, float val2)
static std::vector< unsigned int >	hitNrsFromMask (unsigned int hitMask)

Private Attributes
CaloClusterRef	caloCluster_
CtfTrackRef	ctfTrack_
std::vector< PMVars >	hitInfo_
bool	isEcalDriven_
bool	isTrackerDriven_
int	nrLayersAlongTraj_

Detailed Description

Definition at line 51 of file ElectronSeed.h.

Member Typedef Documentation

CaloClusterRef

typedef edm::RefToBase<CaloCluster> reco::ElectronSeed::CaloClusterRef

Definition at line 68 of file ElectronSeed.h.

CtfTrackRef

typedef edm::Ref<TrackCollection> reco::ElectronSeed::CtfTrackRef

Definition at line 69 of file ElectronSeed.h.

Constructor & Destructor Documentation

ElectronSeed() [1/3]

ElectronSeed::ElectronSeed

(

)

Construction of base attributes.

Definition at line 8 of file ElectronSeed.cc.

Referenced by clone().

    : TrajectorySeed(),
      ctfTrack_(),
      caloCluster_(),
      hitInfo_(),
      nrLayersAlongTraj_(0),
      isEcalDriven_(false),
      isTrackerDriven_(false)

{}

ElectronSeed() [2/3]

ElectronSeed::ElectronSeed

(

const TrajectorySeed &

seed

)

Definition at line 19 of file ElectronSeed.cc.

    : TrajectorySeed(seed),
      ctfTrack_(),
      caloCluster_(),
      hitInfo_(),
      nrLayersAlongTraj_(0),
      isEcalDriven_(false),
      isTrackerDriven_(false) {}

ElectronSeed() [3/3]

ElectronSeed::ElectronSeed	(	PTrajectoryStateOnDet &	pts,
		RecHitContainer &	rh,
		PropagationDirection &	dir
	)

Definition at line 28 of file ElectronSeed.cc.

    : TrajectorySeed(pts, rh, dir),
      ctfTrack_(),
      caloCluster_(),
      hitInfo_(),
      nrLayersAlongTraj_(0),
      isEcalDriven_(false),
      isTrackerDriven_(false) {}

~ElectronSeed()

ElectronSeed::~ElectronSeed ( )

overridedefault

Member Function Documentation

addHitInfo()

void reco::ElectronSeed::addHitInfo ( const PMVars &  hitVars )

inline

Definition at line 89 of file ElectronSeed.h.

References hitInfo_.

Referenced by ElectronNHitSeedProducer::produce().

{ hitInfo_.push_back(hitVars); }

bestVal()

static float reco::ElectronSeed::bestVal ( float  val1, float  val2  )

inlinestaticprivate

Definition at line 140 of file ElectronSeed.h.

References funct::abs().

Referenced by dPhiBest(), and dRZBest().

{ return std::abs(val1) < std::abs(val2) ? val1 : val2; }

caloCluster()

const CaloClusterRef& reco::ElectronSeed::caloCluster ( ) const

inline

Definition at line 93 of file ElectronSeed.h.

References caloCluster_.

Referenced by PFElecTkProducer::isSameEgSC(), and PFElecTkProducer::isSharingEcalEnergyWithEgSC().

{ return caloCluster_; }

clone()

ElectronSeed* reco::ElectronSeed::clone ( void  ) const

inlineoverridevirtual

Reimplemented from TrajectorySeed.

Definition at line 80 of file ElectronSeed.h.

References ElectronSeed().

{ return new ElectronSeed(*this); }

createHitInfo()

std::vector< ElectronSeed::PMVars > ElectronSeed::createHitInfo ( const float  dPhi1Pos, const float  dPhi1Neg, const float  dRZ1Pos, const float  dRZ1Neg, const float  dPhi2Pos, const float  dPhi2Neg, const float  dRZ2Pos, const float  dRZ2Neg, const char  hitMask, TrajectorySeed::RecHitRange const &  recHits  )

static

Definition at line 122 of file ElectronSeed.cc.

References edm::Range< T >::begin(), HLT_2023v12_cff::distance, edm::Range< T >::end(), Exception, hitInfo(), hitNrsFromMask(), and TrajectorySeed::recHits().

                                                                                                        {
  if (hitMask == 0)
    return std::vector<ElectronSeed::PMVars>();  //was trackerDriven so no matched hits

  size_t nrRecHits = std::distance(recHits.begin(), recHits.end());
  std::vector<unsigned int> hitNrs = hitNrsFromMask(hitMask);

  if (hitNrs.size() != 2) {
    throw cms::Exception("LogicError") << "in ElectronSeed::" << __FUNCTION__ << "," << __LINE__
                                       << ": number of hits in hit mask is " << nrRecHits << "\n"
                                       << "pre-2017 pixel upgrade ecalDriven ElectronSeeds should have exactly 2 hits\n"
                                       << "mask " << static_cast<unsigned int>(hitMask) << std::endl;
  }
  if (hitNrs[0] >= nrRecHits || hitNrs[1] >= nrRecHits) {
    throw cms::Exception("LogicError") << "in ElectronSeed::" << __FUNCTION__ << "," << __LINE__ << ": hits are "
                                       << hitNrs[0] << " and " << hitNrs[1] << " while number of hits are " << nrRecHits
                                       << "\n"
                                       << "this means there was a bug in storing or creating the electron seeds "
                                       << "mask " << static_cast<unsigned int>(hitMask) << std::endl;
  }

  std::vector<PMVars> hitInfo(2);
  hitInfo[0].setDPhi(dPhi1Pos, dPhi1Neg);
  hitInfo[0].setDRZ(dRZ1Pos, dRZ1Neg);
  hitInfo[0].setDet(
      (recHits.begin() + hitNrs[0])->geographicalId(),
      -1);  //getting the layer information needs tracker topo, hence why its stored in the first as its a pain to access
  hitInfo[1].setDPhi(dPhi2Pos, dPhi2Neg);
  hitInfo[1].setDRZ(dRZ2Pos, dRZ2Neg);
  hitInfo[1].setDet(
      (recHits.begin() + hitNrs[1])->geographicalId(),
      -1);  //getting the layer information needs tracker topo, hence why its stored in the first as its a pain to access
  return hitInfo;
}

ctfTrack()

const CtfTrackRef& reco::ElectronSeed::ctfTrack ( ) const

inline

Accessors.

Definition at line 92 of file ElectronSeed.h.

References ctfTrack_.

Referenced by setCtfTrack().

{ return ctfTrack_; }

detId()

int reco::ElectronSeed::detId ( size_t  hitNr ) const

inline

Definition at line 108 of file ElectronSeed.h.

References hitInfo_.

Referenced by reco::ElectronSeed::PMVars::setDet(), and subDet().

{ return hitNr < hitInfo_.size() ? hitInfo_[hitNr].detId : 0; }

dPhiBest()

float reco::ElectronSeed::dPhiBest ( size_t  hitNr ) const

inline

Definition at line 104 of file ElectronSeed.h.

References bestVal(), dPhiNeg(), and dPhiPos().

Referenced by EgammaHLTPixelMatchVarProducer::produce().

{ return bestVal(dPhiNeg(hitNr), dPhiPos(hitNr)); }

dPhiNeg()

float reco::ElectronSeed::dPhiNeg ( size_t  hitNr ) const

inline

Definition at line 102 of file ElectronSeed.h.

References reco::ElectronSeed::PMVars::dPhiNeg, and getVal().

Referenced by dPhiBest(), and reco::ElectronSeed::PMVars::setDPhi().

{ return getVal(hitNr, &PMVars::dPhiNeg); }

dPhiPos()

float reco::ElectronSeed::dPhiPos ( size_t  hitNr ) const

inline

Definition at line 103 of file ElectronSeed.h.

References reco::ElectronSeed::PMVars::dPhiPos, and getVal().

Referenced by dPhiBest(), and reco::ElectronSeed::PMVars::setDPhi().

{ return getVal(hitNr, &PMVars::dPhiPos); }

dRZBest()

float reco::ElectronSeed::dRZBest ( size_t  hitNr ) const

inline

Definition at line 107 of file ElectronSeed.h.

References bestVal(), dRZNeg(), and dRZPos().

Referenced by EgammaHLTPixelMatchVarProducer::produce().

{ return bestVal(dRZNeg(hitNr), dRZPos(hitNr)); }

dRZNeg()

float reco::ElectronSeed::dRZNeg ( size_t  hitNr ) const

inline

Definition at line 106 of file ElectronSeed.h.

References reco::ElectronSeed::PMVars::dRZNeg, and getVal().

Referenced by dRZBest(), and reco::ElectronSeed::PMVars::setDRZ().

{ return getVal(hitNr, &PMVars::dRZNeg); }

dRZPos()

float reco::ElectronSeed::dRZPos ( size_t  hitNr ) const

inline

Definition at line 105 of file ElectronSeed.h.

References reco::ElectronSeed::PMVars::dRZPos, and getVal().

Referenced by dRZBest(), and reco::ElectronSeed::PMVars::setDRZ().

{ return getVal(hitNr, &PMVars::dRZPos); }

getCharge()

TrackCharge reco::ElectronSeed::getCharge ( ) const

inline

Utility.

Definition at line 96 of file ElectronSeed.h.

References LocalTrajectoryParameters::charge(), PTrajectoryStateOnDet::parameters(), and TrajectorySeed::startingState().

{ return startingState().parameters().charge(); }

getVal()

template<typename T >

T reco::ElectronSeed::getVal ( unsigned int  hitNr, T PMVars::*  val  ) const

inlineprivate

Definition at line 142 of file ElectronSeed.h.

References hitInfo_, infinity, and heppy_batch::val.

Referenced by dPhiNeg(), dPhiPos(), dRZNeg(), dRZPos(), and layerOrDiskNr().

                                                     {
      return hitNr < hitInfo_.size() ? hitInfo_[hitNr].*val : std::numeric_limits<T>::infinity();
    }

hitInfo()

const std::vector<PMVars>& reco::ElectronSeed::hitInfo ( ) const

inline

Definition at line 101 of file ElectronSeed.h.

References hitInfo_.

Referenced by createHitInfo().

{ return hitInfo_; }

hitNrsFromMask()

std::vector< unsigned int > ElectronSeed::hitNrsFromMask ( unsigned int  hitMask )

staticprivate

Definition at line 112 of file ElectronSeed.cc.

References triggerObjects_cff::bit.

Referenced by createHitInfo(), and initTwoHitSeed().

                                                                         {
  std::vector<unsigned int> hitNrs;
  for (size_t bitNr = 0; bitNr < sizeof(hitMask) * CHAR_BIT; bitNr++) {
    char bit = 0x1 << bitNr;
    if ((hitMask & bit) != 0)
      hitNrs.push_back(bitNr);
  }
  return hitNrs;
}

hitsMask()

unsigned int ElectronSeed::hitsMask

(

)

const

Definition at line 47 of file ElectronSeed.cc.

References edm::Range< T >::begin(), hitInfo_, gpuClustering::pixelStatus::mask, TrajectorySeed::nHits(), TrajectorySeed::recHits(), and trigObjTnPSource_cfi::var.

                                          {
  int mask = 0;
  for (size_t hitNr = 0; hitNr < nHits(); hitNr++) {
    int bitNr = 0x1 << hitNr;
    int hitDetId = (recHits().begin() + hitNr)->geographicalId().rawId();
    auto detIdMatcher = [hitDetId](const ElectronSeed::PMVars& var) { return hitDetId == var.detId; };
    if (std::find_if(hitInfo_.begin(), hitInfo_.end(), detIdMatcher) != hitInfo_.end()) {
      mask |= bitNr;
    }
  }
  return mask;
}

initTwoHitSeed()

void ElectronSeed::initTwoHitSeed

(

const unsigned char

hitMask

)

Definition at line 60 of file ElectronSeed.cc.

References Exception, hitInfo_, hitNrsFromMask(), infinity, info(), TrajectorySeed::nHits(), and TrajectorySeed::recHits().

                                                             {
  hitInfo_.resize(2);

  std::vector<unsigned int> hitNrs = hitNrsFromMask(hitMask);
  if (hitNrs.size() != 2) {
    throw cms::Exception("LogicError")
        << "in ElectronSeed::" << __FUNCTION__ << "," << __LINE__ << ": number of hits in hit mask is " << hitNrs.size()
        << "\n"
        << "pre-2017 pixel upgrade ecalDriven ElectronSeeds should have exactly 2 hits\n "
        << "mask " << static_cast<unsigned int>(hitMask) << std::endl;
  }
  if (hitNrs[0] >= nHits() || hitNrs[1] >= nHits()) {
    throw cms::Exception("LogicError") << "in ElectronSeed::" << __FUNCTION__ << "," << __LINE__ << ": hits are "
                                       << hitNrs[0] << " and  " << hitNrs[1] << " while number of hits are " << nHits()
                                       << "\n"
                                       << "this means there was a bug in storing or creating the electron seeds "
                                       << "mask " << static_cast<unsigned int>(hitMask) << std::endl;
  }
  for (size_t hitNr = 0; hitNr < hitInfo_.size(); hitNr++) {
    auto& info = hitInfo_[hitNr];
    info.setDPhi(std::numeric_limits<float>::infinity(), std::numeric_limits<float>::infinity());
    info.setDRZ(std::numeric_limits<float>::infinity(), std::numeric_limits<float>::infinity());
    info.setDet((recHits().begin() + hitNrs[hitNr])->geographicalId(), -1);
  }
}

isEcalDriven()

bool reco::ElectronSeed::isEcalDriven ( ) const

inline

Definition at line 98 of file ElectronSeed.h.

References isEcalDriven_.

{ return isEcalDriven_; }

isTrackerDriven()

bool reco::ElectronSeed::isTrackerDriven ( ) const

inline

Definition at line 99 of file ElectronSeed.h.

References isTrackerDriven_.

{ return isTrackerDriven_; }

layerOrDiskNr()

int reco::ElectronSeed::layerOrDiskNr ( size_t  hitNr ) const

inline

Definition at line 110 of file ElectronSeed.h.

References getVal(), and reco::ElectronSeed::PMVars::layerOrDiskNr.

Referenced by reco::ElectronSeed::PMVars::setDet().

{ return getVal(hitNr, &PMVars::layerOrDiskNr); }

name()

static std::string const& reco::ElectronSeed::name ( )

inlinestatic

Definition at line 71 of file ElectronSeed.h.

References AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by config.CFG::__str__(), validation.Sample::digest(), and VIDSelectorBase.VIDSelectorBase::initialize().

                                   {
      static std::string const name_("ElectronSeed");
      return name_;
    }

nrLayersAlongTraj()

int reco::ElectronSeed::nrLayersAlongTraj ( ) const

inline

Definition at line 111 of file ElectronSeed.h.

References nrLayersAlongTraj_.

{ return nrLayersAlongTraj_; }

setCaloCluster()

void reco::ElectronSeed::setCaloCluster ( const CaloClusterRef &  clus )

inline

Definition at line 85 of file ElectronSeed.h.

References caloCluster_, and isEcalDriven_.

Referenced by ElectronNHitSeedProducer::produce().

                                                    {
      caloCluster_ = clus;
      isEcalDriven_ = true;
    }

setCtfTrack()

void ElectronSeed::setCtfTrack

(

const CtfTrackRef &

ctfTrack

)

Set additional info.

Definition at line 39 of file ElectronSeed.cc.

References ctfTrack(), ctfTrack_, and isTrackerDriven_.

Referenced by GoodSeedProducer::produce().

                                                          {
  ctfTrack_ = ctfTrack;
  isTrackerDriven_ = true;
}

setNegAttributes()

void ElectronSeed::setNegAttributes	(	const float	dRZ2 = std::numeric_limits<float>::infinity(),
		const float	dPhi2 = std::numeric_limits<float>::infinity(),
		const float	dRZ1 = std::numeric_limits<float>::infinity(),
		const float	dPhi1 = std::numeric_limits<float>::infinity()
	)

Definition at line 86 of file ElectronSeed.cc.

References Exception, and hitInfo_.

                                                                                    {
  if (hitInfo_.size() != 2) {
    throw cms::Exception("LogicError")
        << "ElectronSeed::setNegAttributes should only operate on seeds with exactly two hits. This is because it is a "
           "legacy function to preverse backwards compatiblity and should not be used on new code which matches "
           "variable number of hits";
  }
  hitInfo_[0].dRZNeg = dRZ1;
  hitInfo_[1].dRZNeg = dRZ2;
  hitInfo_[0].dPhiNeg = dPhi1;
  hitInfo_[1].dPhiNeg = dPhi2;
}

setNrLayersAlongTraj()

void reco::ElectronSeed::setNrLayersAlongTraj ( int  val )

inline

Definition at line 90 of file ElectronSeed.h.

References nrLayersAlongTraj_, and heppy_batch::val.

Referenced by ElectronNHitSeedProducer::produce().

{ nrLayersAlongTraj_ = val; }

setPosAttributes()

void ElectronSeed::setPosAttributes	(	const float	dRZ2 = std::numeric_limits<float>::infinity(),
		const float	dPhi2 = std::numeric_limits<float>::infinity(),
		const float	dRZ1 = std::numeric_limits<float>::infinity(),
		const float	dPhi1 = std::numeric_limits<float>::infinity()
	)

Definition at line 99 of file ElectronSeed.cc.

References Exception, and hitInfo_.

                                                                                    {
  if (hitInfo_.size() != 2) {
    throw cms::Exception("LogicError")
        << "ElectronSeed::setPosAttributes should only operate on seeds with exactly two hits. This is because it is a "
           "legacy function to preverse backwards compatiblity and should not be used on new code which matches "
           "variable number of hits";
  }
  hitInfo_[0].dRZPos = dRZ1;
  hitInfo_[1].dRZPos = dRZ2;
  hitInfo_[0].dPhiPos = dPhi1;
  hitInfo_[1].dPhiPos = dPhi2;
}

subDet()

int reco::ElectronSeed::subDet ( size_t  hitNr ) const

inline

Definition at line 109 of file ElectronSeed.h.

References detId(), and DetId::subdetId().

{ return DetId(detId(hitNr)).subdetId(); }

Member Data Documentation

caloCluster_

CaloClusterRef reco::ElectronSeed::caloCluster_

private

Definition at line 149 of file ElectronSeed.h.

Referenced by caloCluster(), and setCaloCluster().

ctfTrack_

CtfTrackRef reco::ElectronSeed::ctfTrack_

private

Definition at line 148 of file ElectronSeed.h.

Referenced by ctfTrack(), and setCtfTrack().

hitInfo_

std::vector<PMVars> reco::ElectronSeed::hitInfo_

private

Definition at line 150 of file ElectronSeed.h.

Referenced by addHitInfo(), detId(), getVal(), hitInfo(), hitsMask(), initTwoHitSeed(), setNegAttributes(), and setPosAttributes().

isEcalDriven_

bool reco::ElectronSeed::isEcalDriven_

private

Definition at line 153 of file ElectronSeed.h.

Referenced by isEcalDriven(), and setCaloCluster().

isTrackerDriven_

bool reco::ElectronSeed::isTrackerDriven_

private

Definition at line 154 of file ElectronSeed.h.

Referenced by isTrackerDriven(), and setCtfTrack().

nrLayersAlongTraj_

int reco::ElectronSeed::nrLayersAlongTraj_

private

Definition at line 151 of file ElectronSeed.h.

Referenced by nrLayersAlongTraj(), and setNrLayersAlongTraj().