#include <CastorTopology.h>

Inheritance diagram for CastorTopology:

Public Member Functions
	CastorTopology ()

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

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

void	exclude (const HcalCastorDetId &id)

void	exclude (int zside)

void	exclude (int zside, HcalCastorDetId::Section section)

int	exclude (int zside, HcalCastorDetId::Section section1, int isec1, int imod1, HcalCastorDetId::Section section2, int isec2, int imod2)

int	firstCell (HcalCastorDetId::Section section) const

virtual std::vector< DetId >	incModule (const DetId &id) const

virtual std::vector< DetId >	incSector (const DetId &id) const

int	lastCell (HcalCastorDetId::Section section) const

virtual unsigned int	ncells () const
	return a count of valid cells (for dense indexing use) More...

int	ncells (HcalCastorDetId::Section section) const

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

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

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

virtual bool	valid (const DetId &) const

virtual bool	valid (const HcalCastorDetId &id) const

virtual bool	validRaw (const HcalCastorDetId &id) const

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

Public Member Functions inherited from CaloSubdetectorTopology
	CaloSubdetectorTopology ()
	standard constructor More...

virtual DetId	denseId2detId (unsigned int) const
	return a linear packed id More...

virtual bool	denseIdConsistent (int topoVer) const
	return whether this topology is consistent with the numbering in the given topology More...

virtual unsigned int	detId2denseId (const DetId &) const
	return a linear packed id 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 unsigned int	ncells () const
	return a count of valid cells (for dense indexing use) More...

virtual int	topoVersion () const
	return a version which identifies the given topology More...

virtual bool	valid (const DetId &) const
	is this detid present in the Topology? More...

virtual	~CaloSubdetectorTopology ()
	virtual destructor More...

Private Member Functions
int	firstEMModule () const

int	firstHADModule () const

bool	isExcluded (const HcalCastorDetId &id) const

int	lastEMModule () const

int	lastHADModule () const

Private Attributes
bool	excludeEM_

bool	excludeHAD_

bool	excludeZN_

bool	excludeZP_

std::vector< HcalCastorDetId >	exclusionList_

int	firstEMModule_

int	firstHADModule_

int	lastEMModule_

int	lastHADModule_

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

Author: P. Katsas - UoA

Definition at line 13 of file CastorTopology.h.

Constructor & Destructor Documentation

◆ CastorTopology()

CastorTopology::CastorTopology ( )

Definition at line 10 of file CastorTopology.cc.

     : excludeEM_(false),
       excludeHAD_(false),
       excludeZP_(false),
       excludeZN_(false),
       firstEMModule_(1),
       lastEMModule_(2),
       firstHADModule_(3),
       lastHADModule_(14) {}

Member Function Documentation

◆ down()

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

overridevirtual

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

Implements CaloSubdetectorTopology.

Definition at line 236 of file CastorTopology.cc.

                                                           {
   edm::LogVerbatim("ForwardGeom") << "CastorTopology::down() not yet implemented";
   std::vector<DetId> vNeighborsDetId;
   return vNeighborsDetId;
 }

◆ east()

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

overridevirtual

Get the neighbors of the given cell in east direction

Implements CaloSubdetectorTopology.

Definition at line 209 of file CastorTopology.cc.

                                                           {
   edm::LogVerbatim("ForwardGeom") << "CastorTopology::east() not yet implemented";
   std::vector<DetId> vNeighborsDetId;
   return vNeighborsDetId;
 }

◆ exclude() [1/4]

void CastorTopology::exclude ( const HcalCastorDetId & id )

Exlucde a cell

Definition at line 46 of file CastorTopology.cc.

References exclusionList_, mps_fire::i, EcalPhiSymFlatTableProducers_cfi::id, and pfDeepBoostedJetPreprocessParams_cfi::lower_bound.

Referenced by exclude().

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

◆ exclude() [2/4]

void CastorTopology::exclude ( int zside )

Exclude a side

Definition at line 53 of file CastorTopology.cc.

References excludeZN_, excludeZP_, and ecaldqm::zside().

                                       {
   switch (zside) {
     case (1):
       excludeZP_ = true;
       break;
     case (-1):
       excludeZN_ = true;
       break;
     default:
       break;
   }
 }

◆ exclude() [3/4]

void CastorTopology::exclude	(	int	zside,
		HcalCastorDetId::Section	section
	)

Exclude a section, in either side (+1 positive, -1 negative)

Definition at line 66 of file CastorTopology.cc.

References HcalCastorDetId::EM, excludeEM_, excludeHAD_, excludeZN_, excludeZP_, HcalCastorDetId::HAD, hgcalPlots::section, and ecaldqm::zside().

                                                                       {
   switch (zside) {
     case (1):
       excludeZP_ = true;
       break;
     case (-1):
       excludeZN_ = true;
       break;
     default:
       break;
   }
   switch (section) {
     case (HcalCastorDetId::EM):
       excludeEM_ = true;
       break;
     case (HcalCastorDetId::HAD):
       excludeHAD_ = true;
       break;
     default:
       break;
   }
 }

◆ exclude() [4/4]

int CastorTopology::exclude	(	int	zside,
		HcalCastorDetId::Section	section1,
		int	isec1,
		int	imod1,
		HcalCastorDetId::Section	section2,
		int	isec2,
		int	imod2
	)

Exclude a range of channels (deph) for a given subdetector

Definition at line 89 of file CastorTopology.cc.

References HcalCastorDetId::EM, exclude(), excludeEM_, excludeHAD_, excludeZN_, excludeZP_, HcalCastorDetId::HAD, EcalPhiSymFlatTableProducers_cfi::id, l1ctLayer1_patternWriters_cff::isec, create_idmaps::n, validRaw(), and ecaldqm::zside().

                                        {
   bool exed = false;
   switch (zside) {
     case (1):
       exed = excludeZP_;
       break;
     case (-1):
       exed = excludeZN_;
       break;
     default:
       exed = false;
   }
   if (exed)
     return 0;
 
   /* NOTE not so sure about the exclusion */
   if (section1 == HcalCastorDetId::EM && section2 == HcalCastorDetId::EM) {
     exed = excludeEM_;
   } else if (section1 == HcalCastorDetId::HAD && section2 == HcalCastorDetId::HAD) {
     exed = excludeHAD_;
   } else {
     exed = false;
   };
 
   if (exed)
     return 0;
 
   bool isPositive = false;
   if (zside == 1)
     isPositive = true;
 
   int n = 0;
   for (int isec = isec1; isec < isec2; isec++) {
     for (int imod = imod1; imod < imod2; imod++) {
       HcalCastorDetId id(section1, isPositive, isec, imod);
       if (validRaw(id))
         exclude(id);
       n++;
     }
   }
   return n;
 }

◆ firstCell()

int CastorTopology::firstCell ( HcalCastorDetId::Section section ) const

Definition at line 258 of file CastorTopology.cc.

References HcalCastorDetId::EM, firstEMModule_, firstHADModule_, HcalCastorDetId::HAD, hgcalPlots::section, and HcalCastorDetId::Unknown.

Referenced by CastorHardcodeGeometryLoader::fill().

                                                                   {
   int firstCell = 0;
   switch (section) {
     case (HcalCastorDetId::EM):
       firstCell = firstEMModule_;
       break;
     case (HcalCastorDetId::HAD):
       firstCell = firstHADModule_;
       break;
     case (HcalCastorDetId::Unknown):
       firstCell = 0;
       break;
   }
   return firstCell;
 }

◆ firstEMModule()

int CastorTopology::firstEMModule ( ) const

inlineprivate

Definition at line 69 of file CastorTopology.h.

References firstEMModule_.

69 { return firstEMModule_; }

CastorTopology::firstEMModule_

int firstEMModule_

Definition: CastorTopology.h:65

◆ firstHADModule()

int CastorTopology::firstHADModule ( ) const

inlineprivate

Definition at line 70 of file CastorTopology.h.

References firstHADModule_.

70 { return firstHADModule_; }

CastorTopology::firstHADModule_

int firstHADModule_

Definition: CastorTopology.h:65

◆ incModule()

std::vector< DetId > CastorTopology::incModule ( const DetId & id ) const

virtual

Get the neigbors of the given cell with higher module

Definition at line 168 of file CastorTopology.cc.

References HcalCastorDetId::EM, HcalCastorDetId::HAD, HcalCastorDetId::module(), MODULE_EM_MAX, MODULE_HAD_MAX, DetId::rawId(), HcalCastorDetId::section(), HcalCastorDetId::sector(), validRaw(), and HcalCastorDetId::zside().

                                                                 {
   std::vector<DetId> vNeighborsDetId;
   HcalCastorDetId castorId = HcalCastorDetId(id);
   HcalCastorDetId castorDetId;
   if (validRaw(castorId) && castorId.section() == HcalCastorDetId::EM) {
     bool isPositive = false;
     if (castorId.zside() == 1)
       isPositive = true;
     if (castorId.module() == 1) {
       castorDetId = HcalCastorDetId(castorId.section(), isPositive, castorId.sector(), castorId.module() + 1);
       vNeighborsDetId.emplace_back(castorDetId.rawId());
       return vNeighborsDetId;
     }
     if (castorId.module() == MODULE_EM_MAX) {
       castorDetId = HcalCastorDetId(castorId.section(), isPositive, castorId.sector(), castorId.module() - 1);
       vNeighborsDetId.emplace_back(castorDetId.rawId());
       return vNeighborsDetId;
     }
     castorDetId = HcalCastorDetId(castorId.section(), isPositive, castorId.sector(), castorId.module() - 1);
     vNeighborsDetId.emplace_back(castorDetId.rawId());
     castorDetId = HcalCastorDetId(castorId.section(), isPositive, castorId.sector(), castorId.module() + 1);
     vNeighborsDetId.emplace_back(castorDetId.rawId());
   }
   if (validRaw(castorId) && castorId.section() == HcalCastorDetId::HAD) {
     bool isPositive = false;
     if (castorId.zside() == 1)
       isPositive = true;
     if (castorId.module() == 1) {
       castorDetId = HcalCastorDetId(castorId.section(), isPositive, castorId.sector(), castorId.module() + 1);
       vNeighborsDetId.emplace_back(castorDetId.rawId());
       return vNeighborsDetId;
     }
     if (castorId.module() == MODULE_HAD_MAX) {
       castorDetId = HcalCastorDetId(castorId.section(), isPositive, castorId.sector(), castorId.module() - 1);
       vNeighborsDetId.emplace_back(castorDetId.rawId());
       return vNeighborsDetId;
     }
   }
   return vNeighborsDetId;
 }

◆ incSector()

std::vector< DetId > CastorTopology::incSector ( const DetId & id ) const

virtual

Get the neighbors of the given cell with higher #sector

Definition at line 142 of file CastorTopology.cc.

References HcalCastorDetId::module(), DetId::rawId(), HcalCastorDetId::section(), HcalCastorDetId::sector(), validRaw(), and HcalCastorDetId::zside().

                                                                 {
   std::vector<DetId> vNeighborsDetId;
   HcalCastorDetId castorId = HcalCastorDetId(id);
   HcalCastorDetId castorDetId;
   if (validRaw(castorId)) {
     bool isPositive = false;
     if (castorId.zside() == 1)
       isPositive = true;
     if (castorId.sector() == 1) {
       castorDetId = HcalCastorDetId(castorId.section(), isPositive, castorId.sector() + 1, castorId.module());
       vNeighborsDetId.emplace_back(castorDetId.rawId());
       return vNeighborsDetId;
     }
     if (castorId.sector() == 16) {
       castorDetId = HcalCastorDetId(castorId.section(), isPositive, castorId.sector() - 1, castorId.module());
       vNeighborsDetId.emplace_back(castorDetId.rawId());
       return vNeighborsDetId;
     }
     castorDetId = HcalCastorDetId(castorId.section(), isPositive, castorId.sector() - 1, castorId.module());
     vNeighborsDetId.emplace_back(castorDetId.rawId());
     castorDetId = HcalCastorDetId(castorId.section(), isPositive, castorId.sector() + 1, castorId.module());
     vNeighborsDetId.emplace_back(castorDetId.rawId());
   }
   return vNeighborsDetId;
 }

◆ isExcluded()

bool CastorTopology::isExcluded ( const HcalCastorDetId & id ) const

private

Definition at line 22 of file CastorTopology.cc.

References HcalCastorDetId::EM, excludeEM_, excludeHAD_, exclusionList_, HcalCastorDetId::HAD, mps_fire::i, EcalPhiSymFlatTableProducers_cfi::id, pfDeepBoostedJetPreprocessParams_cfi::lower_bound, and hgcalPlots::section.

Referenced by valid().

                                                                {
   bool exed = false;
 
   // check for section exclutions
   switch (id.section()) {
     case (HcalCastorDetId::EM):
       exed = excludeEM_;
       break;
     case (HcalCastorDetId::HAD):
       exed = excludeHAD_;
       break;
     default:
       exed = false;
   }
 
   // check the entire list
   if (!exed && !exclusionList_.empty()) {
     std::vector<HcalCastorDetId>::const_iterator i = std::lower_bound(exclusionList_.begin(), exclusionList_.end(), id);
     if (i != exclusionList_.end() && *i == id)
       exed = true;
   }
   return exed;
 }

◆ lastCell()

int CastorTopology::lastCell ( HcalCastorDetId::Section section ) const

Definition at line 274 of file CastorTopology.cc.

References HcalCastorDetId::EM, HcalCastorDetId::HAD, lastEMModule_, lastHADModule_, hgcalPlots::section, and HcalCastorDetId::Unknown.

Referenced by CastorHardcodeGeometryLoader::fill().

                                                                  {
   int lastCell = 0;
   switch (section) {
     case (HcalCastorDetId::EM):
       lastCell = lastEMModule_;
       break;
     case (HcalCastorDetId::HAD):
       lastCell = lastHADModule_;
       break;
     case (HcalCastorDetId::Unknown):
       lastCell = 0;
       break;
   }
   return lastCell;
 }

◆ lastEMModule()

int CastorTopology::lastEMModule ( ) const

inlineprivate

Definition at line 71 of file CastorTopology.h.

References lastEMModule_.

71 { return lastEMModule_; }

CastorTopology::lastEMModule_

int lastEMModule_

Definition: CastorTopology.h:65

◆ lastHADModule()

int CastorTopology::lastHADModule ( ) const

inlineprivate

Definition at line 72 of file CastorTopology.h.

References lastHADModule_.

72 { return lastHADModule_; }

CastorTopology::lastHADModule_

int lastHADModule_

Definition: CastorTopology.h:65

◆ ncells() [1/2]

virtual unsigned int CaloSubdetectorTopology::ncells

inline

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

Definition at line 30 of file CaloSubdetectorTopology.h.

30 { return 1; }

◆ ncells() [2/2]

int CastorTopology::ncells ( HcalCastorDetId::Section section ) const

Definition at line 242 of file CastorTopology.cc.

References HcalCastorDetId::EM, HcalCastorDetId::HAD, MODULE_EM_MAX, MODULE_HAD_MAX, CaloSubdetectorTopology::ncells(), hgcalPlots::section, and HcalCastorDetId::Unknown.

                                                                {
   int ncells = 0;
   switch (section) {
     case (HcalCastorDetId::EM):
       ncells = MODULE_EM_MAX * 16;
       break;
     case (HcalCastorDetId::HAD):
       ncells = MODULE_HAD_MAX * 16;
       break;
     case (HcalCastorDetId::Unknown):
       ncells = 0;
       break;
   }
   return ncells;
 }

◆ north()

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

overridevirtual

Get the neighbors of the given cell in north direction

Implements CaloSubdetectorTopology.

Definition at line 221 of file CastorTopology.cc.

                                                            {
   edm::LogVerbatim("ForwardGeom") << "CastorTopology::north() not yet implemented";
   std::vector<DetId> vNeighborsDetId;
   return vNeighborsDetId;
 }

◆ south()

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

overridevirtual

Get the neighbors of the given cell in south direction

Implements CaloSubdetectorTopology.

Definition at line 226 of file CastorTopology.cc.

                                                            {
   edm::LogVerbatim("ForwardGeom") << "CastorTopology::south() not yet implemented";
   std::vector<DetId> vNeighborsDetId;
   return vNeighborsDetId;
 }

◆ up()

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

overridevirtual

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

Implements CaloSubdetectorTopology.

Definition at line 231 of file CastorTopology.cc.

                                                         {
   edm::LogVerbatim("ForwardGeom") << "CastorTopology::up() not yet implemented";
   std::vector<DetId> vNeighborsDetId;
   return vNeighborsDetId;
 }

◆ valid() [1/2]

virtual bool CaloSubdetectorTopology::valid

inline

Is this a valid cell id?

Definition at line 24 of file CaloSubdetectorTopology.h.

24 { return false; };

◆ valid() [2/2]

bool CastorTopology::valid ( const HcalCastorDetId & id ) const

virtual

Definition at line 20 of file CastorTopology.cc.

References isExcluded(), and validRaw().

Referenced by CastorHardcodeGeometryLoader::fill().

20 { return (validRaw(id) && !isExcluded(id)); }

CastorTopology::isExcluded

bool isExcluded(const HcalCastorDetId &id) const

Definition: CastorTopology.cc:22

CastorTopology::validRaw

virtual bool validRaw(const HcalCastorDetId &id) const

Definition: CastorTopology.cc:138

◆ validRaw()

bool CastorTopology::validRaw ( const HcalCastorDetId & id ) const

virtual

Is this a valid cell id?

Definition at line 138 of file CastorTopology.cc.

References callgraph::module, hgcalPlots::section, nano_mu_digi_cff::sector, HcalCastorDetId::validDetId(), and ecaldqm::zside().

Referenced by exclude(), incModule(), incSector(), and valid().

                                                              {
   return HcalCastorDetId::validDetId(id.section(), id.zside() > 0, id.sector(), id.module());
 }

◆ west()

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

overridevirtual

Get the neighbors of the given cell in west direction

Implements CaloSubdetectorTopology.

Definition at line 215 of file CastorTopology.cc.

                                                           {
   edm::LogVerbatim("ForwardGeom") << "CastorTopology::west() not yet implemented";
   std::vector<DetId> vNeighborsDetId;
   return vNeighborsDetId;
 }

Member Data Documentation

◆ excludeEM_

bool CastorTopology::excludeEM_

private

Definition at line 63 of file CastorTopology.h.

Referenced by exclude(), and isExcluded().

◆ excludeHAD_

bool CastorTopology::excludeHAD_

private

Definition at line 63 of file CastorTopology.h.

Referenced by exclude(), and isExcluded().

◆ excludeZN_

bool CastorTopology::excludeZN_

private

Definition at line 63 of file CastorTopology.h.

Referenced by exclude().

◆ excludeZP_

bool CastorTopology::excludeZP_

private

Definition at line 63 of file CastorTopology.h.

Referenced by exclude().

◆ exclusionList_

std::vector<HcalCastorDetId> CastorTopology::exclusionList_

private

Definition at line 61 of file CastorTopology.h.

Referenced by exclude(), and isExcluded().

◆ firstEMModule_

int CastorTopology::firstEMModule_

private

Definition at line 65 of file CastorTopology.h.

Referenced by firstCell(), and firstEMModule().

◆ firstHADModule_

int CastorTopology::firstHADModule_

private

Definition at line 65 of file CastorTopology.h.

Referenced by firstCell(), and firstHADModule().

◆ lastEMModule_

int CastorTopology::lastEMModule_

private

Definition at line 65 of file CastorTopology.h.

Referenced by lastCell(), and lastEMModule().

◆ lastHADModule_

int CastorTopology::lastHADModule_

private

Definition at line 65 of file CastorTopology.h.

Referenced by lastCell(), and lastHADModule().

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CastorTopology()

Member Function Documentation

◆ down()

◆ east()

◆ exclude() [1/4]

◆ exclude() [2/4]

◆ exclude() [3/4]

◆ exclude() [4/4]

◆ firstCell()

◆ firstEMModule()

◆ firstHADModule()

◆ incModule()

◆ incSector()

◆ isExcluded()

◆ lastCell()

◆ lastEMModule()

◆ lastHADModule()

◆ ncells() [1/2]

◆ ncells() [2/2]

◆ north()

◆ south()

◆ up()

◆ valid() [1/2]

◆ valid() [2/2]

◆ validRaw()

◆ west()

Member Data Documentation

◆ excludeEM_

◆ excludeHAD_

◆ excludeZN_

◆ excludeZP_

◆ exclusionList_

◆ firstEMModule_

◆ firstHADModule_

◆ lastEMModule_

◆ lastHADModule_