ZdcTopology Class Reference

#include <ZdcTopology.h>

Inheritance diagram for ZdcTopology:

Public Member Functions
std::vector< DetId >	down (const DetId &id) const override
std::vector< DetId >	east (const DetId &id) const override
void	exclude (const HcalZDCDetId &id)
void	exclude (int zside)
void	exclude (int zside, HcalZDCDetId::Section section)
int	exclude (int zside, HcalZDCDetId::Section section, int ich1, int ich2)
int	firstCell (HcalZDCDetId::Section section) const
int	lastCell (HcalZDCDetId::Section section) const
virtual std::vector< DetId >	longitudinal (const DetId &id) const
int	ncells (HcalZDCDetId::Section section) const
std::vector< DetId >	north (const DetId &id) const override
std::vector< DetId >	south (const DetId &id) const override
virtual std::vector< DetId >	transverse (const DetId &id) const
std::vector< DetId >	up (const DetId &id) const override
virtual bool	valid (const HcalZDCDetId &id) const
std::vector< DetId >	west (const DetId &id) const override
	ZdcTopology ()
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
int	firstLUMModule () const
int	firstRPDModule () const
bool	isExcluded (const HcalZDCDetId &id) const
int	lastEMModule () const
int	lastHADModule () const
int	lastLUMModule () const
int	lastRPDModule () const
bool	validRaw (const HcalZDCDetId &id) const

Private Attributes
bool	excludeEM_
bool	excludeHAD_
bool	excludeLUM_
bool	excludeRPD_
bool	excludeZN_
bool	excludeZP_
std::vector< HcalZDCDetId >	exclusionList_
int	firstEMModule_
int	firstHADModule_
int	firstLUMModule_
int	firstRPDModule_
int	lastEMModule_
int	lastHADModule_
int	lastLUMModule_
int	lastRPDModule_

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

Definition at line 14 of file ZdcTopology.h.

Constructor & Destructor Documentation

ZdcTopology::ZdcTopology

(

)

Definition at line 11 of file ZdcTopology.cc.

                         :
  excludeEM_(false),
  excludeHAD_(false),
  excludeLUM_(false),
  excludeRPD_(false),
  excludeZP_(false),
  excludeZN_(false),
  firstEMModule_(1),
  lastEMModule_(5),
  firstHADModule_(1),
  lastHADModule_(4), 
  firstLUMModule_(1),
  lastLUMModule_(2),
  firstRPDModule_(1),
  lastRPDModule_(16)
{
}

Member Function Documentation

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

overridevirtual

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

Implements CaloSubdetectorTopology.

Definition at line 251 of file ZdcTopology.cc.

References gather_cfg::cout.

{
  std::cout << "ZdcTopology::down() not yet implemented" << std::endl;
  std::vector<DetId> vNeighborsDetId;
  return  vNeighborsDetId;
}

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

overridevirtual

Get the neighbors of the given cell in east direction

Implements CaloSubdetectorTopology.

Definition at line 219 of file ZdcTopology.cc.

References gather_cfg::cout.

{
  std::cout << "ZdcTopology::east() not yet implemented" << std::endl;
  std::vector<DetId> vNeighborsDetId;
  return  vNeighborsDetId;
}

void ZdcTopology::exclude

(

const HcalZDCDetId &

id

)

Exlucde a cell

Definition at line 57 of file ZdcTopology.cc.

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

Referenced by exclude().

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

void ZdcTopology::exclude

(

int

zside

)

Exclude a side

Definition at line 65 of file ZdcTopology.cc.

References excludeZN_, and excludeZP_.

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

void ZdcTopology::exclude	(	int	zside,
		HcalZDCDetId::Section	section
	)

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

Definition at line 73 of file ZdcTopology.cc.

References HcalZDCDetId::EM, excludeEM_, excludeHAD_, excludeLUM_, excludeRPD_, excludeZN_, excludeZP_, HcalZDCDetId::HAD, HcalZDCDetId::LUM, and HcalZDCDetId::RPD.

                                                                {
  switch(zside){
  case( 1): excludeZP_ = true; break;
  case(-1): excludeZN_ = true; break;
  default: break;
  }
  switch (section) {
  case(HcalZDCDetId::EM)  : excludeEM_ = true; break; 
  case(HcalZDCDetId::HAD) : excludeHAD_ = true; break; 
  case(HcalZDCDetId::LUM) : excludeLUM_ = true; break;
  case(HcalZDCDetId::RPD) : excludeRPD_ = true; break;
  default: break;
  }
}

int ZdcTopology::exclude	(	int	zside,
		HcalZDCDetId::Section	section,
		int	ich1,
		int	ich2
	)

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

Definition at line 88 of file ZdcTopology.cc.

References HcalZDCDetId::EM, exclude(), excludeEM_, excludeHAD_, excludeLUM_, excludeRPD_, excludeZN_, excludeZP_, HcalZDCDetId::HAD, triggerObjects_cff::id, HcalZDCDetId::LUM, gen::n, HcalZDCDetId::RPD, and validRaw().

                                                                                   {
  bool exed = false;
  switch(zside){
  case( 1): exed = excludeZP_; break;
  case(-1): exed = excludeZN_; break;
  default: exed = false;
  }
  if (exed) return 0;

  switch (section) {
  case(HcalZDCDetId::EM)  : exed = excludeEM_; break; 
  case(HcalZDCDetId::HAD) : exed = excludeHAD_; break; 
  case(HcalZDCDetId::LUM) : exed = excludeLUM_; break;
  case(HcalZDCDetId::RPD) : exed = excludeRPD_; break;
  default: exed = false;
  }
  if (exed) return 0;

  bool isPositive = false;
  if(zside == 1)isPositive = true;

  int n = 0;
  for (int ich = ich1; ich < ich2; ich++){
    HcalZDCDetId id(section, isPositive, ich);  
    if(validRaw(id))exclude(id);
    n++;
  }
  return n;
}

int ZdcTopology::firstCell

(

HcalZDCDetId::Section

section

)

const

Definition at line 270 of file ZdcTopology.cc.

References HcalZDCDetId::EM, firstEMModule_, firstHADModule_, firstLUMModule_, firstRPDModule_, HcalZDCDetId::HAD, HcalZDCDetId::LUM, HcalZDCDetId::RPD, and HcalZDCDetId::Unknown.

Referenced by ZdcHardcodeGeometryLoader::fill().

                                                           {
  int firstCell = 0;
  switch (section) {
  case(HcalZDCDetId::EM) : firstCell = firstEMModule_ ; break;
  case(HcalZDCDetId::HAD) : firstCell = firstHADModule_; break; 
  case(HcalZDCDetId::LUM) : firstCell = firstLUMModule_; break;
  case(HcalZDCDetId::RPD) : firstCell = firstRPDModule_; break;
  case(HcalZDCDetId::Unknown) : firstCell  = 0; break;
  }
  return firstCell;
}

int ZdcTopology::firstEMModule ( ) const

inlineprivate

Definition at line 67 of file ZdcTopology.h.

References firstEMModule_.

{return firstEMModule_;}

int ZdcTopology::firstHADModule ( ) const

inlineprivate

Definition at line 68 of file ZdcTopology.h.

References firstHADModule_.

{return firstHADModule_;}  

int ZdcTopology::firstLUMModule ( ) const

inlineprivate

Definition at line 69 of file ZdcTopology.h.

References firstLUMModule_.

{return firstLUMModule_;}

int ZdcTopology::firstRPDModule ( ) const

inlineprivate

Definition at line 70 of file ZdcTopology.h.

References firstRPDModule_.

{return firstRPDModule_;}

bool ZdcTopology::isExcluded ( const HcalZDCDetId &  id ) const

private

Definition at line 36 of file ZdcTopology.cc.

References HcalZDCDetId::EM, excludeEM_, excludeHAD_, excludeLUM_, excludeRPD_, exclusionList_, HcalZDCDetId::HAD, mps_fire::i, triggerObjects_cff::id, HcalZDCDetId::LUM, HcalZDCDetId::RPD, and trackingPlots::section.

Referenced by valid().

                                                         {
  bool exed=false;

  // check for section exclutions
  switch (id.section()) {
  case(HcalZDCDetId::EM)  : exed = excludeEM_; break; 
  case(HcalZDCDetId::HAD) : exed = excludeHAD_; break; 
  case(HcalZDCDetId::LUM) : exed = excludeLUM_; break;
  case(HcalZDCDetId::RPD) : exed = excludeRPD_; break;
  default: exed = false;
  }

  // check the entire list
  if (!exed && !exclusionList_.empty()) {
    std::vector<HcalZDCDetId>::const_iterator 
      i=std::lower_bound(exclusionList_.begin(),exclusionList_.end(),id);
    if (i!=exclusionList_.end() && *i==id) exed=true;
  }
  return exed;
}

int ZdcTopology::lastCell

(

HcalZDCDetId::Section

section

)

const

Definition at line 282 of file ZdcTopology.cc.

References HcalZDCDetId::EM, HcalZDCDetId::HAD, lastEMModule_, lastHADModule_, lastLUMModule_, lastRPDModule_, HcalZDCDetId::LUM, HcalZDCDetId::RPD, and HcalZDCDetId::Unknown.

Referenced by ZdcHardcodeGeometryLoader::fill().

                                                           {
  int lastCell = 0;
  switch (section) {
  case(HcalZDCDetId::EM) : lastCell = lastEMModule_; break;
  case(HcalZDCDetId::HAD) : lastCell = lastHADModule_; break; 
  case(HcalZDCDetId::LUM) : lastCell = lastLUMModule_; break;
  case(HcalZDCDetId::RPD) : lastCell = lastRPDModule_; break;
  case(HcalZDCDetId::Unknown) : lastCell  = 0; break;
  }
  return lastCell;
}

int ZdcTopology::lastEMModule ( ) const

inlineprivate

Definition at line 71 of file ZdcTopology.h.

References lastEMModule_.

{return lastEMModule_;}

int ZdcTopology::lastHADModule ( ) const

inlineprivate

Definition at line 72 of file ZdcTopology.h.

References lastHADModule_.

{return lastHADModule_;}  

int ZdcTopology::lastLUMModule ( ) const

inlineprivate

Definition at line 73 of file ZdcTopology.h.

References lastLUMModule_.

{return lastLUMModule_;}

int ZdcTopology::lastRPDModule ( ) const

inlineprivate

Definition at line 74 of file ZdcTopology.h.

References lastRPDModule_.

{return lastRPDModule_;}

std::vector< DetId > ZdcTopology::longitudinal ( const DetId &  id ) const

virtual

Get the longitudinal neighbors (Z) of the given cell

Definition at line 166 of file ZdcTopology.cc.

References HcalZDCDetId::channel(), HcalZDCDetId::HAD, ICH_HAD_MAX, ICH_LUM_MAX, ICH_RPD_MAX, HcalZDCDetId::LUM, DetId::rawId(), HcalZDCDetId::RPD, HcalZDCDetId::section(), validRaw(), and HcalZDCDetId::zside().

                                                               {
  std::vector<DetId> vNeighborsDetId;
  HcalZDCDetId zdcId = HcalZDCDetId(id);
  HcalZDCDetId zdcDetId;
  if(validRaw(zdcId) && zdcId.section()== HcalZDCDetId::HAD){
    bool isPositive = false;
    if(zdcId.zside()==1)isPositive = true;
    if(zdcId.channel()==1){
      zdcDetId = HcalZDCDetId(zdcId.section(), isPositive, zdcId.channel()+1);
      vNeighborsDetId.emplace_back(zdcDetId.rawId());
      return vNeighborsDetId;
    }
    if(zdcId.channel()== ICH_HAD_MAX){
      zdcDetId = HcalZDCDetId(zdcId.section(), isPositive, zdcId.channel()-1);
      vNeighborsDetId.emplace_back(zdcDetId.rawId());
      return vNeighborsDetId;
    }
    zdcDetId = HcalZDCDetId(zdcId.section(), isPositive, zdcId.channel()-1);
    vNeighborsDetId.emplace_back(zdcDetId.rawId());
    zdcDetId = HcalZDCDetId(zdcId.section(), isPositive, zdcId.channel()+1);
    vNeighborsDetId.emplace_back(zdcDetId.rawId());
  }
  if(validRaw(zdcId) && zdcId.section()== HcalZDCDetId::LUM){
    bool isPositive = false;
    if(zdcId.zside()==1)isPositive = true;
    if(zdcId.channel()==1){
      zdcDetId = HcalZDCDetId(zdcId.section(), isPositive, zdcId.channel()+1);
      vNeighborsDetId.emplace_back(zdcDetId.rawId());
      return vNeighborsDetId;
    }
    if(zdcId.channel()== ICH_LUM_MAX){
      zdcDetId = HcalZDCDetId(zdcId.section(), isPositive, zdcId.channel()-1);
      vNeighborsDetId.emplace_back(zdcDetId.rawId());
      return vNeighborsDetId;
    }
  }
  if(validRaw(zdcId) && zdcId.section()== HcalZDCDetId::RPD){
    bool isPositive = false;
    if(zdcId.zside()==1)isPositive = true;
    if(zdcId.channel()==1){
      zdcDetId = HcalZDCDetId(zdcId.section(), isPositive, zdcId.channel()+1);
      vNeighborsDetId.emplace_back(zdcDetId.rawId());
      return vNeighborsDetId;
    }
    if(zdcId.channel()== ICH_RPD_MAX){
      zdcDetId = HcalZDCDetId(zdcId.section(), isPositive, zdcId.channel()-1);
      vNeighborsDetId.emplace_back(zdcDetId.rawId());
      return vNeighborsDetId;
    }
  }
  return vNeighborsDetId;
}

int ZdcTopology::ncells

(

HcalZDCDetId::Section

section

)

const

Definition at line 258 of file ZdcTopology.cc.

References HcalZDCDetId::EM, HcalZDCDetId::HAD, ICH_EM_MAX, ICH_HAD_MAX, ICH_LUM_MAX, ICH_RPD_MAX, HcalZDCDetId::LUM, CaloSubdetectorTopology::ncells(), HcalZDCDetId::RPD, and HcalZDCDetId::Unknown.

                                                        {
  int ncells = 0;
  switch (section) {
  case(HcalZDCDetId::EM)  : ncells = ICH_EM_MAX; break;
  case(HcalZDCDetId::HAD) : ncells = ICH_HAD_MAX; break; 
  case(HcalZDCDetId::LUM) : ncells = ICH_LUM_MAX; break;
  case(HcalZDCDetId::RPD) : ncells = ICH_RPD_MAX; break;
  case(HcalZDCDetId::Unknown) : ncells =0; break;
  }
  return ncells;
}

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

overridevirtual

Get the neighbors of the given cell in north direction

Implements CaloSubdetectorTopology.

Definition at line 233 of file ZdcTopology.cc.

References gather_cfg::cout.

{
  std::cout << "ZdcTopology::north() not yet implemented" << std::endl;
  std::vector<DetId> vNeighborsDetId;
  return  vNeighborsDetId;
}

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

overridevirtual

Get the neighbors of the given cell in south direction

Implements CaloSubdetectorTopology.

Definition at line 239 of file ZdcTopology.cc.

References gather_cfg::cout.

{
  std::cout << "ZdcTopology::south() not yet implemented" << std::endl;
  std::vector<DetId> vNeighborsDetId;
  return  vNeighborsDetId;
}

std::vector< DetId > ZdcTopology::transverse ( const DetId &  id ) const

virtual

Get the transverse (X) neighbors of the given cell

Definition at line 141 of file ZdcTopology.cc.

References HcalZDCDetId::channel(), HcalZDCDetId::EM, ICH_EM_MAX, DetId::rawId(), HcalZDCDetId::section(), validRaw(), and HcalZDCDetId::zside().

                                                             {
  std::vector<DetId> vNeighborsDetId;
  HcalZDCDetId zdcId = HcalZDCDetId(id);
  HcalZDCDetId zdcDetId;
  if(validRaw(zdcId) && zdcId.section()== HcalZDCDetId::EM){
    bool isPositive = false;
    if(zdcId.zside()==1)isPositive = true;
    if(zdcId.channel()==1){
      zdcDetId = HcalZDCDetId(zdcId.section(), isPositive, zdcId.channel()+1);
      vNeighborsDetId.emplace_back(zdcDetId.rawId());
      return vNeighborsDetId;
    }
    if(zdcId.channel()== ICH_EM_MAX){
      zdcDetId = HcalZDCDetId(zdcId.section(), isPositive, zdcId.channel()-1);
      vNeighborsDetId.emplace_back(zdcDetId.rawId());
      return vNeighborsDetId;
    }
    zdcDetId = HcalZDCDetId(zdcId.section(), isPositive, zdcId.channel()-1);
    vNeighborsDetId.emplace_back(zdcDetId.rawId());
    zdcDetId = HcalZDCDetId(zdcId.section(), isPositive, zdcId.channel()+1);
    vNeighborsDetId.emplace_back(zdcDetId.rawId());
  }
  return vNeighborsDetId;
}

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

overridevirtual

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

Implements CaloSubdetectorTopology.

Definition at line 245 of file ZdcTopology.cc.

References gather_cfg::cout.

{
  std::cout << "ZdcTopology::up() not yet implemented" << std::endl;
  std::vector<DetId> vNeighborsDetId;
  return  vNeighborsDetId;
}

bool ZdcTopology::valid ( const HcalZDCDetId &  id ) const

virtual

Definition at line 29 of file ZdcTopology.cc.

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

Referenced by ZdcHardcodeGeometryLoader::fill().

                                                    {
  // check the raw rules
  bool ok=validRaw(id);
  ok=ok && !isExcluded(id);
  return ok;
}

bool ZdcTopology::validRaw ( const HcalZDCDetId &  id ) const

private

Definition at line 118 of file ZdcTopology.cc.

References funct::abs(), HcalZDCDetId::EM, HcalZDCDetId::HAD, ICH_EM_MAX, ICH_HAD_MAX, ICH_LUM_MAX, ICH_RPD_MAX, HcalZDCDetId::LUM, convertSQLiteXML::ok, HcalZDCDetId::RPD, trackingPlots::section, and ecaldqm::zside().

Referenced by exclude(), longitudinal(), transverse(), and valid().

                                                      {
  bool ok = true;
  if     (abs(id.zside())!=1)
    ok = false;
  else if(id.channel() <= 0)
    ok = false;
  else if(!(id.section()== HcalZDCDetId::EM || 
        id.section()== HcalZDCDetId::HAD ||
        id.section()== HcalZDCDetId::LUM))
//      id.section()== HcalZDCDetId::LUM ||
//      id.section()== HcalZDCDetId::RPD))
    ok = false;
  else if(id.section()== HcalZDCDetId::EM && id.channel() > ICH_EM_MAX)
    ok = false;
  else if(id.section()== HcalZDCDetId::HAD && id.channel() > ICH_HAD_MAX)
    ok = false;
  else if(id.section()== HcalZDCDetId::LUM && id.channel() > ICH_LUM_MAX)
    ok = false;
  else if(id.section()== HcalZDCDetId::RPD && id.channel() > ICH_RPD_MAX)
    ok = false;
  return ok;
}

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

overridevirtual

Get the neighbors of the given cell in west direction

Implements CaloSubdetectorTopology.

Definition at line 226 of file ZdcTopology.cc.

References gather_cfg::cout.

{
  std::cout << "ZdcTopology::west() not yet implemented" << std::endl;
  std::vector<DetId> vNeighborsDetId;
  return  vNeighborsDetId;
}

Member Data Documentation

bool ZdcTopology::excludeEM_

private

Definition at line 60 of file ZdcTopology.h.

Referenced by exclude(), and isExcluded().

bool ZdcTopology::excludeHAD_

private

Definition at line 60 of file ZdcTopology.h.

Referenced by exclude(), and isExcluded().

bool ZdcTopology::excludeLUM_

private

Definition at line 60 of file ZdcTopology.h.

Referenced by exclude(), and isExcluded().

bool ZdcTopology::excludeRPD_

private

Definition at line 60 of file ZdcTopology.h.

Referenced by exclude(), and isExcluded().

bool ZdcTopology::excludeZN_

private

Definition at line 60 of file ZdcTopology.h.

Referenced by exclude().

bool ZdcTopology::excludeZP_

private

Definition at line 60 of file ZdcTopology.h.

Referenced by exclude().

std::vector<HcalZDCDetId> ZdcTopology::exclusionList_

private

Definition at line 58 of file ZdcTopology.h.

Referenced by exclude(), and isExcluded().

int ZdcTopology::firstEMModule_

private

Definition at line 62 of file ZdcTopology.h.

Referenced by firstCell(), and firstEMModule().

int ZdcTopology::firstHADModule_

private

Definition at line 62 of file ZdcTopology.h.

Referenced by firstCell(), and firstHADModule().

int ZdcTopology::firstLUMModule_

private

Definition at line 62 of file ZdcTopology.h.

Referenced by firstCell(), and firstLUMModule().

int ZdcTopology::firstRPDModule_

private

Definition at line 62 of file ZdcTopology.h.

Referenced by firstCell(), and firstRPDModule().

int ZdcTopology::lastEMModule_

private

Definition at line 62 of file ZdcTopology.h.

Referenced by lastCell(), and lastEMModule().

int ZdcTopology::lastHADModule_

private

Definition at line 62 of file ZdcTopology.h.

Referenced by lastCell(), and lastHADModule().

int ZdcTopology::lastLUMModule_

private

Definition at line 62 of file ZdcTopology.h.

Referenced by lastCell(), and lastLUMModule().

int ZdcTopology::lastRPDModule_

private

Definition at line 62 of file ZdcTopology.h.

Referenced by lastCell(), and lastRPDModule().