HcalTopology Class Reference

#include <HcalTopology.h>

Inheritance diagram for HcalTopology:

Public Member Functions
const HcalDDDRecConstants *	dddConstants () const
int	decIEta (const HcalDetId &id, HcalDetId neighbors[2]) const
bool	decIPhi (const HcalDetId &id, HcalDetId &neighbor) const
bool	decrementDepth (HcalDetId &id) const
DetId	denseId2detId (unsigned int) const override
	return a linear packed id More...
void	depthBinInformation (HcalSubdetector subdet, int etaRing, int iphi, int zside, int &nDepthBins, int &startingBin) const
	finds the number of depth bins and which is the number to start with More...
unsigned int	detId2denseId (const DetId &id) const override
	return a linear packed id More...
unsigned int	detId2denseIdCALIB (const DetId &id) const
	return a linear packed id from CALIB More...
unsigned int	detId2denseIdHB (const DetId &id) const
	return a linear packed id from HB More...
unsigned int	detId2denseIdHE (const DetId &id) const
	return a linear packed id from HE More...
unsigned int	detId2denseIdHF (const DetId &id) const
	return a linear packed id from HF More...
unsigned int	detId2denseIdHO (const DetId &id) const
	return a linear packed id from HO More...
unsigned int	detId2denseIdHT (const DetId &id) const
	return a linear packed id from HT More...
int	doublePhiBins () const
std::vector< DetId >	down (const DetId &id) const override
std::vector< DetId >	east (const DetId &id) const override
double	etaMax (HcalSubdetector subdet) const
std::pair< double, double >	etaRange (HcalSubdetector subdet, int ieta) const
int	etaRing (HcalSubdetector subdet, double eta) const
	eta and phi index from eta, phi values More...
void	exclude (const HcalDetId &id)
int	exclude (HcalSubdetector subdet, int ieta1, int ieta2, int iphi1, int iphi2, int depth1=1, int depth2=4)
void	excludeSubdetector (HcalSubdetector subdet)
int	firstHBRing () const
int	firstHEDoublePhiRing () const
int	firstHEQuadPhiRing () const
int	firstHERing () const
int	firstHETripleDepthRing () const
int	firstHFQuadPhiRing () const
int	firstHFRing () const
int	firstHORing () const
unsigned int	getCALIBSize () const
void	getDepthSegmentation (const unsigned ring, std::vector< int > &readoutDepths, const bool flag=false) const
unsigned int	getHBSize () const
unsigned int	getHESize () const
unsigned int	getHFSize () const
unsigned int	getHOSize () const
unsigned int	getHTSize () const
bool	getMergePositionFlag () const
unsigned int	getNumberOfShapes () const
int	getPhiZOne (std::vector< std::pair< int, int > > &phiz) const
	HcalTopology (const HcalDDDRecConstants *hcons, const bool mergePosition=false)
	HcalTopology (HcalTopologyMode::Mode mode, int maxDepthHB, int maxDepthHE, HcalTopologyMode::TriggerMode tmode=HcalTopologyMode::TriggerMode_2009)
HcalDetId	idBack (const HcalDetId &id) const
HcalDetId	idFront (const HcalDetId &id) const
int	incIEta (const HcalDetId &id, HcalDetId neighbors[2]) const
bool	incIPhi (const HcalDetId &id, HcalDetId &neighbor) const
bool	incrementDepth (HcalDetId &id) const
bool	isBH () const
int	lastHBRing () const
int	lastHERing () const
int	lastHFRing () const
int	lastHORing () const
int	maxDepth (HcalSubdetector subdet) const
int	maxDepthHB () const
int	maxDepthHE () const
HcalDetId	mergedDepthDetId (const HcalDetId &id) const
HcalTopologyMode::Mode	mode () const
unsigned int	ncells () const override
	return a count of valid cells (for dense indexing use) More...
std::vector< DetId >	north (const DetId &id) const override
int	nPhiBins (int etaRing) const
	how many phi segments in this ring More...
int	nPhiBins (HcalSubdetector subdet, int etaRing) const
int	phiBin (HcalSubdetector subdet, int etaRing, double phi) const
std::pair< int, int >	segmentBoundaries (const unsigned ring, const unsigned depth, const bool flag=false) const
void	setDepthSegmentation (const unsigned ring, const std::vector< int > &readoutDepths, const bool flag)
int	singlePhiBins () const
std::vector< DetId >	south (const DetId &id) const override
int	topoVersion () const override
	return a version which identifies the given topology More...
HcalTopologyMode::TriggerMode	triggerMode () const
void	unmergeDepthDetId (const HcalDetId &id, std::vector< HcalDetId > &ids) const
std::vector< DetId >	up (const DetId &id) const override
bool	valid (const DetId &id) const override
bool	validDetId (HcalSubdetector subdet, int ieta, int iphi, int depth) const
bool	validHcal (const HcalDetId &id) const
bool	validHcal (const HcalDetId &id, const unsigned int flag) const
bool	validHT (const HcalTrigTowerDetId &id) const
std::vector< DetId >	west (const DetId &id) const override
bool	withSpecialRBXHBHE () const
Public Member Functions inherited from CaloSubdetectorTopology
	CaloSubdetectorTopology ()
	standard constructor More...
virtual bool	denseIdConsistent (int topoVer) const
	return whether this topology is consistent with the numbering in the given topology More...
virtual std::vector< DetId >	getAllNeighbours (const DetId &id) const
virtual std::vector< DetId >	getNeighbours (const DetId &id, const CaloDirection &dir) const
virtual std::vector< DetId >	getWindow (const DetId &id, const int &northSouthSize, const int &eastWestSize) const
virtual DetId	goDown (const DetId &id) const
virtual DetId	goEast (const DetId &id) const
virtual DetId	goNorth (const DetId &id) const
virtual DetId	goSouth (const DetId &id) const
virtual DetId	goUp (const DetId &id) const
virtual DetId	goWest (const DetId &id) const
virtual	~CaloSubdetectorTopology ()
	virtual destructor More...

Static Public Member Functions
static std::string	producerTag ()

Private Types
enum	{   kHBhalf = 1296, kHEhalf = 1296, kHOhalf = 1080, kHFhalf = 864,   kHThalf = 2088, kZDChalf = 11, kCASTORhalf = 224, kCALIBhalf = 693,   kHThalfPhase1 = 2520, kHcalhalf = kHBhalf + kHEhalf + kHOhalf + kHFhalf }
enum	{ kSizeForDenseIndexingPreLS1 = 2*kHcalhalf }
enum	{ kHBSizePreLS1 = 2*kHBhalf }
enum	{ kHESizePreLS1 = 2*kHEhalf }
enum	{ kHOSizePreLS1 = 2*kHOhalf }
enum	{ kHFSizePreLS1 = 2*kHFhalf }
enum	{ kHTSizePreLS1 = 2*kHThalf }
enum	{ kHTSizePhase1 = 2*kHThalfPhase1 }
enum	{ kCALIBSizePreLS1 = 2*kCALIBhalf }
typedef std::map< unsigned, std::vector< int > >	SegmentationMap

Private Member Functions
int	decAIEta (const HcalDetId &id, HcalDetId neighbors[2]) const
unsigned int	detId2denseIdPreLS1 (const DetId &id) const
int	incAIEta (const HcalDetId &id, HcalDetId neighbors[2]) const
bool	isExcluded (const HcalDetId &id) const
bool	validDetIdPreLS1 (const HcalDetId &id) const
bool	validRaw (const HcalDetId &id) const

Private Attributes
unsigned int	CALIBSize_
SegmentationMap	depthSegmentation_
SegmentationMap	depthSegmentationOne_
int	doublePhiBins_
std::vector< double >	dPhiTable
std::vector< double >	dPhiTableHF
std::vector< HcalDDDRecConstants::HcalEtaBin >	etaBinsHB_
std::vector< HcalDDDRecConstants::HcalEtaBin >	etaBinsHE_
int	etaHE2HF_
int	etaHF2HE_
std::vector< double >	etaTable
std::vector< double >	etaTableHF
bool	excludeHB_
bool	excludeHE_
bool	excludeHF_
bool	excludeHO_
std::vector< HcalDetId >	exclusionList_
int	firstHBRing_
int	firstHEDoublePhiRing_
int	firstHEQuadPhiRing_
int	firstHERing_
int	firstHETripleDepthRing_
int	firstHFQuadPhiRing_
int	firstHFRing_
int	firstHORing_
unsigned int	HBSize_
const HcalDDDRecConstants *	hcons_
unsigned int	HESize_
unsigned int	HFSize_
unsigned int	HOSize_
unsigned int	HTSize_
int	lastHBRing_
int	lastHERing_
int	lastHFRing_
int	lastHORing_
int	maxDepthHB_
int	maxDepthHE_
int	maxDepthHF_
int	maxEta_
int	maxPhiHE_
bool	mergePosition_
HcalTopologyMode::Mode	mode_
int	nEtaHB_
int	nEtaHE_
unsigned int	numberOfShapes_
std::vector< double >	phioff
int	singlePhiBins_
int	topoVersion_
HcalTopologyMode::TriggerMode	triggerMode_
std::vector< int >	unitPhi
std::vector< int >	unitPhiHF

Additional Inherited Members
Protected Types inherited from CaloSubdetectorTopology
typedef std::pair< int, int >	Coordinate
Protected Member Functions inherited from CaloSubdetectorTopology
Coordinate	getNeighbourIndex (const Coordinate &coord, const CaloDirection &dir) const

Detailed Description

The HcalTopology class contains a set of constants which represent the topology (tower relationship) of the CMS HCAL as built. These constants can be used to determine neighbor relationships and existence of cells.

For use with limited setups (testbeam, cosmic stands, etc), the topology can be limited by creating a rejection list – a list of cells which would normally exist in the full CMS HCAL, but are not present for the specified topology.

Definition at line 25 of file HcalTopology.h.

Member Typedef Documentation

typedef std::map<unsigned, std::vector<int> > HcalTopology::SegmentationMap

private

Definition at line 223 of file HcalTopology.h.

Member Enumeration Documentation

anonymous enum

private

Enumerator
kHBhalf
kHEhalf
kHOhalf
kHFhalf
kHThalf
kZDChalf
kCASTORhalf
kCALIBhalf
kHThalfPhase1
kHcalhalf

Definition at line 227 of file HcalTopology.h.

       { kHBhalf = 1296 ,
     kHEhalf = 1296 ,
     kHOhalf = 1080 ,
     kHFhalf = 864  ,
     kHThalf = 2088,
     kZDChalf = 11,
     kCASTORhalf = 224,
     kCALIBhalf = 693,
         kHThalfPhase1 = 2520 ,
     kHcalhalf = kHBhalf + kHEhalf + kHOhalf + kHFhalf } ;

anonymous enum

private

Enumerator
kSizeForDenseIndexingPreLS1

Definition at line 237 of file HcalTopology.h.

{ kSizeForDenseIndexingPreLS1 = 2*kHcalhalf } ;

anonymous enum

private

Enumerator
kHBSizePreLS1

Definition at line 238 of file HcalTopology.h.

{ kHBSizePreLS1 = 2*kHBhalf } ;

anonymous enum

private

Enumerator
kHESizePreLS1

Definition at line 239 of file HcalTopology.h.

{ kHESizePreLS1 = 2*kHEhalf } ;

anonymous enum

private

Enumerator
kHOSizePreLS1

Definition at line 240 of file HcalTopology.h.

{ kHOSizePreLS1 = 2*kHOhalf } ;

anonymous enum

private

Enumerator
kHFSizePreLS1

Definition at line 241 of file HcalTopology.h.

{ kHFSizePreLS1 = 2*kHFhalf } ;

anonymous enum

private

Enumerator
kHTSizePreLS1

Definition at line 242 of file HcalTopology.h.

{ kHTSizePreLS1 = 2*kHThalf } ;

anonymous enum

private

Enumerator
kHTSizePhase1

Definition at line 243 of file HcalTopology.h.

{ kHTSizePhase1 = 2*kHThalfPhase1 } ;

anonymous enum

private

Enumerator
kCALIBSizePreLS1

Definition at line 244 of file HcalTopology.h.

{ kCALIBSizePreLS1 = 2*kCALIBhalf };

Constructor & Destructor Documentation

HcalTopology::HcalTopology	(	const HcalDDDRecConstants *	hcons,
		const bool	mergePosition = false
	)

Definition at line 17 of file HcalTopology.cc.

References gather_cfg::cout, dPhiTable, dPhiTableHF, PVValHelper::eta, etaBinsHB_, etaBinsHE_, etaHE2HF_, etaHF2HE_, etaTable, etaTableHF, plotBeamSpotDB::first, firstHBRing_, firstHEDoublePhiRing_, firstHEQuadPhiRing_, firstHERing_, firstHETripleDepthRing_, firstHFQuadPhiRing_, firstHFRing_, firstHORing_, HcalDDDRecConstants::getDepth(), HcalDDDRecConstants::getEtaBins(), HcalDDDRecConstants::getEtaRange(), HcalDDDRecConstants::getEtaTable(), HcalDDDRecConstants::getEtaTableHF(), HcalDDDRecConstants::getMaxDepth(), HcalDDDRecConstants::getNEta(), HcalDDDRecConstants::getNPhi(), HcalDDDRecConstants::getPhiOffs(), HcalDDDRecConstants::getPhiTable(), HcalDDDRecConstants::getPhiTableHF(), HcalDDDRecConstants::getTopoMode(), HcalDDDRecConstants::getTriggerMode(), HBSize_, hcons_, HESize_, HFSize_, HOSize_, HTSize_, mps_fire::i, createfilelist::int, IPHI_MAX, gen::k, kHBSizePreLS1, kHESizePreLS1, kHFSizePreLS1, kHOSizePreLS1, kHTSizePhase1, kHTSizePreLS1, lastHBRing_, lastHERing_, lastHFRing_, lastHORing_, HcalTopologyMode::LHC, M_PI, maxDepthHB_, maxDepthHE_, maxDepthHF_, maxEta_, maxPhiHE_, mode_, DetIdAssociatorESProducer_cff::nEta, nEtaHB_, nEtaHE_, numberOfShapes_, phioff, relativeConstraints::ring, edm::second(), setDepthSegmentation(), HcalTopologyMode::SLHC, topoVersion_, triggerMode_, HcalTopologyMode::TriggerMode_2009, csvLumiCalc::unit, unitPhi, unitPhiHF, and units().

Referenced by HcalTopologyIdealEP::produce().

                                         :
  hcons_(hcons), mergePosition_(mergePosition),
  excludeHB_(false), excludeHE_(false), excludeHO_(false), excludeHF_(false),
  firstHBRing_(1),
  firstHERing_(999), lastHERing_(0),
  firstHFRing_(29),  lastHFRing_(41),
  firstHORing_(1),   lastHORing_(15),
  firstHEDoublePhiRing_(999), firstHEQuadPhiRing_(999),
  firstHFQuadPhiRing_(40), firstHETripleDepthRing_(999),
  singlePhiBins_(IPHI_MAX), doublePhiBins_(36), maxPhiHE_(IPHI_MAX) {

  mode_       = (HcalTopologyMode::Mode)(hcons_->getTopoMode());
  triggerMode_= (HcalTopologyMode::TriggerMode)(hcons_->getTriggerMode());
  maxDepthHB_ = hcons_->getMaxDepth(0);
  maxDepthHE_ = hcons_->getMaxDepth(1);
  maxDepthHF_ = hcons_->getMaxDepth(2);
  etaBinsHB_  = hcons_->getEtaBins(0);
  etaBinsHE_  = hcons_->getEtaBins(1);
  nEtaHB_     = (hcons_->getEtaRange(0)).second-(hcons_->getEtaRange(0)).first+1;
  lastHBRing_ = firstHBRing_+nEtaHB_-1;
  if (hcons_->getNPhi(1) > maxPhiHE_) maxPhiHE_ = hcons_->getNPhi(1);
  for (auto & i : etaBinsHE_) {
    if (firstHERing_ > i.ieta) firstHERing_ = i.ieta;
    if (lastHERing_  < i.ieta) lastHERing_  = i.ieta;
    int unit = (int)((i.dphi+0.01)/(5.0*CLHEP::deg));
    if (unit == 2 && firstHEDoublePhiRing_ > i.ieta)
      firstHEDoublePhiRing_ = i.ieta;
    if (unit == 4 && firstHEQuadPhiRing_ > i.ieta)
      firstHEQuadPhiRing_ = i.ieta;
    if (i.layer.size() > 2 && firstHETripleDepthRing_ > i.ieta) 
      firstHETripleDepthRing_ = i.ieta;
  }
  nEtaHE_     = (lastHERing_ - firstHERing_ + 1);
  if (mode_==HcalTopologyMode::LHC) {
    topoVersion_=0; //DL
    HBSize_     = kHBSizePreLS1; // qie-per-fiber * fiber/rm * rm/rbx * rbx/barrel * barrel/hcal
    HESize_     = kHESizePreLS1; // qie-per-fiber * fiber/rm * rm/rbx * rbx/endcap * endcap/hcal
    HOSize_     = kHOSizePreLS1; // ieta * iphi * 2
    HFSize_     = kHFSizePreLS1;  // ieta * iphi * depth * 2
    numberOfShapes_ = 87;
  } else if (mode_==HcalTopologyMode::SLHC) { // need to know more eventually
    topoVersion_=10;
    HBSize_     = nEtaHB_*IPHI_MAX*maxDepthHB_*2;
    HESize_     = nEtaHE_*maxPhiHE_*maxDepthHE_*2;
    HOSize_     = (lastHORing_-firstHORing_+1)*IPHI_MAX*2; // ieta * iphi * 2
    HFSize_     = (lastHFRing_-firstHFRing_+1)*IPHI_MAX*maxDepthHF_*2;  // ieta * iphi * depth * 2
    numberOfShapes_ = (maxPhiHE_ > 72) ? 1200 : 500;
  }
  maxEta_ = (lastHERing_ > lastHFRing_) ? lastHERing_ : lastHFRing_;
  if (triggerMode_ == HcalTopologyMode::TriggerMode_2009) {
    HTSize_ = kHTSizePreLS1;
  } else {
    HTSize_ = kHTSizePhase1;
  }

#ifdef EDM_ML_DEBUG
  std::cout << "Topo sizes " << HBSize_ << ":" << HESize_ << ":" << HOSize_
        << ":" << HFSize_ << ":" << HTSize_ << " for mode " << mode_ 
        << ":" << triggerMode_ << std::endl;
#endif

  //The transition between HE/HF in eta
  etaTableHF  = hcons_->getEtaTableHF();
  etaTable    = hcons_->getEtaTable();
  dPhiTableHF = hcons_->getPhiTableHF();
  dPhiTable   = hcons_->getPhiTable();
  phioff      = hcons_->getPhiOffs();
  std::pair<int,int>  ietaHF = hcons_->getEtaRange(2);
  double eta  = etaBinsHE_[etaBinsHE_.size()-1].etaMax;
  etaHE2HF_   = firstHFRing_;
  for (unsigned int i=1; i<etaTableHF.size(); ++i) {
    if (eta < etaTableHF[i]) {
      etaHE2HF_ = ietaHF.first + i - 1;
      break;
    }
  }
  eta         = etaTableHF[0];
  etaHF2HE_   = lastHERing_;
  for (auto & i : etaBinsHE_) {
    if (eta < i.etaMax) {
      etaHF2HE_ = i.ieta;
      break;
    }
  }
  const double fiveDegInRad = 2*M_PI/72;
  for (double k : dPhiTable) {
    int units = (int)(k/fiveDegInRad+0.5);
    unitPhi.emplace_back(units);
  }
  for (double k : dPhiTableHF) {
    int units = (int)(k/fiveDegInRad+0.5);
    unitPhiHF.emplace_back(units);
  }
  int nEta = hcons_->getNEta();
  for (int ring=1; ring<=nEta; ++ring) {
    std::vector<int> segmentation = hcons_->getDepth(ring-1,false);
    setDepthSegmentation(ring,segmentation,false);
#ifdef EDM_ML_DEBUG
    std::cout << "Set segmentation for ring " << ring << " with " 
              << segmentation.size() << " elements:";
    for (unsigned int k=0; k<segmentation.size(); ++k) 
      std::cout << " " << segmentation[k];
    std::cout << std::endl;
#endif
    segmentation = hcons_->getDepth(ring-1,true);
    setDepthSegmentation(ring,segmentation,true);
#ifdef EDM_ML_DEBUG
    std::cout << "Set Plan-1 segmentation for ring " << ring << " with " 
              << segmentation.size() << " elements:";
    for (unsigned int k=0; k<segmentation.size(); ++k) 
      std::cout << " " << segmentation[k];
    std::cout << std::endl;
#endif
  }

#ifdef EDM_ML_DEBUG
  std::cout << "Constants in HcalTopology " << firstHBRing_ << ":" 
            << lastHBRing_ << " " << firstHERing_ << ":" << lastHERing_ << ":" 
            << firstHEDoublePhiRing_ << ":" << firstHEQuadPhiRing_ << ":" 
            << firstHETripleDepthRing_ << " " << firstHFRing_ << ":" 
            << lastHFRing_ << ":" << firstHFQuadPhiRing_ << " " << firstHORing_
            << ":" << lastHORing_ << " " << maxDepthHB_ << ":" << maxDepthHE_ 
            << " " << nEtaHB_ << ":" << nEtaHE_ << " " << etaHE2HF_ << ":" 
            << etaHF2HE_ << " " << maxPhiHE_ << std::endl;
#endif
}

HcalTopology::HcalTopology	(	HcalTopologyMode::Mode	mode,
		int	maxDepthHB,
		int	maxDepthHE,
		HcalTopologyMode::TriggerMode	tmode = HcalTopologyMode::TriggerMode_2009
	)

Definition at line 145 of file HcalTopology.cc.

References firstHBRing_, firstHERing_, HBSize_, HESize_, HFSize_, HOSize_, HTSize_, IPHI_MAX, kHBSizePreLS1, kHESizePreLS1, kHFSizePreLS1, kHOSizePreLS1, kHTSizePhase1, kHTSizePreLS1, lastHBRing_, lastHERing_, HcalTopologyMode::LHC, maxDepthHF_, maxPhiHE_, mode_, nEtaHB_, nEtaHE_, HcalTopologyMode::SLHC, topoVersion_, triggerMode_, and HcalTopologyMode::TriggerMode_2009.

                                                                                                                       :
  hcons_(nullptr), mergePosition_(false),
  excludeHB_(false), excludeHE_(false), excludeHO_(false), excludeHF_(false),
  mode_(mode), triggerMode_(tmode),
  firstHBRing_(1),   lastHBRing_(16),
  firstHERing_(16),  lastHERing_(29),
  firstHFRing_(29),  lastHFRing_(41),
  firstHORing_(1),   lastHORing_(15),
  firstHEDoublePhiRing_((mode==HcalTopologyMode::H2 || mode==HcalTopologyMode::H2HE)?(22):(21)),
  firstHEQuadPhiRing_(999), firstHFQuadPhiRing_(40),
  firstHETripleDepthRing_((mode==HcalTopologyMode::H2 || mode==HcalTopologyMode::H2HE)?(24):(27)),
  singlePhiBins_(IPHI_MAX), doublePhiBins_(36),
  maxDepthHB_(maxDepthHB), maxDepthHE_(maxDepthHE), maxDepthHF_(2),
  etaHE2HF_(30), etaHF2HE_(29), maxPhiHE_(IPHI_MAX),
  HBSize_(kHBSizePreLS1),
  HESize_(kHESizePreLS1),
  HOSize_(kHOSizePreLS1),
  HFSize_(kHFSizePreLS1),
  HTSize_(kHTSizePreLS1),
  numberOfShapes_(( mode==HcalTopologyMode::SLHC ) ? 500 : 87 ) {

  if (mode_==HcalTopologyMode::LHC) {
    topoVersion_=0; //DL
    HBSize_= kHBSizePreLS1; // qie-per-fiber * fiber/rm * rm/rbx * rbx/barrel * barrel/hcal
    HESize_= kHESizePreLS1; // qie-per-fiber * fiber/rm * rm/rbx * rbx/endcap * endcap/hcal
    HOSize_= kHOSizePreLS1; // ieta * iphi * 2
    HFSize_= kHFSizePreLS1; // phi * eta * depth * pm
  } else if (mode_==HcalTopologyMode::SLHC) { // need to know more eventually
    HBSize_= maxDepthHB*16*IPHI_MAX*2;
    HESize_= maxDepthHE*(29-16+1)*maxPhiHE_*2;
    HOSize_= 15*IPHI_MAX*2; // ieta * iphi * 2
    HFSize_= IPHI_MAX*13*maxDepthHF_*2; // phi * eta * depth * pm 
    topoVersion_=10;
  }
  nEtaHB_ = (lastHBRing_-firstHBRing_+1);
  nEtaHE_ = (lastHERing_-firstHERing_+1);
  if (triggerMode_ == HcalTopologyMode::TriggerMode_2009) {
    HTSize_ = kHTSizePreLS1;
  } else {
    HTSize_ = kHTSizePhase1;
  }

  edm::LogWarning("CaloTopology") << "This is an incomplete constructor of HcalTopology - be warned that many functionalities will not be there - revert from this - get from EventSetup";
}

Member Function Documentation

const HcalDDDRecConstants* HcalTopology::dddConstants ( ) const

inline

Definition at line 161 of file HcalTopology.h.

References hcons_.

Referenced by HcalRaddamMuon::analyze(), CaloTruthAccumulator::beginLuminosityBlock(), HcalHBHEMuonAnalyzer::depth16HE(), HcalGeometry::getClosestCell(), CaloTPGTranscoderULUT::setup(), HGCalTriggerNtupleHGCDigis::simhits(), and HcaluLUTTPGCoder::update().

{return hcons_;}

int HcalTopology::decAIEta ( const HcalDetId &  id, HcalDetId  neighbors[2]  ) const

private

Get the neighbors of the given cell with lower absolute ieta

Decreasing in |ieta|, there are be two neighbors of 40 and 21

Definition at line 617 of file HcalTopology.cc.

References particleFlowClusterECALTimeSelected_cfi::depth, etaHF2HE_, firstHEDoublePhiRing(), firstHEQuadPhiRing(), firstHERing(), firstHFQuadPhiRing(), firstHFRing(), HcalBarrel, HcalEndcap, IPHI_MAX, gen::n, valid(), and HcalDigiParam_cfi::zside.

Referenced by decIEta(), idBack(), and incIEta().

                                                                            {
  int n=1;
  int aieta=id.ietaAbs();

  if (aieta==firstHEDoublePhiRing()) { 
    n=2;
    neighbors[0]=HcalDetId(id.subdet(),(aieta-1)*id.zside(),id.iphi(),id.depth());
    neighbors[1]=HcalDetId(id.subdet(),(aieta-1)*id.zside(),id.iphi()+1,id.depth());
  } else if (aieta==firstHFQuadPhiRing()) {
    n=2;
    neighbors[0]=HcalDetId(id.subdet(),(aieta-1)*id.zside(),id.iphi(),id.depth());
    if (id.iphi()==IPHI_MAX-1) neighbors[1]=HcalDetId(id.subdet(),(aieta-1)*id.zside(),1,id.depth());
    else neighbors[1]=HcalDetId(id.subdet(),(aieta-1)*id.zside(),id.iphi()+2,id.depth());
  } else if (aieta==firstHEQuadPhiRing()) {
    n=2;
    neighbors[0]=HcalDetId(id.subdet(),(aieta-1)*id.zside(),id.iphi(),id.depth());
    if (id.iphi()==IPHI_MAX-1) neighbors[1]=HcalDetId(id.subdet(),(aieta-1)*id.zside(),1,id.depth());
    else                       neighbors[1]=HcalDetId(id.subdet(),(aieta-1)*id.zside(),id.iphi()+2,id.depth());
  } else if (aieta==1) {
    neighbors[0]=HcalDetId(id.subdet(),-aieta*id.zside(),id.iphi(),id.depth());
  } else if (aieta==firstHERing()) {
    neighbors[0]=HcalDetId(HcalBarrel,(aieta-1)*id.zside(),id.iphi(),1);
  } else if (aieta==firstHFRing()) {
    neighbors[0]=HcalDetId(HcalEndcap,etaHF2HE_*id.zside(),id.iphi(),1);
  } else
    neighbors[0]=HcalDetId(id.subdet(),(aieta-1)*id.zside(),id.iphi(),id.depth());
  
  if (!valid(neighbors[0]) && n==2) {
    if (!valid(neighbors[1])) n=0;
    else {
      n=1;
      neighbors[0]=neighbors[1];
    }
  }
  if (n==2 && !valid(neighbors[1])) n=1;
  if (n==1 && !valid(neighbors[0])) n=0;

  return n;
}

int HcalTopology::decIEta	(	const HcalDetId &	id,
		HcalDetId	neighbors[2]
	)		const

Get the neighbors of the given cell with lower (signed) ieta

Definition at line 589 of file HcalTopology.cc.

References decAIEta(), incAIEta(), and HcalDigiParam_cfi::zside.

Referenced by east(), and producerTag().

                                                                           {
  if (id.zside()==1) return decAIEta(id,neighbors);
  else return incAIEta(id,neighbors);
}

bool HcalTopology::decIPhi	(	const HcalDetId &	id,
		HcalDetId &	neighbor
	)		const

Get the neighbor (if present) of the given cell with lower iphi

Definition at line 547 of file HcalTopology.cc.

References particleFlowClusterECALTimeSelected_cfi::depth, firstHEDoublePhiRing(), firstHEQuadPhiRing(), firstHFQuadPhiRing(), HcalBarrel, HcalEndcap, HcalForward, HcalOuter, IPHI_MAX, maxPhiHE_, convertSQLiteXML::ok, valid(), and validRaw().

Referenced by producerTag(), and south().

                                                                         {
  bool ok=valid(id);
  if (ok) {
    switch (id.subdet()) {
    case (HcalBarrel):
    case (HcalOuter):
      if (id.iphi()==1) neighbor=HcalDetId(id.subdet(),id.ieta(),IPHI_MAX,id.depth()); 
      else neighbor=HcalDetId(id.subdet(),id.ieta(),id.iphi()-1,id.depth()); 
      break;
    case (HcalEndcap):
      if (id.ietaAbs()>=firstHEQuadPhiRing()) {
        if (id.iphi()==3) neighbor=HcalDetId(id.subdet(),id.ieta(),IPHI_MAX-1,id.depth()); 
        else              neighbor=HcalDetId(id.subdet(),id.ieta(),id.iphi()-4,id.depth()); 
      } else if (id.ietaAbs()>=firstHEDoublePhiRing()) {
    if (id.iphi()==1) neighbor=HcalDetId(id.subdet(),id.ieta(),IPHI_MAX-1,id.depth()); 
    else neighbor=HcalDetId(id.subdet(),id.ieta(),id.iphi()-2,id.depth()); 
      } else {
    if (id.iphi()==1) neighbor=HcalDetId(id.subdet(),id.ieta(),maxPhiHE_,id.depth()); 
    else neighbor=HcalDetId(id.subdet(),id.ieta(),id.iphi()-1,id.depth()); 
      }
      break;
    case (HcalForward):
      if (id.ietaAbs()>=firstHFQuadPhiRing()) {
    if (id.iphi()==3) neighbor=HcalDetId(id.subdet(),id.ieta(),IPHI_MAX-1,id.depth()); 
    else neighbor=HcalDetId(id.subdet(),id.ieta(),id.iphi()-4,id.depth()); 
      } else {
    if (id.iphi()==1) neighbor=HcalDetId(id.subdet(),id.ieta(),IPHI_MAX-1,id.depth()); 
    else neighbor=HcalDetId(id.subdet(),id.ieta(),id.iphi()-2,id.depth()); 
      }
      if (!validRaw(neighbor)) ok = false;
      break;
    default: ok=false;
    }
  } 
  return ok;
}

bool HcalTopology::decrementDepth

(

HcalDetId &

id

)

const

Get the detector in front of this one

Definition at line 757 of file HcalTopology.cc.

References particleFlowClusterECALTimeSelected_cfi::depth, HcalDetId::depth(), depthBinInformation(), etaBinsHB_, etaBinsHE_, etaHF2HE_, etaRing(), firstHERing(), firstHFRing(), HcalDDDRecConstants::getDepthEta29(), HcalBarrel, HcalEndcap, HcalForward, HcalOuter, hcons_, mps_fire::i, HcalDetId::ieta(), HcalDetId::ietaAbs(), HcalDetId::iphi(), lastHERing(), mode_, nEtaHB_, HcalTopologyMode::SLHC, HcalDetId::subdet(), validRaw(), HcalDigiParam_cfi::zside, and HcalDetId::zside().

Referenced by down(), and producerTag().

                                                         {
  HcalSubdetector subdet = detId.subdet();
  int ieta    = detId.ieta();
  int etaRing = detId.ietaAbs();
  int depth   = detId.depth();
  int iphi    = detId.iphi();
  int zside   = detId.zside();
  int nDepthBins, startingBin;
  depthBinInformation(subdet, etaRing, iphi, zside, nDepthBins, startingBin);

  // see if the new depth bin exists
  --depth;
  if ((subdet == HcalOuter) ||
      (subdet == HcalEndcap && etaRing == firstHERing())) {
    subdet = HcalBarrel;
    for (int i=0; i<nEtaHB_; ++i) {
      if (etaRing == etaBinsHB_[i].ieta) {
        depth = etaBinsHB_[i].depthStart+etaBinsHB_[i].layer.size()-1;
        break;
      }
    }
  } else if (subdet == HcalEndcap && etaRing ==  lastHERing() && 
         depth == hcons_->getDepthEta29(iphi,zside,0) &&
             mode_ != HcalTopologyMode::SLHC) {
    (ieta > 0) ? --ieta : ++ieta;
  } else if (depth <= 0) {
    if (subdet == HcalForward && etaRing ==  firstHFRing()) {
      // overlap
      subdet = HcalEndcap;
      etaRing= etaHF2HE_;
      ieta   = (ieta > 0) ? etaRing : -etaRing;
      for (const auto & i : etaBinsHE_) {
        if (etaRing == i.ieta) {
          depth = i.depthStart+i.layer.size()-1;
          break;
        }
      }
    } else {
      // no more chances
      detId = HcalDetId();
      return false;
    }
  }
  detId = HcalDetId(subdet, ieta, detId.iphi(), depth);
  return validRaw(detId);
}

DetId HcalTopology::denseId2detId ( unsigned int  denseid ) const

overridevirtual

return a linear packed id

Reimplemented from CaloSubdetectorTopology.

Definition at line 1188 of file HcalTopology.cc.

References gather_cfg::cout, TauDecayModes::dec, reco::dp, firstHBRing(), firstHERing(), HBSize_, HcalBarrel, HcalEndcap, HcalForward, HcalOuter, HESize_, HOSize_, recoMuon::in, IPHI_MAX, kHBhalf, kHEhalf, kHFhalf, kHOhalf, kSizeForDenseIndexingPreLS1, lastHBRing(), lastHERing(), maxDepthHB_, maxDepthHE_, maxDepthHF_, maxPhiHE_, ncells(), nEtaHB_, nEtaHE_, DetId::rawId(), sd, and topoVersion_.

Referenced by HcalGeometry::localCorners(), CaloGeometryDBEP< T, U >::produceAligned(), and producerTag().

                                                            {

  HcalSubdetector sd ( HcalBarrel ) ;
  int ie ( 0 ) ;
  int ip ( 0 ) ;
  int dp ( 0 ) ;
  int in ( denseid ) ;
  int iz ( 1 ) ;
  if (topoVersion_==0) { //DL// pre-LS1
    if (denseid < kSizeForDenseIndexingPreLS1) {
      if ( in > 2*( kHBhalf + kHEhalf + kHOhalf ) - 1 ) { // HF
    sd  = HcalForward ;
    in -= 2*( kHBhalf + kHEhalf + kHOhalf ) ; 
    iz  = ( in<kHFhalf ? 1 : -1 ) ;
    in %= kHFhalf ; 
    ip  = 4*( in/48 ) ;
    in %= 48 ;
    ip += 1 + ( in>21 ? 2 : 0 ) ;
    if( 3 == ip%4 ) in -= 22 ;
    ie  = 29 + in/2 ;
    dp  = 1 + in%2 ;
      } else if ( in > 2*( kHBhalf + kHEhalf ) - 1 ) { // HO
    sd  = HcalOuter ;
    in -= 2*( kHBhalf + kHEhalf ) ; 
    iz  = ( in<kHOhalf ? 1 : -1 ) ;
    in %= kHOhalf ; 
    dp  = 4 ;
    ip  = 1 + in/15 ;
    ie  = 1 + ( in - 15*( ip - 1 ) ) ;
      } else if ( in > 2*kHBhalf - 1 ) { // Endcap
    sd  = HcalEndcap ;
    in -= 2*kHBhalf ;
    iz  = ( in<kHEhalf ? 1 : -1 ) ;
    in %= kHEhalf ; 
    ip  = 2*( in/36 ) ;
    in %= 36 ;
    ip += 1 + in/28 ;
    if( 0 == ip%2 ) in %= 28 ;
    ie  = 15 + ( in<2 ? 1 + in : 2 + 
             ( in<20 ? 1 + ( in - 2 )/2 : 9 +
               ( in<26 ? 1 + ( in - 20 )/3 : 3 ) ) ) ;
    dp  = ( in<1 ? 3 :
        ( in<2 ? 1 : 
          ( in<20 ? 1 + ( in - 2 )%2 : 
            ( in<26 ? 1 + ( in - 20 )%3 : 
              ( 1 + ( in - 26 )%2 ) ) ) ) ) ;
      } else { // barrel
    iz  = ( in<kHBhalf ? 1 : -1 ) ;
    in %= kHBhalf ; 
    ip = in/18 + 1 ;
    in %= 18 ;
    if ( in < 14 ) {
      dp = 1 ;
      ie = in + 1 ;
    } else {
      in %= 14 ;
      dp =  1 + in%2 ;
      ie = 15 + in/2 ;
    }
      }
    }
  } else if (topoVersion_==10) {
    if (denseid < ncells()) {
      if (denseid >= (HBSize_+HESize_+HOSize_)) {
    sd  = HcalForward ;
    in -= (HBSize_+HESize_+HOSize_);
    dp  = (in%maxDepthHF_) + 1;
    ip  = (in - dp + 1)%(maxDepthHF_*IPHI_MAX);
    ip  = (ip/maxDepthHF_) + 1;
    ie  = (in - dp + 1 - maxDepthHF_*(ip -1))/(IPHI_MAX*maxDepthHF_);
    if (ie > 12) {ie  = 54 -ie; iz = -1;}
    else         {ie += 29;     iz =  1;}
      } else if (denseid >= (HBSize_+HESize_)) {
    sd  = HcalOuter ;
    in -= (HBSize_+HESize_);
    dp  = 4;
    ip  = (in%IPHI_MAX) + 1;
    ie  = (in - ip + 1)/IPHI_MAX;
    if (ie > 14) {ie  = 30 -ie; iz = -1;}
    else         {ie += 1;      iz =  1;}
      } else if (denseid >= (HBSize_)) {
    sd  = HcalEndcap ;
    in -= (HBSize_);
    dp  = (in%maxDepthHE_)+1;
    ip  = (in - dp + 1)%(maxDepthHE_*maxPhiHE_);
    ip  = (ip/maxDepthHE_) + 1;
    ie  = (in - dp + 1 - maxDepthHE_*(ip-1))/(maxPhiHE_*maxDepthHE_);
        if (ie >= nEtaHE_) {ie = lastHERing()+nEtaHE_ - ie; iz = -1;}
        else               {ie = firstHERing() + ie;        iz =  1;}
      } else {
    sd  = HcalBarrel ;
    dp  = (in%maxDepthHB_)+1;
    ip  = (in - dp + 1)%(maxDepthHB_*IPHI_MAX);
    ip  = (ip/maxDepthHB_) + 1;
    ie  = (in - dp + 1 - maxDepthHB_*(ip-1))/(IPHI_MAX*maxDepthHB_);
        if (ie >= nEtaHB_) {ie = lastHBRing()+nEtaHB_ - ie; iz = -1;}
        else               {ie = firstHBRing() + ie;        iz =  1;}
      } 
    }
  }
  HcalDetId hid(sd, iz*int(ie), ip, dp);
#ifdef EDM_ML_DEBUG
  std::cout << "Dens2Det " << topoVersion_ << " i/p " << std::hex << denseid 
        << " : " << hid.rawId() << std::dec << " | " << hid << std::endl;
#endif
  return hid;
}

void HcalTopology::depthBinInformation	(	HcalSubdetector	subdet,
		int	etaRing,
		int	iphi,
		int	zside,
		int &	nDepthBins,
		int &	startingBin
	)		const

finds the number of depth bins and which is the number to start with

Definition at line 658 of file HcalTopology.cc.

References MessageLogger_cfi::cerr, firstHERing(), firstHETripleDepthRing(), HcalDDDRecConstants::getDepthEta16(), HcalDDDRecConstants::getMaxDepth(), HcalDDDRecConstants::getMinDepth(), HcalTopologyMode::H2HE, HcalBarrel, HcalEndcap, HcalForward, HcalOuter, hcons_, lastHBRing(), lastHERing(), maxDepthHF_, mode_, and HcalTopologyMode::SLHC.

Referenced by CaloTowerConstituentsMap::constituentsOf(), decrementDepth(), HcalTrigTowerGeometry::detIds(), doublePhiBins(), incrementDepth(), and CaloTowersCreationAlgo::setGeometry().

                                                {

  if(subdet == HcalBarrel) {
    if (mode_==HcalTopologyMode::SLHC || mode_==HcalTopologyMode::H2HE) {
      startingBin = hcons_->getMinDepth(0,etaRing,iphi,zside);
      if (etaRing==lastHBRing()) {
    nDepthBins = hcons_->getDepthEta16(1,iphi,zside)-startingBin+1;
      } else {
    nDepthBins = hcons_->getMaxDepth(0,etaRing,iphi,zside)-startingBin+1;
      }
    } else {
      if (etaRing<=14) {
    nDepthBins  = 1;
    startingBin = 1;
      } else {
    nDepthBins  = 2;
    startingBin = 1;
      }
    }
  } else if(subdet == HcalEndcap) {
    if (mode_==HcalTopologyMode::SLHC || mode_==HcalTopologyMode::H2HE) {
      if (etaRing==firstHERing()) {
    startingBin = hcons_->getDepthEta16(2,iphi,zside);
      } else {
    startingBin = hcons_->getMinDepth(1,etaRing,iphi,zside);
      }
      nDepthBins  = hcons_->getMaxDepth(1,etaRing,iphi,zside)-startingBin+1;
    } else {
      if (etaRing==firstHERing()) {
    nDepthBins  = 1;
    startingBin = 3;
      } else if (etaRing==17) {
    nDepthBins  = 1;
    startingBin = 1;
      } else if (etaRing==lastHERing()) {
    nDepthBins  = 2;
    startingBin = 1;
      } else {
    nDepthBins = (etaRing >= firstHETripleDepthRing()) ? 3 : 2;
    startingBin = 1;
      }
    }
  } else if(subdet == HcalForward) {
    nDepthBins  = maxDepthHF_;
    startingBin = 1;
  } else if(subdet == HcalOuter) {
    nDepthBins  = 1;
    startingBin = 4;
  } else {
    std::cerr << "Bad HCAL subdetector " << subdet << std::endl;
  }
}

unsigned int HcalTopology::detId2denseId ( const DetId &  id ) const

overridevirtual

return a linear packed id

Reimplemented from CaloSubdetectorTopology.

Definition at line 1152 of file HcalTopology.cc.

References gather_cfg::cout, TauDecayModes::dec, HcalDetId::depth(), detId2denseIdPreLS1(), firstHBRing(), firstHERing(), HBSize_, HcalBarrel, HcalEndcap, HcalForward, HcalOuter, HESize_, HOSize_, HcalDetId::ieta(), HcalDetId::iphi(), IPHI_MAX, lastHBRing(), lastHERing(), maxDepthHB_, maxDepthHE_, maxDepthHF_, maxPhiHE_, nEtaHB_, nEtaHE_, HcalDetId::subdet(), and topoVersion_.

Referenced by HcalGeometry::getGeometry(), HcalGeometry::getGeometryBase(), HcalGeometry::indexFor(), HcalDDDGeometry::newCellImpl(), HcalGeometry::newCellImpl(), CaloGeometryDBEP< T, U >::produceAligned(), and producerTag().

                                                              {
  unsigned int retval(0);
  if (topoVersion_==0) { // pre-LS1
    retval = detId2denseIdPreLS1(id);
  } else if (topoVersion_==10) {
    HcalDetId hid(id);
    if (hid.subdet()==HcalBarrel) {
      retval = (hid.depth()-1)+maxDepthHB_*(hid.iphi()-1);
      if (hid.ieta()>0) retval+=maxDepthHB_*IPHI_MAX*(hid.ieta()-firstHBRing());
      else              retval+=maxDepthHB_*IPHI_MAX*(hid.ieta()+lastHBRing()+nEtaHB_);
    } else if (hid.subdet()==HcalEndcap) {
      retval = HBSize_;
      retval+= (hid.depth()-1)+maxDepthHE_*(hid.iphi()-1);
      if (hid.ieta()>0) retval+=maxDepthHE_*maxPhiHE_*(hid.ieta()-firstHERing());
      else              retval+=maxDepthHE_*maxPhiHE_*(hid.ieta()+lastHERing()+nEtaHE_);
    } else if (hid.subdet()==HcalOuter) {
      retval = HBSize_+HESize_;
      if   (hid.ieta()>0) retval+=(hid.iphi()-1)+IPHI_MAX*(hid.ieta()-1);
      else                retval+=(hid.iphi()-1)+IPHI_MAX*(30+hid.ieta());
    } else if (hid.subdet()==HcalForward) { 
      retval = HBSize_+HESize_+HOSize_;
      retval+= (hid.depth()-1)+maxDepthHF_*(hid.iphi()-1);
      if (hid.ieta()>0) retval+=maxDepthHF_*IPHI_MAX*(hid.ieta()-29);
      else              retval+=maxDepthHF_*IPHI_MAX*((41+13)+hid.ieta());
    } else {
      return 0xFFFFFFFu;
    }
  }
#ifdef EDM_ML_DEBUG
  std::cout << "DetId2Dense " << topoVersion_ << " ID " << std::hex 
        << id.rawId() << std::dec << " | " << HcalDetId(id) << " : " 
        << std::hex << retval << std::dec << std::endl;
#endif
  return retval;
}

unsigned int HcalTopology::detId2denseIdCALIB

(

const DetId &

id

)

const

return a linear packed id from CALIB

Definition at line 1094 of file HcalTopology.cc.

References funct::abs(), HcalCalibDetId::calibFlavor(), HcalCalibDetId::CalibrationBox, HcalCalibDetId::cboxChannel(), HcalBarrel, HcalEndcap, HcalForward, HcalOuter, HcalCalibDetId::hcalSubdet(), HcalCalibDetId::HOCrosstalk, HcalCalibDetId::ieta(), diffTreeTool::index, HcalCalibDetId::iphi(), HcalDigiParam_cfi::zside, and HcalCalibDetId::zside().

Referenced by HcalLogicalMapGenerator::buildCALIBMap(), HcalLogicalMapGenerator::buildHOXMap(), HcalLogicalMap::checkHashIds(), HcalLogicalMap::getHcalFrontEndId(), HcalCondObjectContainerBase::indexFor(), and maxDepthHE().

                                                                   {
  HcalCalibDetId tid(id);
  int channel = tid.cboxChannel();
  int ieta = tid.ieta();
  int iphi = tid.iphi();
  int zside = tid.zside();
  unsigned int index=0xFFFFFFFFu;
      
  if (tid.calibFlavor()==HcalCalibDetId::CalibrationBox) {
        
    HcalSubdetector subDet = tid.hcalSubdet();
        
    if (subDet==HcalBarrel) {
      //std::cout<<"CALIB_HB:  ";
      //dphi = 4 (18 phi values), 3 channel types (0,1,2), eta = -1 or 1
      //total of 18*3*2=108 channels
      index = ((iphi+1)/4-1) + 18*channel + 27*(ieta+1);
    } else if (subDet==HcalEndcap) {
      //std::cout<<"CALIB_HE:  ";
      //dphi = 4 (18 phi values), 6 channel types (0,1,3,4,5,6), eta = -1 or 1
      //total of 18*6*2=216 channels
      if (channel>2) channel-=1;
      index = ((iphi+1)/4-1) + 18*channel + 54*(ieta+1) + 108;
    } else if (subDet==HcalForward) {
      //std::cout<<"CALIB_HF:  ";
      //dphi = 18 (4 phi values), 3 channel types (0,1,8), eta = -1 or 1
      if (channel==8) channel = 2;
      //total channels 4*3*2=24
      index = (iphi-1)/18 + 4*channel + 6*(ieta+1) + 324;
    } else if (subDet==HcalOuter) {
      //std::cout<<"CALIB_HO:  ";
      //there are 5 special calib crosstalk channels, one in each ring
      if (channel==7) {
    index = (ieta+2) + 420;
      //for HOM/HOP dphi = 6 (12 phi values),  2 channel types (0,1), eta = -2,-1 or 1,2
      //for HO0/YB0 dphi = 12 (6 phi values),  2 channel types (0,1), eta = 0
      } else{
    if (ieta<0) index      = ((iphi+1)/12-1) + 36*channel + 6*(ieta+2) + 348;
    else if (ieta>0) index = ((iphi+1)/12-1) + 36*channel + 6*(ieta+2) + 6 + 348;
    else index             = ((iphi+1)/6-1)  + 36*channel + 6*(ieta+2) + 348;
      }
    } else {
      edm::LogWarning("CaloTopology") << "HCAL Det Id not valid!";
      index = 0;
    }
        
  } else if (tid.calibFlavor()==HcalCalibDetId::HOCrosstalk) {
    //std::cout<<"HX:  ";
    //for YB0/HO0 phi is grouped in 6 groups of 6 with dphi=2 but the transitions are 1 or 3
    // in such a way that the %36 operation yeilds unique values for every iphi
    if (abs(ieta)==4)  index = ((iphi-1)%36) + (((zside+1)*36)/2) + 72 + 425;   //ieta = 1 YB0/HO0;
    else               index = (iphi-1) + (36*(zside+1)*2) + 425;  //ieta = 0 for HO2M/HO1M ieta=2 for HO1P/HO2P;
  }
  //std::cout << "  " << ieta << "  " << zside << "  " << iphi << "  " << depth << "  " << index << std::endl;
  return index;
}

unsigned int HcalTopology::detId2denseIdHB

(

const DetId &

id

)

const

return a linear packed id from HB

Definition at line 999 of file HcalTopology.cc.

References HcalDetId::depth(), reco::dp, firstHBRing(), HcalDetId::ieta(), HcalDetId::ietaAbs(), HcalDetId::iphi(), IPHI_MAX, kHBhalf, lastHBRing(), maxDepthHB_, nEtaHB_, topoVersion_, and HcalDetId::zside().

Referenced by HcalLogicalMapGenerator::buildHBEFTMap(), HcalLogicalMap::checkHashIds(), HcalLogicalMap::getHcalFrontEndId(), HcalCondObjectContainerBase::indexFor(), and maxDepthHE().

                                                                {
  HcalDetId hid(id);
  const int             ip (hid.iphi()    ) ;
  const int             ie (hid.ietaAbs() ) ;
  const int             dp (hid.depth()   ) ;
  const int             zn (hid.zside() < 0 ? 1 : 0 ) ;
  unsigned int  retval = 0xFFFFFFFFu;
  if (topoVersion_==0) {
    retval=( ip - 1 )*18 + dp - 1 + ie - ( ie<16 ? 1 : 0 ) + zn*kHBhalf;
  } else if (topoVersion_==10) {
    retval=(dp-1)+maxDepthHB_*(ip-1);
    if (hid.ieta()>0) retval+=maxDepthHB_*IPHI_MAX*(hid.ieta()-firstHBRing());
    else              retval+=maxDepthHB_*IPHI_MAX*(hid.ieta()+lastHBRing()+nEtaHB_);
  }
  return retval;
}

unsigned int HcalTopology::detId2denseIdHE

(

const DetId &

id

)

const

return a linear packed id from HE

Definition at line 1016 of file HcalTopology.cc.

References HcalDetId::depth(), reco::dp, firstHERing(), HcalDetId::ieta(), HcalDetId::ietaAbs(), HcalDetId::iphi(), kHEhalf, lastHERing(), maxDepthHE_, maxPhiHE_, nEtaHE_, topoVersion_, and HcalDetId::zside().

Referenced by HcalLogicalMapGenerator::buildHBEFTMap(), HcalLogicalMap::checkHashIds(), HcalLogicalMap::getHcalFrontEndId(), HcalCondObjectContainerBase::indexFor(), and maxDepthHE().

                                                                {
  HcalDetId hid(id);
  const int             ip (hid.iphi()    ) ;
  const int             ie (hid.ietaAbs() ) ;
  const int             dp (hid.depth()   ) ;
  const int             zn (hid.zside() < 0 ? 1 : 0 ) ;
  unsigned int  retval =  0xFFFFFFFFu;
  if (topoVersion_==0) {
    retval=( ip - 1 )*8 + ( ip/2 )*20 +
      ( ( ie==16 || ie==17 ) ? ie - 16 :
    ( ( ie>=18 && ie<=20 ) ? 2 + 2*( ie - 18 ) + dp - 1 :
      ( ( ie>=21 && ie<=26 ) ? 8 + 2*( ie - 21 ) + dp - 1 :
        ( ( ie>=27 && ie<=28 ) ? 20 + 3*( ie - 27 ) + dp - 1 :
          26 + 2*( ie - 29 ) + dp - 1 ) ) ) ) + zn*kHEhalf;
  } else if (topoVersion_==10) {
    retval=(dp-1)+maxDepthHE_*(ip-1);
    if (hid.ieta()>0) retval+=maxDepthHE_*maxPhiHE_*(hid.ieta()-firstHERing());
    else              retval+=maxDepthHE_*maxPhiHE_*(hid.ieta()+lastHERing()+nEtaHE_);
  }
  return retval;
}

unsigned int HcalTopology::detId2denseIdHF

(

const DetId &

id

)

const

return a linear packed id from HF

Definition at line 1054 of file HcalTopology.cc.

References HcalDetId::depth(), reco::dp, HcalDetId::ieta(), HcalDetId::ietaAbs(), HcalDetId::iphi(), IPHI_MAX, kHFhalf, maxDepthHF_, topoVersion_, and HcalDetId::zside().

Referenced by HcalLogicalMapGenerator::buildHBEFTMap(), HcalLogicalMap::checkHashIds(), HcalLogicalMap::getHcalFrontEndId(), HcalCondObjectContainerBase::indexFor(), and maxDepthHE().

                                                                {
  HcalDetId hid(id);
  const int             ip (hid.iphi()    ) ;
  const int             ie (hid.ietaAbs() ) ;
  const int             dp (hid.depth()   ) ;
  const int             zn (hid.zside() < 0 ? 1 : 0 ) ;

  unsigned int  retval = 0xFFFFFFFFu;
  if (topoVersion_==0) {
    retval = ( ( ip - 1 )/4 )*4 + ( ( ip - 1 )/2 )*22 + 
      2*( ie - 29 ) + ( dp - 1 ) + zn*kHFhalf;
  } else if (topoVersion_==10) {
    retval=dp-1+2*(ip-1);
    if (hid.ieta()>0) retval+=maxDepthHF_*IPHI_MAX*(hid.ieta()-29);
    else              retval+=maxDepthHF_*IPHI_MAX*((41+13)+hid.ieta());
  }
  return retval;
}

unsigned int HcalTopology::detId2denseIdHO

(

const DetId &

id

)

const

return a linear packed id from HO

Definition at line 1038 of file HcalTopology.cc.

References HcalDetId::ieta(), HcalDetId::ietaAbs(), HcalDetId::iphi(), IPHI_MAX, kHOhalf, topoVersion_, and HcalDetId::zside().

Referenced by HcalLogicalMapGenerator::buildHOXMap(), HcalLogicalMap::checkHashIds(), HcalLogicalMap::getHcalFrontEndId(), HcalCondObjectContainerBase::indexFor(), and maxDepthHE().

                                                                {
  HcalDetId hid(id);
  const int             ip (hid.iphi()    ) ;
  const int             ie (hid.ietaAbs() ) ;
  const int             zn (hid.zside() < 0 ? 1 : 0 ) ;

  unsigned int  retval = 0xFFFFFFFFu;
  if (topoVersion_==0) {
    retval=( ip - 1 )*15 + ( ie - 1 ) + zn*kHOhalf;
  } else if (topoVersion_==10) {
    if   (hid.ieta()>0) retval=(ip-1)+IPHI_MAX*(hid.ieta()-1);
    else                retval=(ip-1)+IPHI_MAX*(30+hid.ieta());
  }
  return retval;
}

unsigned int HcalTopology::detId2denseIdHT

(

const DetId &

id

)

const

return a linear packed id from HT

Definition at line 1073 of file HcalTopology.cc.

References HcalTrigTowerDetId::ietaAbs(), diffTreeTool::index, HcalTrigTowerDetId::iphi(), kHThalf, kHTSizePhase1, kHTSizePreLS1, HcalTrigTowerDetId::version(), HcalDigiParam_cfi::zside, and HcalTrigTowerDetId::zside().

Referenced by HcalLogicalMap::checkHashIds(), CaloTPGTranscoderULUT::getOutputLUTId(), HcalCondObjectContainerBase::indexFor(), and maxDepthHE().

                                                                {
  HcalTrigTowerDetId tid(id); 
  int zside = tid.zside();
  unsigned int ietaAbs = tid.ietaAbs();
  unsigned int iphi  = tid.iphi();
  unsigned int ivers = tid.version();

  unsigned int index;
  if (ivers  == 0) {
    if ((iphi-1)%4==0) index = (iphi-1)*32 + (ietaAbs-1) - (12*((iphi-1)/4));
    else               index = (iphi-1)*28 + (ietaAbs-1) + (4*(((iphi-1)/4)+1));
    if (zside == -1) index += kHThalf;
  } else {
    index = kHTSizePreLS1;
    if (zside == -1) index += ((kHTSizePhase1-kHTSizePreLS1)/2);
    index += (36 * (ietaAbs - 30) + ((iphi - 1)/2));
  }

  return index;
}

unsigned int HcalTopology::detId2denseIdPreLS1 ( const DetId &  id ) const

private

Definition at line 972 of file HcalTopology.cc.

References HcalDetId::depth(), reco::dp, HcalBarrel, HcalEndcap, HcalForward, HcalOuter, HcalDetId::ietaAbs(), HcalDetId::iphi(), kHBhalf, kHEhalf, kHFhalf, kHOhalf, sd, HcalDetId::subdet(), and HcalDetId::zside().

Referenced by detId2denseId(), and idBack().

                                                                     {

  HcalDetId hid(id);
  const HcalSubdetector sd (hid.subdet()  ) ;
  const int             ip (hid.iphi()    ) ;
  const int             ie (hid.ietaAbs() ) ;
  const int             dp (hid.depth()   ) ;
  const int             zn (hid.zside() < 0 ? 1 : 0 ) ;
  unsigned int  retval = ( ( sd == HcalBarrel ) ?
               ( ip - 1 )*18 + dp - 1 + ie - ( ie<16 ? 1 : 0 ) + zn*kHBhalf :
               ( ( sd == HcalEndcap ) ?
                 2*kHBhalf + ( ip - 1 )*8 + ( ip/2 )*20 +
                 ( ( ie==16 || ie==17 ) ? ie - 16 :
                   ( ( ie>=18 && ie<=20 ) ? 2 + 2*( ie - 18 ) + dp - 1 :
                 ( ( ie>=21 && ie<=26 ) ? 8 + 2*( ie - 21 ) + dp - 1 :
                   ( ( ie>=27 && ie<=28 ) ? 20 + 3*( ie - 27 ) + dp - 1 :
                     26 + 2*( ie - 29 ) + dp - 1 ) ) ) ) + zn*kHEhalf :
                 ( ( sd == HcalOuter ) ?
                   2*kHBhalf + 2*kHEhalf + ( ip - 1 )*15 + ( ie - 1 ) + zn*kHOhalf :
                   ( ( sd == HcalForward ) ?
                 2*kHBhalf + 2*kHEhalf + 2*kHOhalf + 
                 ( ( ip - 1 )/4 )*4 + ( ( ip - 1 )/2 )*22 + 
                 2*( ie - 29 ) + ( dp - 1 ) + zn*kHFhalf : 0xFFFFFFFFu ) ) ) ) ; 
  return retval;
}

int HcalTopology::doublePhiBins ( ) const

inline

Definition at line 101 of file HcalTopology.h.

References depthBinInformation(), doublePhiBins_, PVValHelper::eta, etaRing(), getDepthSegmentation(), nPhiBins(), phi, phiBin(), relativeConstraints::ring, segmentBoundaries(), setDepthSegmentation(), and HcalDigiParam_cfi::zside.

{return doublePhiBins_;}

std::vector< DetId > HcalTopology::down ( const DetId &  id ) const

overridevirtual

Get the neighbors of the given cell in down direction (inward)

Implements CaloSubdetectorTopology.

Definition at line 328 of file HcalTopology.cc.

References HcalDetId::changeForm(), decrementDepth(), triggerObjects_cff::id, and HcalDetId::oldFormat().

Referenced by producerTag().

                                                         {
  HcalDetId neighbor = id;
  std::vector<DetId> vNeighborsDetId;
  if (decrementDepth(neighbor)) {
    if (neighbor.oldFormat()) neighbor.changeForm();
    vNeighborsDetId.emplace_back(neighbor);
  }
  return  vNeighborsDetId;
}

std::vector< DetId > HcalTopology::east ( const DetId &  id ) const

overridevirtual

Flag=0 for unmerged Id's; =1 for for merged Id's; =2 for either Get the neighbors of the given cell in east direction

Implements CaloSubdetectorTopology.

Definition at line 278 of file HcalTopology.cc.

References decIEta(), and mps_fire::i.

Referenced by spr::newHCALIdEW(), and producerTag().

                                                         {
  std::vector<DetId> vNeighborsDetId;
  HcalDetId neighbors[2];
  for (int i=0;i<decIEta(HcalDetId(id),neighbors);i++) {
    if (neighbors[i].oldFormat()) neighbors[i].changeForm();
    vNeighborsDetId.emplace_back(DetId(neighbors[i].rawId()));
  }
  return vNeighborsDetId;
}

double HcalTopology::etaMax

(

HcalSubdetector

subdet

)

const

Definition at line 936 of file HcalTopology.cc.

References PVValHelper::eta, etaTable, etaTableHF, HcalBarrel, HcalEndcap, HcalForward, HcalOuter, lastHBRing_, lastHERing_, lastHORing_, and nEtaHE_.

Referenced by HcalGeometry::getCells(), HcalGeometry::getClosestCell(), and maxDepthHE().

                                                        {
  double eta(0);
  switch (subdet) {
  case(HcalBarrel):  
    if (lastHBRing_ < (int)(etaTable.size())) eta=etaTable[lastHBRing_];
    break;
  case(HcalEndcap):  
    if (lastHERing_ < (int)(etaTable.size()) && nEtaHE_ > 0) eta=etaTable[lastHERing_];
    break;
  case(HcalOuter): 
    if (lastHORing_ < (int)(etaTable.size())) eta=etaTable[lastHORing_];
    break;
  case(HcalForward): 
    if (!etaTableHF.empty()) eta=etaTableHF[etaTableHF.size()-1];
    break;
  default: eta=0;
  }
  return eta;
}

std::pair< double, double > HcalTopology::etaRange	(	HcalSubdetector	subdet,
		int	ieta
	)		const

Definition at line 955 of file HcalTopology.cc.

References etaTable, etaTableHF, firstHFRing_, HcalForward, cuy::ii, createfilelist::int, lastHERing_, HcalTopologyMode::LHC, and mode_.

Referenced by HcalHF_PETalgorithm::HFSetFlagFromPET(), HcalHFStatusBitFromRecHits::hfSetFlagFromRecHits(), HcalHF_S9S1algorithm::HFSetFlagFromS9S1(), maxDepthHE(), HcalTrigTowerGeometry::towerEtaBounds(), and HcaluLUTTPGCoder::update().

                                                                {
  int ieta = (keta > 0) ? keta : -keta;
  if (subdet == HcalForward) {
    if (ieta >= firstHFRing_) {
      unsigned int ii = (unsigned int)(ieta-firstHFRing_);
      if (ii+1 < etaTableHF.size()) 
    return std::pair<double,double>(etaTableHF[ii],etaTableHF[ii+1]);
    }
  } else {
    int ietal = (mode_==HcalTopologyMode::LHC && ieta == lastHERing_-1) ? (ieta+1) : ieta;
    if ((ietal < (int)(etaTable.size())) && (ieta > 0))
      return std::pair<double,double>(etaTable[ieta-1],etaTable[ietal]);
  }
  return std::pair<double,double>(0,0);
}

int HcalTopology::etaRing	(	HcalSubdetector	subdet,
		double	eta
	)		const

eta and phi index from eta, phi values

Definition at line 835 of file HcalTopology.cc.

References etaTable, etaTableHF, firstHBRing_, firstHFRing_, HcalForward, gen::k, and lastHERing_.

Referenced by decrementDepth(), doublePhiBins(), HcalGeometry::etaRing(), and incrementDepth().

                                                                 {
  int etaring = firstHBRing_;
  if (bc == HcalForward) {
    etaring = firstHFRing_;
    for (unsigned int k=0; k<etaTableHF.size()-1; ++k) {
      if (abseta < etaTableHF[k+1]) {
        etaring += k;
        break;
      }
    }
  } else {
    for (unsigned int k=0; k<etaTable.size()-1; ++k) {
      if (abseta < etaTable[k+1]) {
        etaring += k;
        break;
      }
    }
    if (abseta >= etaTable[etaTable.size()-1]) etaring = lastHERing_;
  }
  return etaring;
}

void HcalTopology::exclude

(

const HcalDetId &

id

)

Add a cell to exclusion list

Definition at line 261 of file HcalTopology.cc.

References exclusionList_, mps_fire::i, and triggerObjects_cff::id.

Referenced by exclude(), HcalTopologyRestrictionParser::parse(), and triggerMode().

                                              {
  std::vector<HcalDetId>::iterator i=std::lower_bound(exclusionList_.begin(),exclusionList_.end(),id);
  if (i==exclusionList_.end() || *i!=id) {
    exclusionList_.insert(i,id);
  }
}

int HcalTopology::exclude	(	HcalSubdetector	subdet,
		int	ieta1,
		int	ieta2,
		int	iphi1,
		int	iphi2,
		int	depth1 = 1,
		int	depth2 = 4
	)

Exclude an eta/phi/depth range for a given subdetector

Definition at line 338 of file HcalTopology.cc.

References particleFlowClusterECALTimeSelected_cfi::depth, exclude(), excludeHB_, excludeHE_, excludeHF_, excludeHO_, HcalBarrel, HcalEndcap, HcalForward, HcalOuter, triggerObjects_cff::id, SiStripPI::max, min(), gen::n, and validRaw().

                                                                                                                    {

  bool exed=false;
  // first, check the full detector exclusions...  (fast)
  switch (subdet) {
  case(HcalBarrel):  exed=excludeHB_; break;
  case(HcalEndcap):  exed=excludeHE_; break;
  case(HcalOuter):   exed=excludeHO_; break;
  case(HcalForward): exed=excludeHF_; break;
  default: exed=false;
  }
  if (exed) return 0; // if the whole detector is excluded...

  int ieta_l=std::min(ieta1,ieta2);
  int ieta_h=std::max(ieta1,ieta2);
  int iphi_l=std::min(iphi1,iphi2);
  int iphi_h=std::max(iphi1,iphi2);
  int depth_l=std::min(depth1,depth2);
  int depth_h=std::max(depth1,depth2);

  int n=0;
  for (int ieta=ieta_l; ieta<=ieta_h; ieta++) 
    for (int iphi=iphi_l; iphi<=iphi_h; iphi++) 
      for (int depth=depth_l; depth<=depth_h; depth++) {
    HcalDetId id(subdet,ieta,iphi,depth);
    if (validRaw(id)) { // use 'validRaw' to include check validity in "uncut" detector
      exclude(id);  
      n++;
    }
      }
  return n;
}

void HcalTopology::excludeSubdetector

(

HcalSubdetector

subdet

)

Exclude an entire subdetector

Definition at line 268 of file HcalTopology.cc.

References excludeHB_, excludeHE_, excludeHF_, excludeHO_, HcalBarrel, HcalEndcap, HcalForward, and HcalOuter.

Referenced by HcalTopologyRestrictionParser::parse(), and triggerMode().

                                                            {
  switch (subdet) {
  case(HcalBarrel):  excludeHB_=true; break;
  case(HcalEndcap):  excludeHE_=true; break;
  case(HcalOuter):   excludeHO_=true; break;
  case(HcalForward): excludeHF_=true; break;
  default: break;
  }
}

int HcalTopology::firstHBRing ( ) const

inline

Definition at line 87 of file HcalTopology.h.

References firstHBRing_.

Referenced by CaloTowerTopology::CaloTowerTopology(), CaloTowerTopology::convertCTtoHcal(), CaloTowerTopology::convertHcaltoCT(), denseId2detId(), detId2denseId(), detId2denseIdHB(), HcaluLUTTPGCoder::HcaluLUTTPGCoder(), and CaloTowerHardcodeGeometryLoader::load().

{return firstHBRing_;}

int HcalTopology::firstHEDoublePhiRing ( ) const

inline

Definition at line 96 of file HcalTopology.h.

References firstHEDoublePhiRing_.

Referenced by CaloTowerTopology::CaloTowerTopology(), decAIEta(), decIPhi(), HcalTrigTowerGeometry::detIds(), CaloTowersCreationAlgo::getThresholdAndWeight(), incAIEta(), incIPhi(), HcalHardcodeGeometryLoader::makeHECells(), nPhiBins(), HcalTrigTowerGeometry::towerIds(), and validRaw().

{return firstHEDoublePhiRing_;} 

int HcalTopology::firstHEQuadPhiRing ( ) const

inline

Definition at line 97 of file HcalTopology.h.

References firstHEQuadPhiRing_.

Referenced by CaloTowerTopology::CaloTowerTopology(), decAIEta(), decIPhi(), incAIEta(), incIPhi(), nPhiBins(), and validRaw().

{return firstHEQuadPhiRing_;} 

int HcalTopology::firstHERing ( ) const

inline

Definition at line 89 of file HcalTopology.h.

References firstHERing_.

Referenced by CaloTowerTopology::CaloTowerTopology(), CaloTowerTopology::convertCTtoHcal(), CaloTowerTopology::convertHcaltoCT(), decAIEta(), decrementDepth(), denseId2detId(), depthBinInformation(), detId2denseId(), detId2denseIdHE(), HcalTrigTowerGeometry::detIds(), HcaluLUTTPGCoder::HcaluLUTTPGCoder(), CaloTowerHardcodeGeometryLoader::load(), validDetIdPreLS1(), and validRaw().

{return firstHERing_;}

int HcalTopology::firstHETripleDepthRing ( ) const

inline

Definition at line 99 of file HcalTopology.h.

References firstHETripleDepthRing_.

Referenced by depthBinInformation(), HcalHardcodeGeometryLoader::makeHECells(), and validRaw().

{return firstHETripleDepthRing_;}

int HcalTopology::firstHFQuadPhiRing ( ) const

inline

Definition at line 98 of file HcalTopology.h.

References firstHFQuadPhiRing_.

Referenced by CaloTowerTopology::CaloTowerTopology(), decAIEta(), decIPhi(), incAIEta(), incIPhi(), nPhiBins(), validDetIdPreLS1(), and validRaw().

{return firstHFQuadPhiRing_;}

int HcalTopology::firstHFRing ( ) const

inline

Definition at line 91 of file HcalTopology.h.

References firstHFRing_.

Referenced by CaloTowerTopology::CaloTowerTopology(), CaloTowerTopology::convertCTtoHcal(), CaloTowerTopology::convertHcaltoCT(), decAIEta(), decrementDepth(), HcalTrigTowerGeometry::detIds(), HcalTrigTowerGeometry::firstHFRingInTower(), HcaluLUTTPGCoder::HcaluLUTTPGCoder(), CaloTowerHardcodeGeometryLoader::load(), CaloTowerHardcodeGeometryLoader::makeCell(), validDetIdPreLS1(), and validRaw().

{return firstHFRing_;}

int HcalTopology::firstHORing ( ) const

inline

Definition at line 93 of file HcalTopology.h.

References firstHORing_.

Referenced by CaloTowerTopology::CaloTowerTopology(), and CaloTowerTopology::convertHcaltoCT().

{return firstHORing_;}

unsigned int HcalTopology::getCALIBSize ( ) const

inline

Definition at line 137 of file HcalTopology.h.

References CALIBSize_.

Referenced by HcalCondObjectContainerBase::sizeFor().

{return CALIBSize_;}

void HcalTopology::getDepthSegmentation	(	const unsigned	ring,
		std::vector< int > &	readoutDepths,
		const bool	flag = false
	)		const

for each of the ~17 depth segments, specify which readout bin they belong to if the ring is not found, the first one with a lower ring will be returned.

Definition at line 894 of file HcalTopology.cc.

References depthSegmentation_, depthSegmentationOne_, Exception, and relativeConstraints::ring.

Referenced by doublePhiBins(), HcalDbHardcode::getLayersInDepth(), HcalHardcodeGeometryLoader::load(), HcalHardcodeCalibrations::produceRespCorrs(), segmentBoundaries(), and CaloTowersCreationAlgo::setGeometry().

                                          {
  // if it doesn't exist, return the first entry with a lower index.  So if we only
  // have entries for 1 and 17, any input from 1-16 should return the entry for ring 1
  SegmentationMap::const_iterator pos;
  if (!one) {
    pos = depthSegmentation_.upper_bound(ring);
    if (pos == depthSegmentation_.begin()) {
      throw cms::Exception("HcalTopology") << "No depth segmentation found for ring" << ring;
    }
  } else {
    pos = depthSegmentationOne_.upper_bound(ring);
    if (pos == depthSegmentationOne_.begin()) {
      throw cms::Exception("HcalTopology") << "No depth segmentation found for ring" << ring;
    }
  }
  --pos;
  // pos now refers to the last element with key <= ring.
  readoutDepths = pos->second;
}

unsigned int HcalTopology::getHBSize ( ) const

inline

Definition at line 132 of file HcalTopology.h.

References HBSize_.

Referenced by HcalGeometry::init(), and HcalCondObjectContainerBase::sizeFor().

{return HBSize_;}

unsigned int HcalTopology::getHESize ( ) const

inline

Definition at line 133 of file HcalTopology.h.

References HESize_.

Referenced by HcalGeometry::init(), and HcalCondObjectContainerBase::sizeFor().

{return HESize_;}

unsigned int HcalTopology::getHFSize ( ) const

inline

Definition at line 135 of file HcalTopology.h.

References HFSize_.

Referenced by HcalGeometry::init(), HcalHardcodeGeometryLoader::load(), HcalFlexiHardcodeGeometryLoader::load(), CaloGeometryDBEP< T, U >::produceAligned(), and HcalCondObjectContainerBase::sizeFor().

{return HFSize_;}

unsigned int HcalTopology::getHOSize ( ) const

inline

Definition at line 134 of file HcalTopology.h.

References HOSize_.

Referenced by HcalGeometry::init(), and HcalCondObjectContainerBase::sizeFor().

{return HOSize_;}

unsigned int HcalTopology::getHTSize ( ) const

inline

Definition at line 136 of file HcalTopology.h.

References HTSize_.

Referenced by CaloTPGTranscoderULUT::setup(), and HcalCondObjectContainerBase::sizeFor().

{return HTSize_;}

bool HcalTopology::getMergePositionFlag ( ) const

inline

Definition at line 164 of file HcalTopology.h.

References mergePosition_.

{return mergePosition_;}

unsigned int HcalTopology::getNumberOfShapes ( ) const

inline

Definition at line 158 of file HcalTopology.h.

References numberOfShapes_.

Referenced by HcalGeometry::numberOfShapes(), and CaloGeometryDBEP< T, U >::produceAligned().

{ return numberOfShapes_; }

int HcalTopology::getPhiZOne ( std::vector< std::pair< int, int > > &  phiz ) const

inline

Definition at line 130 of file HcalTopology.h.

References HcalDDDRecConstants::getPhiZOne(), and hcons_.

Referenced by CaloTowersCreationAlgo::setGeometry().

{return hcons_->getPhiZOne(phiz);}

HcalDetId HcalTopology::idBack ( const HcalDetId &  id ) const

inline

Definition at line 171 of file HcalTopology.h.

References decAIEta(), detId2denseIdPreLS1(), hcons_, HcalDDDRecConstants::idBack(), incAIEta(), isExcluded(), validDetIdPreLS1(), and validRaw().

Referenced by CaloTowersCreationAlgo::hadShwPosFromCells(), and CaloTowersCreationAlgo::hadShwrPos().

{return hcons_->idBack(id);}

HcalDetId HcalTopology::idFront ( const HcalDetId &  id ) const

inline

Definition at line 170 of file HcalTopology.h.

References hcons_, and HcalDDDRecConstants::idFront().

Referenced by CaloTowersCreationAlgo::assignHitHcal(), HcalGeometry::getGeometry(), HcalGeometry::getPosition(), CaloTowersCreationAlgo::hadShwPosFromCells(), CaloTowersCreationAlgo::hadShwrPos(), CaloTowersCreationAlgo::hcalChanStatusForCaloTower(), HcalRecHitsAnalyzer::hcalSevLvl(), PFHcalRecHitCreator< Digi, Geometry, Layer, Detector >::importRecHits(), HcalHitSelection::skim(), and PFRecHitQTestHCALChannel::test().

{return hcons_->idFront(id);}

int HcalTopology::incAIEta ( const HcalDetId &  id, HcalDetId  neighbors[2]  ) const

private

Get the neighbors of the given cell with higher absolute ieta

Increasing in |ieta|, there is always at most one neighbor

Definition at line 595 of file HcalTopology.cc.

References particleFlowClusterECALTimeSelected_cfi::depth, etaHE2HF_, firstHEDoublePhiRing(), firstHEQuadPhiRing(), firstHFQuadPhiRing(), HcalEndcap, HcalForward, lastHBRing(), lastHERing(), gen::n, valid(), and HcalDigiParam_cfi::zside.

Referenced by decIEta(), idBack(), and incIEta().

                                                                            {
  int n=1;
  int aieta=id.ietaAbs();

  if (aieta==firstHEDoublePhiRing()-1 && (id.iphi()%2)==0) 
    neighbors[0]=HcalDetId(id.subdet(),(aieta+1)*id.zside(),id.iphi()-1,id.depth());
  else if (aieta==firstHFQuadPhiRing()-1 && ((id.iphi()+1)%4)!=0) 
    neighbors[0]=HcalDetId(id.subdet(),(aieta+1)*id.zside(),((id.iphi()==1)?(71):(id.iphi()-2)),id.depth());
  else if (aieta==firstHEQuadPhiRing()-1 && ((id.iphi()+1)%4)!=0) 
    neighbors[0]=HcalDetId(id.subdet(),(aieta+1)*id.zside(),((id.iphi()==1)?(71):(id.iphi()-2)),id.depth());
  else if (aieta==lastHBRing()) 
    neighbors[0]=HcalDetId(HcalEndcap,(aieta+1)*id.zside(),id.iphi(),1);
  else if (aieta==lastHERing()) 
    neighbors[0]=HcalDetId(HcalForward,etaHE2HF_*id.zside(),id.iphi(),1);
  else
    neighbors[0]=HcalDetId(id.subdet(),(aieta+1)*id.zside(),id.iphi(),id.depth());
    
  if (!valid(neighbors[0])) n=0;
  return n;
}

int HcalTopology::incIEta	(	const HcalDetId &	id,
		HcalDetId	neighbors[2]
	)		const

Get the neighbors of the given cell with higher (signed) ieta

Definition at line 584 of file HcalTopology.cc.

References decAIEta(), incAIEta(), and HcalDigiParam_cfi::zside.

Referenced by producerTag(), and west().

                                                                           {
  if (id.zside()==1) return incAIEta(id,neighbors);
  else return decAIEta(id,neighbors);
}

bool HcalTopology::incIPhi	(	const HcalDetId &	id,
		HcalDetId &	neighbor
	)		const

Get the neighbor (if present) of the given cell with higher iphi

Definition at line 509 of file HcalTopology.cc.

References particleFlowClusterECALTimeSelected_cfi::depth, firstHEDoublePhiRing(), firstHEQuadPhiRing(), firstHFQuadPhiRing(), HcalBarrel, HcalEndcap, HcalForward, HcalOuter, IPHI_MAX, maxPhiHE_, convertSQLiteXML::ok, valid(), and validRaw().

Referenced by north(), and producerTag().

                                                                         {
  bool ok=valid(id);
  if (ok) {
    switch (id.subdet()) {
    case (HcalBarrel):
    case (HcalOuter):
      if (id.iphi()==IPHI_MAX) neighbor=HcalDetId(id.subdet(),id.ieta(),1,id.depth()); 
      else neighbor=HcalDetId(id.subdet(),id.ieta(),id.iphi()+1,id.depth()); 
      break;
    case (HcalEndcap):
      if (id.ietaAbs()>=firstHEQuadPhiRing()) {
        if (id.iphi()==IPHI_MAX-1) neighbor=HcalDetId(id.subdet(),id.ieta(),3,id.depth()); 
        else                       neighbor=HcalDetId(id.subdet(),id.ieta(),id.iphi()+4,id.depth()); 
      } else if (id.ietaAbs()>=firstHEDoublePhiRing()) {
    if (id.iphi()==IPHI_MAX-1) neighbor=HcalDetId(id.subdet(),id.ieta(),1,id.depth()); 
    else neighbor=HcalDetId(id.subdet(),id.ieta(),id.iphi()+2,id.depth()); 
      } else {
    if (id.iphi()==maxPhiHE_) neighbor=HcalDetId(id.subdet(),id.ieta(),1,id.depth()); 
    else neighbor=HcalDetId(id.subdet(),id.ieta(),id.iphi()+1,id.depth()); 
      } 
      break;
    case (HcalForward):
      if (id.ietaAbs()>=firstHFQuadPhiRing()) {
    if (id.iphi()==IPHI_MAX-1) neighbor=HcalDetId(id.subdet(),id.ieta(),3,id.depth()); 
    else neighbor=HcalDetId(id.subdet(),id.ieta(),id.iphi()+4,id.depth()); 
      } else {
    if (id.iphi()==IPHI_MAX-1) neighbor=HcalDetId(id.subdet(),id.ieta(),1,id.depth()); 
    else neighbor=HcalDetId(id.subdet(),id.ieta(),id.iphi()+2,id.depth()); 
      }
      if (!validRaw(neighbor)) ok = false;
      break;
    default: ok=false;
    }
  } 
  return ok;
}

bool HcalTopology::incrementDepth

(

HcalDetId &

id

)

const

Get the detector behind this one

Definition at line 713 of file HcalTopology.cc.

References particleFlowClusterECALTimeSelected_cfi::depth, HcalDetId::depth(), depthBinInformation(), etaRing(), HcalDDDRecConstants::getDepthEta16(), HcalTopologyMode::H2HE, HcalBarrel, HcalEndcap, HcalForward, HcalOuter, hcons_, HcalDetId::ieta(), HcalDetId::ietaAbs(), HcalDetId::iphi(), lastHBRing(), lastHERing(), lastHORing(), mode_, HcalTopologyMode::SLHC, HcalDetId::subdet(), validRaw(), HcalDigiParam_cfi::zside, and HcalDetId::zside().

Referenced by HcalGeometry::getClosestCell(), producerTag(), and up().

                                                         {

  HcalSubdetector subdet = detId.subdet();
  int ieta    = detId.ieta();
  int etaRing = detId.ietaAbs();
  int depth   = detId.depth();
  int iphi    = detId.iphi();
  int zside   = detId.zside();
  int nDepthBins, startingBin;
  depthBinInformation(subdet, etaRing, iphi, zside, nDepthBins, startingBin);

  // see if the new depth bin exists
  ++depth;
  if (depth >= (startingBin+nDepthBins)) {
    // handle on a case-by-case basis
    if (subdet == HcalBarrel && etaRing < lastHORing())  {
      // HO
      subdet = HcalOuter;
      depth  = 4;
    } else if (subdet == HcalBarrel && etaRing == lastHBRing()) {
      // overlap
      subdet = HcalEndcap;
      if (mode_==HcalTopologyMode::SLHC || mode_==HcalTopologyMode::H2HE) 
    depth = hcons_->getDepthEta16(2,iphi,zside);
    } else if (subdet == HcalEndcap && etaRing ==  lastHERing()-1 &&
               mode_ != HcalTopologyMode::SLHC) {
      // guard ring HF29 is behind HE 28
      subdet = HcalForward;
      (ieta > 0) ? ++ieta : --ieta;
      depth = 1;
    } else if (subdet == HcalEndcap && etaRing ==  lastHERing() &&
           mode_ != HcalTopologyMode::SLHC) {
      // split cells go to bigger granularity.  Ring 29 -> 28
      (ieta > 0) ? --ieta : ++ieta;
    } else {
      // no more chances
      detId = HcalDetId();
      return false;
    }
  }
  detId = HcalDetId(subdet, ieta, iphi, depth);
  return validRaw(detId);
}

bool HcalTopology::isBH ( ) const

inline

Definition at line 159 of file HcalTopology.h.

References hcons_, and HcalDDDRecConstants::isBH().

Referenced by CaloTowerTopology::CaloTowerTopology().

{ return ((hcons_ == nullptr) ? false : hcons_->isBH()); }

bool HcalTopology::isExcluded ( const HcalDetId &  id ) const

private

Definition at line 243 of file HcalTopology.cc.

References excludeHB_, excludeHE_, excludeHF_, excludeHO_, exclusionList_, HcalBarrel, HcalEndcap, HcalForward, HcalOuter, mps_fire::i, and triggerObjects_cff::id.

Referenced by idBack(), and validHcal().

                                                       {
  bool exed=false;
  // first, check the full detector exclusions...  (fast)
  switch (id.subdet()) {
  case(HcalBarrel):  exed=excludeHB_; break;
  case(HcalEndcap):  exed=excludeHE_; break;
  case(HcalOuter):   exed=excludeHO_; break;
  case(HcalForward): exed=excludeHF_; break;
  default: exed=false;
  }
  // next, check the list (slower)
  if (!exed && !exclusionList_.empty()) {
    std::vector<HcalDetId>::const_iterator i=std::lower_bound(exclusionList_.begin(),exclusionList_.end(),id);
    if (i!=exclusionList_.end() && *i==id) exed=true;
  }
  return exed;
}

int HcalTopology::lastHBRing ( ) const

inline

Definition at line 88 of file HcalTopology.h.

References lastHBRing_.

Referenced by CaloTowerTopology::CaloTowerTopology(), CaloTowerTopology::convertHcaltoCT(), denseId2detId(), depthBinInformation(), detId2denseId(), detId2denseIdHB(), HcalTrigTowerGeometry::detIds(), CaloTPGTranscoderULUT::getOutputLUTSize(), reco::hcalSubdetector(), HcaluLUTTPGCoder::HcaluLUTTPGCoder(), incAIEta(), incrementDepth(), CaloTowerHardcodeGeometryLoader::load(), and validRaw().

{return lastHBRing_;}

int HcalTopology::lastHERing ( ) const

inline

Definition at line 90 of file HcalTopology.h.

References lastHERing_.

Referenced by CaloTowersCreationAlgo::assignHitHcal(), CaloTowerTopology::CaloTowerTopology(), CaloTowerTopology::convertHcaltoCT(), decrementDepth(), denseId2detId(), depthBinInformation(), detId2denseId(), detId2denseIdHE(), HcalTrigTowerGeometry::detIds(), CaloTPGTranscoderULUT::getOutputLUTSize(), reco::hcalSubdetector(), HcaluLUTTPGCoder::HcaluLUTTPGCoder(), incAIEta(), incrementDepth(), CaloTowerHardcodeGeometryLoader::load(), HcalHardcodeGeometryLoader::load(), CaloTowersCreationAlgo::makeHcalDropChMap(), HcalHardcodeGeometryLoader::makeHECells(), HcalHardcodeCalibrations::produceRespCorrs(), CaloTowersCreationAlgo::setGeometry(), HcalTrigTowerGeometry::towerIds(), and validRaw().

{return lastHERing_;}

int HcalTopology::lastHFRing ( ) const

inline

Definition at line 92 of file HcalTopology.h.

References lastHFRing_.

Referenced by CaloTowerTopology::CaloTowerTopology(), CaloTowerTopology::convertHcaltoCT(), reco::hcalSubdetector(), HcaluLUTTPGCoder::HcaluLUTTPGCoder(), CaloTowerHardcodeGeometryLoader::load(), validDetIdPreLS1(), and validRaw().

{return lastHFRing_;}

int HcalTopology::lastHORing ( ) const

inline

Definition at line 94 of file HcalTopology.h.

References lastHORing_.

Referenced by CaloTowerTopology::CaloTowerTopology(), CaloTowerTopology::convertHcaltoCT(), HcalTrigTowerGeometry::detIds(), incrementDepth(), and validRaw().

{return lastHORing_;}

int HcalTopology::maxDepth

(

HcalSubdetector

subdet

)

const

Definition at line 828 of file HcalTopology.cc.

References HcalBarrel, HcalEndcap, HcalForward, maxDepthHB_, maxDepthHE_, and maxDepthHF_.

Referenced by HcalGeometry::getCells(), HcaluLUTTPGCoder::HcaluLUTTPGCoder(), and maxDepthHE().

                                                   {
  if      (bc == HcalBarrel)  return maxDepthHB_;
  else if (bc == HcalEndcap)  return maxDepthHE_;
  else if (bc == HcalForward) return maxDepthHF_;
  else                        return 4;
}

int HcalTopology::maxDepthHB ( ) const

inline

Definition at line 139 of file HcalTopology.h.

References maxDepthHB_.

{ return maxDepthHB_;}

int HcalTopology::maxDepthHE ( ) const

inline

Definition at line 140 of file HcalTopology.h.

References detId2denseIdCALIB(), detId2denseIdHB(), detId2denseIdHE(), detId2denseIdHF(), detId2denseIdHO(), detId2denseIdHT(), etaMax(), etaRange(), maxDepth(), and maxDepthHE_.

{ return maxDepthHE_;}

HcalDetId HcalTopology::mergedDepthDetId ( const HcalDetId &  id ) const

inline

Definition at line 163 of file HcalTopology.h.

References hcons_, and HcalDDDRecConstants::mergedDepthDetId().

Referenced by CaloTowerConstituentsMap::constituentsOf(), HcalGeometry::correctId(), CaloTowersCreationAlgo::makeHcalDropChMap(), and SimplePlan1RechitCombiner::mapRechit().

{return hcons_->mergedDepthDetId(id); }

HcalTopologyMode::Mode HcalTopology::mode ( void  ) const

inline

Definition at line 31 of file HcalTopology.h.

References mode_.

Referenced by HcalHardcodeGeometryLoader::load(), HcalFlexiHardcodeGeometryLoader::load(), HcalHardcodeGeometryLoader::makeHBCells(), and HcalHardcodeGeometryLoader::makeHECells().

{return mode_;}

unsigned int HcalTopology::ncells ( ) const

overridevirtual

return a count of valid cells (for dense indexing use)

Reimplemented from CaloSubdetectorTopology.

Definition at line 1296 of file HcalTopology.cc.

References HBSize_, HESize_, HFSize_, and HOSize_.

Referenced by denseId2detId(), HcalGeometry::getSummary(), HcalHardcodeGeometryLoader::load(), HcalFlexiHardcodeGeometryLoader::load(), CaloGeometryDBEP< T, U >::produceAligned(), producerTag(), and HcalGeometry::sizeForDenseIndex().

                                        {
  return HBSize_+HESize_+HOSize_+HFSize_;
}

std::vector< DetId > HcalTopology::north ( const DetId &  id ) const

overridevirtual

Get the neighbors of the given cell in north direction

Implements CaloSubdetectorTopology.

Definition at line 298 of file HcalTopology.cc.

References HcalDetId::changeForm(), incIPhi(), HcalDetId::oldFormat(), and DetId::rawId().

Referenced by spr::newHCALIdNS(), and producerTag().

                                                          {
  std::vector<DetId> vNeighborsDetId;
  HcalDetId neighbor;
  if (incIPhi(HcalDetId(id),neighbor)) {
    if (neighbor.oldFormat()) neighbor.changeForm();
    vNeighborsDetId.emplace_back(DetId(neighbor.rawId()));
  }
  return  vNeighborsDetId;
}

int HcalTopology::nPhiBins

(

int

etaRing

)

const

how many phi segments in this ring

Definition at line 804 of file HcalTopology.cc.

References doublePhiBins_, dPhiTable, firstHBRing_, firstHEDoublePhiRing(), firstHEQuadPhiRing(), firstHFQuadPhiRing(), HcalDDDRecConstants::getEtaRange(), hcons_, M_PI, and singlePhiBins_.

Referenced by doublePhiBins(), and CaloTowerHardcodeGeometryLoader::makeCell().

                                            {
  int lastPhiBin=singlePhiBins_;
  if      (etaRing>= firstHFQuadPhiRing())   lastPhiBin=doublePhiBins_/2;
  else if (etaRing>= firstHEQuadPhiRing())   lastPhiBin=doublePhiBins_/2;
  else if (etaRing>= firstHEDoublePhiRing()) lastPhiBin=doublePhiBins_;
  if (hcons_) {
    if (etaRing>=hcons_->getEtaRange(1).first && 
    etaRing<=hcons_->getEtaRange(1).second)
      lastPhiBin = (int)((2*M_PI+0.001)/dPhiTable[etaRing-firstHBRing_]);
  }
  return lastPhiBin;
}

int HcalTopology::nPhiBins	(	HcalSubdetector	subdet,
		int	etaRing
	)		const

Definition at line 817 of file HcalTopology.cc.

References dPhiTable, dPhiTableHF, firstHBRing_, firstHFRing_, HcalForward, createfilelist::int, and M_PI.

                                                                {
  static const double twopi = M_PI+M_PI;
  int lastPhiBin;
  if (bc == HcalForward) {
    lastPhiBin = (int)((twopi+0.001)/dPhiTableHF[etaRing-firstHFRing_]);
  } else {
    lastPhiBin = (int)((twopi+0.001)/dPhiTable[etaRing-firstHBRing_]);
  }
  return lastPhiBin;
}

int HcalTopology::phiBin	(	HcalSubdetector	subdet,
		int	etaRing,
		double	phi
	)		const

Definition at line 857 of file HcalTopology.cc.

References dPhiTable, dPhiTableHF, firstHBRing_, firstHFRing_, HcalBarrel, HcalEndcap, HcalForward, diffTreeTool::index, M_PI, phioff, csvLumiCalc::unit, unitPhi, and unitPhiHF.

Referenced by doublePhiBins(), and HcalGeometry::phiBin().

                                                                          {
  static const double twopi = M_PI+M_PI;
  //put phi in correct range (0->2pi)
  int index(0);
  if (bc == HcalBarrel) {
    index = (etaring-firstHBRing_);
    phi  -= phioff[0];
  } else if (bc == HcalEndcap) {
    index = (etaring-firstHBRing_);
    phi  -= phioff[1];
  } else if (bc == HcalForward) {
    index = (etaring-firstHFRing_);
    if (index < (int)(dPhiTableHF.size())) {
      if (unitPhiHF[index] > 2) phi -= phioff[4];
      else                      phi -= phioff[2];
    }
  }
  if (phi<0.0)   phi += twopi;
  if (phi>twopi) phi -= twopi;
  int phibin(1), unit(1);
  if (bc == HcalForward) {
    if (index < (int)(dPhiTableHF.size())) {
      unit    = unitPhiHF[index];
      phibin  = static_cast<int>(phi/dPhiTableHF[index])+1;
    }
  } else {
    if (index < (int)(dPhiTable.size())) {
      phibin  = static_cast<int>(phi/dPhiTable[index])+1;
      unit    = unitPhi[index];
    }
  }
  int iphi(phibin);
  if      (unit == 2) iphi = (phibin-1)*2+1;
  else if (unit == 4) iphi = (phibin-1)*4+3;
  return iphi;
}

static std::string HcalTopology::producerTag ( )

inlinestatic

Definition at line 40 of file HcalTopology.h.

References decIEta(), decIPhi(), decrementDepth(), denseId2detId(), particleFlowClusterECALTimeSelected_cfi::depth, detId2denseId(), down(), east(), RemoveAddSevLevel::flag, incIEta(), incIPhi(), incrementDepth(), ncells(), north(), south(), topoVersion(), up(), valid(), validDetId(), validHcal(), validHT(), and west().

{ return "HCAL" ; }

std::pair< int, int > HcalTopology::segmentBoundaries	(	const unsigned	ring,
		const unsigned	depth,
		const bool	flag = false
	)		const

returns the boundaries of the depth segmentation, so that the first result is the first segment, and the second result is the first one of the next segment. Used for calculating physical bounds.

Definition at line 926 of file HcalTopology.cc.

References particleFlowClusterECALTimeSelected_cfi::depth, and getDepthSegmentation().

Referenced by doublePhiBins().

                                                  {
  std::vector<int> readoutDepths;
  getDepthSegmentation(ring, readoutDepths, one);
  int d1 = std::lower_bound(readoutDepths.begin(), readoutDepths.end(), depth) - readoutDepths.begin();
  int d2 = std::upper_bound(readoutDepths.begin(), readoutDepths.end(), depth) - readoutDepths.begin();
  return std::pair<int, int>(d1, d2);
}

void HcalTopology::setDepthSegmentation	(	const unsigned	ring,
		const std::vector< int > &	readoutDepths,
		const bool	flag
	)

Definition at line 916 of file HcalTopology.cc.

References depthSegmentation_, depthSegmentationOne_, and relativeConstraints::ring.

Referenced by doublePhiBins(), and HcalTopology().

                                    {
  if (one) {
    depthSegmentationOne_[ring] = readoutDepths;
  } else {
    depthSegmentation_[ring] = readoutDepths;
  }
}

int HcalTopology::singlePhiBins ( ) const

inline

Definition at line 100 of file HcalTopology.h.

References singlePhiBins_.

{return singlePhiBins_;}

std::vector< DetId > HcalTopology::south ( const DetId &  id ) const

overridevirtual

Get the neighbors of the given cell in south direction

Implements CaloSubdetectorTopology.

Definition at line 308 of file HcalTopology.cc.

References HcalDetId::changeForm(), decIPhi(), HcalDetId::oldFormat(), and DetId::rawId().

Referenced by spr::newHCALIdNS(), and producerTag().

                                                          {
  std::vector<DetId> vNeighborsDetId;
  HcalDetId neighbor;
  if (decIPhi(HcalDetId(id),neighbor)) {
    if (neighbor.oldFormat()) neighbor.changeForm();
    vNeighborsDetId.emplace_back(DetId(neighbor.rawId()));
  }
  return  vNeighborsDetId;
}

int HcalTopology::topoVersion ( ) const

overridevirtual

return a version which identifies the given topology

Reimplemented from CaloSubdetectorTopology.

Definition at line 1300 of file HcalTopology.cc.

References topoVersion_.

Referenced by HcalCondObjectContainerBase::HcalCondObjectContainerBase(), producerTag(), and HcalCondObjectContainerBase::setTopo().

                                    {
  return topoVersion_;
}

HcalTopologyMode::TriggerMode HcalTopology::triggerMode ( ) const

inline

Definition at line 32 of file HcalTopology.h.

References exclude(), excludeSubdetector(), and triggerMode_.

Referenced by CaloTPGTranscoderULUT::getOutputLUTSize(), HcalTrigTowerGeometry::HcalTrigTowerGeometry(), and HcaluLUTTPGCoder::update().

{ return triggerMode_; }

void HcalTopology::unmergeDepthDetId ( const HcalDetId &  id, std::vector< HcalDetId > &  ids  ) const

inline

Definition at line 165 of file HcalTopology.h.

References hcons_, and HcalDDDRecConstants::unmergeDepthDetId().

Referenced by HcalGeometry::getBackPosition(), and HcalGeometry::getCorners().

                                               {
    hcons_->unmergeDepthDetId(id, ids);
  }

std::vector< DetId > HcalTopology::up ( const DetId &  id ) const

overridevirtual

Get the neighbors of the given cell in up direction (outward)

Implements CaloSubdetectorTopology.

Definition at line 318 of file HcalTopology.cc.

References HcalDetId::changeForm(), triggerObjects_cff::id, incrementDepth(), and HcalDetId::oldFormat().

Referenced by spr::matrixHCALIdsDepth(), and producerTag().

                                                       {
  HcalDetId neighbor = id;
  std::vector<DetId> vNeighborsDetId;
  if (incrementDepth(neighbor)) {
    if (neighbor.oldFormat()) neighbor.changeForm();
    vNeighborsDetId.emplace_back(neighbor);
  }
  return  vNeighborsDetId;
}

bool HcalTopology::valid ( const DetId &  id ) const

overridevirtual

Is this a valid cell id?

Reimplemented from CaloSubdetectorTopology.

Definition at line 190 of file HcalTopology.cc.

References DetId::Hcal, and validHcal().

Referenced by WriteL1TriggerObjectsTxt::analyze(), HcalLutAnalyzer::analyze(), decAIEta(), decIPhi(), HcalGeometry::getCells(), incAIEta(), incIPhi(), CaloMiscalibMapHcal::prefillMap(), producerTag(), CaloTPGTranscoderULUT::setup(), HcaluLUTTPGCoder::update(), HcaluLUTTPGCoder::updateXML(), and HGCalTriggerGeometryHexLayerBasedImp1::validCellId().

                                              {
  assert(id.det()==DetId::Hcal);
  return validHcal(id);
}

bool HcalTopology::validDetId	(	HcalSubdetector	subdet,
		int	ieta,
		int	iphi,
		int	depth
	)		const

Definition at line 204 of file HcalTopology.cc.

References triggerObjects_cff::id, and validHcal().

Referenced by producerTag().

                                               {
  HcalDetId id(subdet,ieta,iphi,depth);
  return validHcal(id);
}

bool HcalTopology::validDetIdPreLS1 ( const HcalDetId &  id ) const

private

Is this a valid cell id, ignoring the exclusion list

Basic rules used to derive this code:

HB has 72 towers in iphi. Ieta 1-14 have depth=1, Ieta 15-16 have depth=1 or 2.

HE ieta=16-20 have 72 towers in iphi ieta=21-29 have 36 towers in iphi ieta=16 is depth 3 only ieta=17 is depth 1 only ieta=18-26 & 29 have depth 1 and 2 ieta=27-28 has depth 1-3

HF ieta=29-39 have 36 in iphi ieta=40-41 have 18 in iphi (71,3,7,11...) all have two depths

HO has 15 towers in ieta and 72 in iphi and depth = 4 (one value)

At H2:

HE ieta 17 is two depths HE ieta 22- have 36 towers in iphi (starts one higher) HE ieta 24- has three depths

Definition at line 397 of file HcalTopology.cc.

References particleFlowClusterECALTimeSelected_cfi::depth, reco::dp, firstHERing(), firstHFQuadPhiRing(), firstHFRing(), HcalBarrel, HcalEndcap, HcalForward, HcalOuter, IPHI_MAX, lastHFRing(), and sd.

Referenced by idBack().

                                                             {
  const HcalSubdetector sd (id.subdet());
  const int             ie (id.ietaAbs());
  const int             ip (id.iphi());
  const int             dp (id.depth());

  return ( ( ip >=  1         ) &&
       ( ip <= IPHI_MAX   ) &&
       ( dp >=  1         ) &&
       ( ie >=  1         ) &&
       ( ( ( sd == HcalBarrel ) &&
           ( ( ( ie <= 14         ) &&
           ( dp ==  1         )    ) ||
         ( ( ( ie == 15 ) || ( ie == 16 ) ) && 
           ( dp <= 2          )                ) ) ) ||
         (  ( sd == HcalEndcap ) &&
        ( ( ( ie == firstHERing() ) &&
            ( dp ==  3 )          ) ||
          ( ( ie == 17 ) &&
            ( dp ==  1 )          ) ||
          ( ( ie >= 18 ) &&
            ( ie <= 20 ) &&
            ( dp <=  2 )          ) ||
          ( ( ie >= 21 ) &&
            ( ie <= 26 ) &&
            ( dp <=  2 ) &&
            ( ip%2 == 1 )         ) ||
          ( ( ie >= 27 ) &&
            ( ie <= 28 ) &&
            ( dp <=  3 ) &&
            ( ip%2 == 1 )         ) ||
          ( ( ie == 29 ) &&
            ( dp <=  2 ) &&
            ( ip%2 == 1 )         )          )      ) ||
         (  ( sd == HcalOuter ) &&
        ( ie <= 15 ) &&
        ( dp ==  4 )           ) ||
         (  ( sd == HcalForward ) &&
        ( dp <=  2 )          &&
        ( ( ( ie >= firstHFRing() ) &&
            ( ie <  firstHFQuadPhiRing() ) &&
            ( ip%2 == 1 )    ) ||
          ( ( ie >= firstHFQuadPhiRing() ) &&
            ( ie <= lastHFRing() ) &&
            ( ip%4 == 3 )         )  ) ) ) ) ;
}

bool HcalTopology::validHcal

(

const HcalDetId &

id

)

const

Is this a valid cell id?

Definition at line 195 of file HcalTopology.cc.

References isExcluded(), convertSQLiteXML::ok, and validRaw().

Referenced by HcalDigitizer::accumulateCaloHits(), HcalHBHEMuonAnalyzer::analyze(), CaloTowersCreationAlgo::hadShwrPos(), producerTag(), valid(), validDetId(), and validHcal().

                                                      {
  // check the raw rules
  bool ok=validRaw(id);

  ok=ok && !isExcluded(id);

  return ok;
}

bool HcalTopology::validHcal	(	const HcalDetId &	id,
		const unsigned int	flag
	)		const

Is this a valid cell in context of Plan1

Definition at line 230 of file HcalTopology.cc.

References hcons_, HcalDDDRecConstants::isPlan1MergedId(), HcalDDDRecConstants::isPlan1ToBeMergedId(), convertSQLiteXML::ok, and validHcal().

                                                                               {
  // check the raw rules
  bool ok = validHcal(id);
  if (flag == 0) { // This is all what is needed
  } else if (flag == 1) { // See if it is in the to be merged list and merged list
    if (hcons_->isPlan1MergedId(id))          ok = true;
    else if (hcons_->isPlan1ToBeMergedId(id)) ok = false;
  } else if (!ok) {
    ok = hcons_->isPlan1MergedId(id);
  }
  return ok;
}

bool HcalTopology::validHT

(

const HcalTrigTowerDetId &

id

)

const

Definition at line 210 of file HcalTopology.cc.

References particleFlowClusterECALTimeSelected_cfi::depth, IPHI_MAX, triggerMode_, HcalTopologyMode::TriggerMode_2009, HcalTopologyMode::TriggerMode_2017, HcalTopologyMode::TriggerMode_2018legacy, and jets_cff::version.

Referenced by HcalLutAnalyzer::analyze(), CaloTPGTranscoderULUT::HTvalid(), CaloTPGTranscoderULUT::loadHCALCompress(), producerTag(), and validRaw().

                                                             {

  if (id.iphi()<1 || id.iphi()>IPHI_MAX || id.ieta()==0)  return false;
  if (id.depth() != 0)                              return false;
  if (id.version()==0) {
    if (id.ietaAbs() > 28) {
       if (triggerMode_ >= HcalTopologyMode::TriggerMode_2017) return false;
       if (triggerMode_ == HcalTopologyMode::TriggerMode_2018legacy) return false;
       if ((id.iphi() % 4) != 1)                               return false;
       if (id.ietaAbs() > 32)                                  return false;
    }
  } else {
    if (triggerMode_==HcalTopologyMode::TriggerMode_2009) return false;
    if (id.ietaAbs()<30 || id.ietaAbs()>41)         return false;
    if (id.ietaAbs()>29 && ((id.iphi()%2)==0))      return false;
    if (id.ietaAbs()>39 && ((id.iphi()%4)!=3))      return false;
  }
  return true;
}

bool HcalTopology::validRaw ( const HcalDetId &  id ) const

private

Is this a valid cell id?

Definition at line 445 of file HcalTopology.cc.

References particleFlowClusterECALTimeSelected_cfi::depth, etaBinsHE_, firstHEDoublePhiRing(), firstHEQuadPhiRing(), firstHERing(), firstHETripleDepthRing(), firstHFQuadPhiRing(), firstHFRing(), HcalDDDRecConstants::getDepthEta16(), HcalDDDRecConstants::getMaxDepth(), HcalDDDRecConstants::getNoff(), HcalTopologyMode::H2, HcalTopologyMode::H2HE, HcalBarrel, HcalEndcap, HcalForward, HcalOuter, HcalTriggerTower, hcons_, mps_fire::i, IPHI_MAX, lastHBRing(), lastHERing(), lastHFRing(), lastHORing(), maxEta_, HcalDDDRecConstants::maxHFDepth(), trackingParticleSelector_cfi::maxPhi, maxPhiHE_, mode_, convertSQLiteXML::ok, HcalTopologyMode::SLHC, validHT(), and HcalDigiParam_cfi::zside.

Referenced by decIPhi(), decrementDepth(), exclude(), idBack(), incIPhi(), incrementDepth(), and validHcal().

                                                     {
  bool ok=true;
  int ieta=id.ieta();
  int aieta=id.ietaAbs();
  int depth=id.depth();
  int iphi=id.iphi();
  int zside=id.zside();
  HcalSubdetector subdet=id.subdet();
  int maxPhi = (subdet==HcalEndcap) ? maxPhiHE_ : IPHI_MAX;
  if ((ieta==0 || iphi<=0 || iphi>maxPhi) || aieta>maxEta_) ok = false; // outer limits
 
  if (ok) {
    if (subdet==HcalBarrel) {
      if (mode_==HcalTopologyMode::SLHC || mode_==HcalTopologyMode::H2HE) {
    if ((aieta>lastHBRing()) ||
        (depth>hcons_->getMaxDepth(0,aieta,iphi,zside)) ||
        (depth<hcons_->getMinDepth(0,aieta,iphi,zside))) ok=false;
      } else {
    if (aieta>lastHBRing() || depth>2 || (aieta<=14 && depth>1)) ok=false;
      }
    } else if (subdet==HcalEndcap) {
      if (mode_==HcalTopologyMode::SLHC || mode_==HcalTopologyMode::H2HE) {
        if ((depth>hcons_->getMaxDepth(1,aieta,iphi,zside)) || 
            (depth<hcons_->getMinDepth(1,aieta,iphi,zside)) ||
        (aieta<firstHERing()) || (aieta>lastHERing())) {
          ok = false;
        } else {
          for (const auto & i : etaBinsHE_) {
            if (aieta == i.ieta) {
              if (aieta >= firstHEDoublePhiRing() && (iphi%2)==0) ok=false;
              if (aieta >= firstHEQuadPhiRing()   && (iphi%4)!=3) ok=false;
              if (aieta+1 == hcons_->getNoff(1)) {
        if (depth < 1) ok = false;
          } else {
        if (depth < i.depthStart) ok = false;
          }
              break;
            }
          }
    }
      } else {
    if (depth>hcons_->getMaxDepth(1,aieta,iphi,zside) || 
        aieta<firstHERing() || aieta>lastHERing() || 
        (aieta==firstHERing() && depth!=hcons_->getDepthEta16(2,iphi,zside)) || 
        (aieta==17 && depth!=1 && mode_!=HcalTopologyMode::H2) || // special case at H2
        (((aieta>=17 && aieta<firstHETripleDepthRing()) || 
          aieta==lastHERing()) && depth>2) ||
        (aieta>=firstHEDoublePhiRing() && (iphi%2)==0)) ok=false;
      }
    } else if (subdet==HcalOuter) {
      if (aieta>lastHORing() || iphi>IPHI_MAX || depth!=4) ok=false;
    } else if (subdet==HcalForward) {
      if (aieta<firstHFRing() || aieta>lastHFRing() || ((iphi%2)==0) || 
      (depth>hcons_->maxHFDepth(ieta,iphi)) ||  
      (aieta>=firstHFQuadPhiRing() && ((iphi+1)%4)!=0)) ok=false;
    } else if (subdet==HcalTriggerTower) {
      ok=validHT(HcalTrigTowerDetId(id.rawId()));
    } else {
      ok=false;
    }
  }
  return ok;
}

std::vector< DetId > HcalTopology::west ( const DetId &  id ) const

overridevirtual

Get the neighbors of the given cell in west direction

Implements CaloSubdetectorTopology.

Definition at line 288 of file HcalTopology.cc.

References mps_fire::i, and incIEta().

Referenced by spr::newHCALIdEW(), and producerTag().

                                                         {
  std::vector<DetId> vNeighborsDetId;
  HcalDetId neighbors[2];
  for (int i=0;i<incIEta(HcalDetId(id),neighbors);i++) {
    if (neighbors[i].oldFormat()) neighbors[i].changeForm();
    vNeighborsDetId.emplace_back(DetId(neighbors[i].rawId()));
  }
  return  vNeighborsDetId;
}

bool HcalTopology::withSpecialRBXHBHE ( ) const

inline

Definition at line 162 of file HcalTopology.h.

References hcons_, and HcalDDDRecConstants::withSpecialRBXHBHE().

Referenced by CaloTowersCreationAlgo::assignHitHcal(), CaloTowerConstituentsMap::constituentsOf(), CaloTowersCreationAlgo::hadShwPosFromCells(), HcalRecHitsAnalyzer::hcalSevLvl(), PFHcalRecHitCreator< Digi, Geometry, Layer, Detector >::importRecHits(), HcalGeometry::init(), HBHEPlan1Combiner::produce(), HcalHitSelection::skim(), and PFRecHitQTestHCALChannel::test().

{return hcons_->withSpecialRBXHBHE();}

Member Data Documentation

unsigned int HcalTopology::CALIBSize_

private

Definition at line 213 of file HcalTopology.h.

Referenced by getCALIBSize().

SegmentationMap HcalTopology::depthSegmentation_

private

Definition at line 224 of file HcalTopology.h.

Referenced by getDepthSegmentation(), and setDepthSegmentation().

SegmentationMap HcalTopology::depthSegmentationOne_

private

Definition at line 225 of file HcalTopology.h.

Referenced by getDepthSegmentation(), and setDepthSegmentation().

int HcalTopology::doublePhiBins_

private

Definition at line 203 of file HcalTopology.h.

Referenced by doublePhiBins(), and nPhiBins().

std::vector<double> HcalTopology::dPhiTable

private

Definition at line 216 of file HcalTopology.h.

Referenced by HcalTopology(), nPhiBins(), and phiBin().

std::vector<double> HcalTopology::dPhiTableHF

private

Definition at line 216 of file HcalTopology.h.

Referenced by HcalTopology(), nPhiBins(), and phiBin().

std::vector<HcalDDDRecConstants::HcalEtaBin> HcalTopology::etaBinsHB_

private

Definition at line 198 of file HcalTopology.h.

Referenced by decrementDepth(), and HcalTopology().

std::vector<HcalDDDRecConstants::HcalEtaBin> HcalTopology::etaBinsHE_

private

Definition at line 198 of file HcalTopology.h.

Referenced by decrementDepth(), HcalTopology(), and validRaw().

int HcalTopology::etaHE2HF_

private

Definition at line 205 of file HcalTopology.h.

Referenced by HcalTopology(), and incAIEta().

int HcalTopology::etaHF2HE_

private

Definition at line 205 of file HcalTopology.h.

Referenced by decAIEta(), decrementDepth(), and HcalTopology().

std::vector<double> HcalTopology::etaTable

private

Definition at line 216 of file HcalTopology.h.

Referenced by etaMax(), etaRange(), etaRing(), and HcalTopology().

std::vector<double> HcalTopology::etaTableHF

private

Definition at line 216 of file HcalTopology.h.

Referenced by etaMax(), etaRange(), etaRing(), and HcalTopology().

bool HcalTopology::excludeHB_

private

Definition at line 188 of file HcalTopology.h.

Referenced by exclude(), excludeSubdetector(), and isExcluded().

bool HcalTopology::excludeHE_

private

Definition at line 188 of file HcalTopology.h.

Referenced by exclude(), excludeSubdetector(), and isExcluded().

bool HcalTopology::excludeHF_

private

Definition at line 188 of file HcalTopology.h.

Referenced by exclude(), excludeSubdetector(), and isExcluded().

bool HcalTopology::excludeHO_

private

Definition at line 188 of file HcalTopology.h.

Referenced by exclude(), excludeSubdetector(), and isExcluded().

std::vector<HcalDetId> HcalTopology::exclusionList_

private

Definition at line 187 of file HcalTopology.h.

Referenced by exclude(), and isExcluded().

int HcalTopology::firstHBRing_

private

Definition at line 193 of file HcalTopology.h.

Referenced by etaRing(), firstHBRing(), HcalTopology(), nPhiBins(), and phiBin().

int HcalTopology::firstHEDoublePhiRing_

private

Definition at line 201 of file HcalTopology.h.

Referenced by firstHEDoublePhiRing(), and HcalTopology().

int HcalTopology::firstHEQuadPhiRing_

private

Definition at line 201 of file HcalTopology.h.

Referenced by firstHEQuadPhiRing(), and HcalTopology().

int HcalTopology::firstHERing_

private

Definition at line 194 of file HcalTopology.h.

Referenced by firstHERing(), and HcalTopology().

int HcalTopology::firstHETripleDepthRing_

private

Definition at line 202 of file HcalTopology.h.

Referenced by firstHETripleDepthRing(), and HcalTopology().

int HcalTopology::firstHFQuadPhiRing_

private

Definition at line 201 of file HcalTopology.h.

Referenced by firstHFQuadPhiRing(), and HcalTopology().

int HcalTopology::firstHFRing_

private

Definition at line 195 of file HcalTopology.h.

Referenced by etaRange(), etaRing(), firstHFRing(), HcalTopology(), nPhiBins(), and phiBin().

int HcalTopology::firstHORing_

private

Definition at line 196 of file HcalTopology.h.

Referenced by firstHORing(), and HcalTopology().

unsigned int HcalTopology::HBSize_

private

Definition at line 208 of file HcalTopology.h.

Referenced by denseId2detId(), detId2denseId(), getHBSize(), HcalTopology(), and ncells().

const HcalDDDRecConstants* HcalTopology::hcons_

private

Definition at line 185 of file HcalTopology.h.

Referenced by dddConstants(), decrementDepth(), depthBinInformation(), getPhiZOne(), HcalTopology(), idBack(), idFront(), incrementDepth(), isBH(), mergedDepthDetId(), nPhiBins(), unmergeDepthDetId(), validHcal(), validRaw(), and withSpecialRBXHBHE().

unsigned int HcalTopology::HESize_

private

Definition at line 209 of file HcalTopology.h.

Referenced by denseId2detId(), detId2denseId(), getHESize(), HcalTopology(), and ncells().

unsigned int HcalTopology::HFSize_

private

Definition at line 211 of file HcalTopology.h.

Referenced by getHFSize(), HcalTopology(), and ncells().

unsigned int HcalTopology::HOSize_

private

Definition at line 210 of file HcalTopology.h.

Referenced by denseId2detId(), detId2denseId(), getHOSize(), HcalTopology(), and ncells().

unsigned int HcalTopology::HTSize_

private

Definition at line 212 of file HcalTopology.h.

Referenced by getHTSize(), and HcalTopology().

int HcalTopology::lastHBRing_

private

Definition at line 193 of file HcalTopology.h.

Referenced by etaMax(), HcalTopology(), and lastHBRing().

int HcalTopology::lastHERing_

private

Definition at line 194 of file HcalTopology.h.

Referenced by etaMax(), etaRange(), etaRing(), HcalTopology(), and lastHERing().

int HcalTopology::lastHFRing_

private

Definition at line 195 of file HcalTopology.h.

Referenced by HcalTopology(), and lastHFRing().

int HcalTopology::lastHORing_

private

Definition at line 196 of file HcalTopology.h.

Referenced by etaMax(), HcalTopology(), and lastHORing().

int HcalTopology::maxDepthHB_

private

Definition at line 204 of file HcalTopology.h.

Referenced by denseId2detId(), detId2denseId(), detId2denseIdHB(), HcalTopology(), maxDepth(), and maxDepthHB().

int HcalTopology::maxDepthHE_

private

Definition at line 204 of file HcalTopology.h.

Referenced by denseId2detId(), detId2denseId(), detId2denseIdHE(), HcalTopology(), maxDepth(), and maxDepthHE().

int HcalTopology::maxDepthHF_

private

Definition at line 204 of file HcalTopology.h.

Referenced by denseId2detId(), depthBinInformation(), detId2denseId(), detId2denseIdHF(), HcalTopology(), and maxDepth().

int HcalTopology::maxEta_

private

Definition at line 206 of file HcalTopology.h.

Referenced by HcalTopology(), and validRaw().

int HcalTopology::maxPhiHE_

private

Definition at line 206 of file HcalTopology.h.

Referenced by decIPhi(), denseId2detId(), detId2denseId(), detId2denseIdHE(), HcalTopology(), incIPhi(), and validRaw().

bool HcalTopology::mergePosition_

private

Definition at line 186 of file HcalTopology.h.

Referenced by getMergePositionFlag().

HcalTopologyMode::Mode HcalTopology::mode_

private

Definition at line 190 of file HcalTopology.h.

Referenced by decrementDepth(), depthBinInformation(), etaRange(), HcalTopology(), incrementDepth(), mode(), and validRaw().

int HcalTopology::nEtaHB_

private

Definition at line 199 of file HcalTopology.h.

Referenced by decrementDepth(), denseId2detId(), detId2denseId(), detId2denseIdHB(), and HcalTopology().

int HcalTopology::nEtaHE_

private

Definition at line 199 of file HcalTopology.h.

Referenced by denseId2detId(), detId2denseId(), detId2denseIdHE(), etaMax(), and HcalTopology().

unsigned int HcalTopology::numberOfShapes_

private

Definition at line 214 of file HcalTopology.h.

Referenced by getNumberOfShapes(), and HcalTopology().

std::vector<double> HcalTopology::phioff

private

Definition at line 217 of file HcalTopology.h.

Referenced by HcalTopology(), and phiBin().

int HcalTopology::singlePhiBins_

private

Definition at line 203 of file HcalTopology.h.

Referenced by nPhiBins(), and singlePhiBins().

int HcalTopology::topoVersion_

private

Definition at line 220 of file HcalTopology.h.

Referenced by denseId2detId(), detId2denseId(), detId2denseIdHB(), detId2denseIdHE(), detId2denseIdHF(), detId2denseIdHO(), HcalTopology(), and topoVersion().

HcalTopologyMode::TriggerMode HcalTopology::triggerMode_

private

Definition at line 191 of file HcalTopology.h.

Referenced by HcalTopology(), triggerMode(), and validHT().

std::vector<int> HcalTopology::unitPhi

private

Definition at line 218 of file HcalTopology.h.

Referenced by HcalTopology(), and phiBin().

std::vector<int> HcalTopology::unitPhiHF

private

Definition at line 218 of file HcalTopology.h.

Referenced by HcalTopology(), and phiBin().