HGCalTopology Class Reference

#include <HGCalTopology.h>

Inheritance diagram for HGCalTopology:

Classes
struct	DecodedDetId

Public Member Functions
const HGCalDDDConstants &	dddConstants () const
DecodedDetId	decode (const DetId &id) const
virtual DetId	denseId2detId (uint32_t denseId) const
bool	detectorType () const
virtual uint32_t	detId2denseGeomId (const DetId &id) const
virtual uint32_t	detId2denseId (const DetId &id) const
	Dense indexing. More...
virtual std::vector< DetId >	down (const DetId &id) const
virtual std::vector< DetId >	east (const DetId &id) const
DetId	encode (const DecodedDetId &id_) const
DecodedDetId	geomDenseId2decId (const uint32_t &hi) const
virtual DetId	goEast (const DetId &id) const
	move the Topology east (positive ix) More...
virtual DetId	goNorth (const DetId &id) const
	move the Topology north (increment iy) More...
virtual DetId	goSouth (const DetId &id) const
	move the Topology south (decrement iy) More...
virtual DetId	goWest (const DetId &id) const
	move the Topology west (negative ix) More...
	HGCalTopology (const HGCalDDDConstants &hdcons, ForwardSubdetector subdet, bool halfChamber)
	create a new Topology More...
virtual std::vector< DetId >	north (const DetId &id) const
DetId	offsetBy (const DetId startId, int nrStepsX, int nrStepsY) const
virtual std::vector< DetId >	south (const DetId &id) const
ForwardSubdetector	subDetector () const
DetId	switchZSide (const DetId startId) const
unsigned int	totalGeomModules () const
unsigned int	totalModules () const
virtual std::vector< DetId >	up (const DetId &id) const
virtual bool	valid (const DetId &id) const
	Is this a valid cell id. More...
bool	validHashIndex (uint32_t ix) const
virtual std::vector< DetId >	west (const DetId &id) const
virtual	~HGCalTopology ()
	virtual destructor More...
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 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	goUp (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	~CaloSubdetectorTopology ()
	virtual destructor More...

Static Public Attributes
static const int	subSectors_ = 2

Private Member Functions
DetId	changeXY (const DetId &id, int nrStepsX, int nrStepsY) const
	move the nagivator along x, y More...
DetId	changeZ (const DetId &id, int nrStepsZ) const
	move the nagivator along z More...

Private Attributes
int	cells_
bool	half_
const HGCalDDDConstants &	hdcons_
int	kHGeomHalf_
int	kHGhalf_
unsigned int	kSizeForDenseIndexing
int	layers_
std::vector< int >	maxcells_
int	sectors_
ForwardSubdetector	subdet_

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 12 of file HGCalTopology.h.

Constructor & Destructor Documentation

HGCalTopology::HGCalTopology	(	const HGCalDDDConstants &	hdcons,
		ForwardSubdetector	subdet,
		bool	halfChamber
	)

create a new Topology

Definition at line 6 of file HGCalTopology.cc.

References cells_, gather_cfg::cout, half_, hdcons_, kHGeomHalf_, kHGhalf_, kSizeForDenseIndexing, HGCalDDDConstants::layers(), layers_, HGCalDDDConstants::maxCells(), HGCalDDDConstants::sectors(), sectors_, subdet_, and subSectors_.

                            : hdcons_(hdcons), subdet_(subdet),
                      half_(half) {
  sectors_  = hdcons_.sectors();
  layers_   = hdcons_.layers(true);
  cells_    = hdcons_.maxCells(true);
  kHGhalf_  = sectors_*layers_*subSectors_*cells_ ;
  kHGeomHalf_ = (half_ ? (sectors_*layers_*subSectors_) : (sectors_*layers_));
  kSizeForDenseIndexing = (unsigned int)(2*kHGhalf_);
#ifdef DebugLog
  std::cout << "HGCalTopology initialized for subdetector " << subdet_ 
        << " having half-chamber flag " << half_ << " with " << sectors_
        << " Sectors " << layers_ << " Layers " << cells_
        << " cells and total channels " << kSizeForDenseIndexing << ":"
        << (2*kHGeomHalf_) << std::endl;
#endif
}

virtual HGCalTopology::~HGCalTopology ( )

inlinevirtual

virtual destructor

Definition at line 19 of file HGCalTopology.h.

{ }  

Member Function Documentation

DetId HGCalTopology::changeXY ( const DetId &  id, int  nrStepsX, int  nrStepsY  ) const

private

move the nagivator along x, y

Definition at line 141 of file HGCalTopology.cc.

References decode(), encode(), half_, hdcons_, HGCalTopology::DecodedDetId::iCell, HGCalTopology::DecodedDetId::iLay, HGCalTopology::DecodedDetId::iSec, HGCalTopology::DecodedDetId::iSubSec, HGCalDDDConstants::newCell(), and valid().

Referenced by goEast(), goNorth(), goSouth(), goWest(), and offsetBy().

                                       {

  HGCalTopology::DecodedDetId id_ = decode(id);
  std::pair<int,int> kcell= hdcons_.newCell(id_.iCell,id_.iLay,id_.iSec,
                        id_.iSubSec,nrStepsX,nrStepsY,
                        half_);
  id_.iSubSec= kcell.second;
  id_.iSec   = (kcell.second > 0) ? kcell.second : -kcell.second;
  id_.iCell  = kcell.first;
  DetId nextPoint = encode(id_);
  if (valid(nextPoint)) return nextPoint;
  else                  return DetId(0);
}

DetId HGCalTopology::changeZ ( const DetId &  id, int  nrStepsZ  ) const

private

move the nagivator along z

Definition at line 157 of file HGCalTopology.cc.

References decode(), encode(), half_, hdcons_, HGCalTopology::DecodedDetId::iCell, HGCalTopology::DecodedDetId::iLay, HGCalTopology::DecodedDetId::iSubSec, HGCalDDDConstants::newCell(), and valid().

Referenced by down(), and up().

                                                                {

  HGCalTopology::DecodedDetId id_  = decode(id);
  std::pair<int,int> kcell = hdcons_.newCell(id_.iCell,id_.iLay,
                         id_.iSubSec,nrStepsZ,half_);
  id_.iLay    = kcell.second;
  id_.iCell   = kcell.first;
  DetId nextPoint = encode(id_);
  if (valid(nextPoint)) return nextPoint;
  else                  return DetId(0);
}

const HGCalDDDConstants& HGCalTopology::dddConstants ( ) const

inline

Definition at line 97 of file HGCalTopology.h.

References hdcons_.

Referenced by HGCDigitizer::accumulate(), HGCalGeometryLoader::build(), HGCalGeometry::getClosestCell(), HGCalGeometry::getCorners(), HGCalGeometry::getPosition(), and HGCalGeometry::newCell().

{return hdcons_;}

HGCalTopology::DecodedDetId HGCalTopology::decode

(

const DetId &

id

)

const

Definition at line 106 of file HGCalTopology.cc.

References HGCEE, HGCalTopology::DecodedDetId::iCell, HGCalTopology::DecodedDetId::iLay, HGCalTopology::DecodedDetId::iSec, HGCalTopology::DecodedDetId::iSubSec, HGCalTopology::DecodedDetId::subdet, subdet_, and HGCalTopology::DecodedDetId::zside.

Referenced by changeXY(), changeZ(), detId2denseGeomId(), detId2denseId(), HGCalGeometry::getClosestCell(), HGCalGeometry::getCorners(), HGCalGeometry::getPosition(), HGCalGeometry::newCell(), switchZSide(), and valid().

                                                                          {

  HGCalTopology::DecodedDetId id_;
  if (subdet_ == HGCEE) {
    HGCEEDetId id(startId);
    id_.iCell  = id.cell();
    id_.iLay   = id.layer();
    id_.iSec   = id.sector();
    id_.iSubSec= id.subsector();
    id_.zside  = id.zside();
    id_.subdet = id.subdetId();
  } else {
    HGCHEDetId id(startId);
    id_.iCell  = id.cell();
    id_.iLay   = id.layer();
    id_.iSec   = id.sector();
    id_.iSubSec= id.subsector();
    id_.zside  = id.zside();
    id_.subdet = id.subdetId();
  }
  return id_;
}

DetId HGCalTopology::denseId2detId ( uint32_t  denseId ) const

virtual

Definition at line 35 of file HGCalTopology.cc.

References encode(), HGCalTopology::DecodedDetId::iCell, HGCalTopology::DecodedDetId::iLay, HGCalTopology::DecodedDetId::iSec, HGCalTopology::DecodedDetId::iSubSec, kHGhalf_, layers_, sectors_, subSectors_, validHashIndex(), and HGCalTopology::DecodedDetId::zside.

                                                    {

  if (validHashIndex(hi)) {
    HGCalTopology::DecodedDetId id_;
    id_.zside  = ((int)(hi)<kHGhalf_ ? -1 : 1);
    int di     = ((int)(hi)%kHGhalf_);
    int iSubSec= (di%subSectors_);
    id_.iSubSec= (iSubSec == 0 ? -1 : 1);
    id_.iSec   = (((di-iSubSec)/subSectors_)%sectors_+1);
    id_.iLay   = (((((di-iSubSec)/subSectors_)-id_.iSec+1)/sectors_)%layers_+1);
    id_.iCell  = (((((di-iSubSec)/subSectors_)-id_.iSec+1)/sectors_-id_.iLay+1)/layers_+1);
    return encode(id_);
  } else {
    return DetId(0);
  }
}

bool HGCalTopology::detectorType ( ) const

inline

Definition at line 117 of file HGCalTopology.h.

References half_.

Referenced by HGCDigitizer::accumulate(), HGCalGeometryLoader::build(), and HGCalGeometry::HGCalGeometry().

{ return half_;}

uint32_t HGCalTopology::detId2denseGeomId ( const DetId &  id ) const

virtual

Definition at line 52 of file HGCalTopology.cc.

References decode(), half_, customizeTrackingMonitorSeedNumber::idx, HGCalTopology::DecodedDetId::iLay, HGCalTopology::DecodedDetId::iSec, HGCalTopology::DecodedDetId::iSubSec, kHGeomHalf_, layers_, sectors_, and HGCalTopology::DecodedDetId::zside.

Referenced by HGCalGeometry::indexFor().

                                                               {

  HGCalTopology::DecodedDetId id_ = decode(id);
  int isubsec= (half_ && id_.iSubSec > 0) ? 1 : 0;
  uint32_t idx = (uint32_t)(((id_.zside > 0) ? kHGeomHalf_ : 0) +
                ((isubsec*layers_+id_.iLay-1)*sectors_+
                 id_.iSec-1));
  return idx;
}

uint32_t HGCalTopology::detId2denseId ( const DetId &  id ) const

virtual

Dense indexing.

Reimplemented from CaloSubdetectorTopology.

Definition at line 25 of file HGCalTopology.cc.

References decode(), HGCalTopology::DecodedDetId::iCell, customizeTrackingMonitorSeedNumber::idx, HGCalTopology::DecodedDetId::iLay, HGCalTopology::DecodedDetId::iSec, HGCalTopology::DecodedDetId::iSubSec, kHGhalf_, layers_, sectors_, subSectors_, and HGCalTopology::DecodedDetId::zside.

                                                           {

  HGCalTopology::DecodedDetId id_ = decode(id);
  int isubsec= (id_.iSubSec > 0) ? 1 : 0;
  uint32_t idx = (uint32_t)((((id_.zside > 0) ? kHGhalf_ : 0) +
                 ((((id_.iCell-1)*layers_+id_.iLay-1)*sectors_+
                   id_.iSec-1)*subSectors_+isubsec)));
  return idx;
}

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

inlinevirtual

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

Implements CaloSubdetectorTopology.

Definition at line 77 of file HGCalTopology.h.

References changeZ(), and DetId::rawId().

                                                       {
    DetId nextId=changeZ(id,-1);
    std::vector<DetId> vNeighborsDetId;
    if (! (nextId==DetId(0)))
      vNeighborsDetId.push_back(DetId(nextId.rawId()));
    return vNeighborsDetId;
  }

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

inlinevirtual

Get the neighbors of the given cell in east direction

Implements CaloSubdetectorTopology.

Definition at line 49 of file HGCalTopology.h.

References goEast(), and DetId::rawId().

                                                       { 
    DetId nextId=goEast(id);
    std::vector<DetId> vNeighborsDetId;
    if (! (nextId==DetId(0)))
      vNeighborsDetId.push_back(DetId(nextId.rawId()));
    return vNeighborsDetId;
  }

DetId HGCalTopology::encode

(

const DecodedDetId &

id_

)

const

Definition at line 129 of file HGCalTopology.cc.

References HGCEE, HGCalTopology::DecodedDetId::iCell, HGCalTopology::DecodedDetId::iLay, HGCalTopology::DecodedDetId::iSec, HGCalTopology::DecodedDetId::iSubSec, DetId::rawId(), subdet_, and HGCalTopology::DecodedDetId::zside.

Referenced by changeXY(), changeZ(), denseId2detId(), HGCalGeometry::getClosestCell(), HGCalGeometry::newCell(), and switchZSide().

                                                                      {

  int isubsec= (id_.iSubSec > 0) ? 1 : 0;
  DetId id;
  if (subdet_ == HGCEE) {
    id = HGCEEDetId(subdet_,id_.zside,id_.iLay,id_.iSec,isubsec,id_.iCell).rawId();
  } else {
    id = HGCHEDetId(subdet_,id_.zside,id_.iLay,id_.iSec,isubsec,id_.iCell).rawId();
  }
  return id;
}

HGCalTopology::DecodedDetId HGCalTopology::geomDenseId2decId

(

const uint32_t &

hi

)

const

Definition at line 92 of file HGCalTopology.cc.

References HGCalTopology::DecodedDetId::iLay, HGCalTopology::DecodedDetId::iSec, HGCalTopology::DecodedDetId::iSubSec, kHGeomHalf_, layers_, sectors_, subSectors_, totalGeomModules(), and HGCalTopology::DecodedDetId::zside.

                                                                                   {

  HGCalTopology::DecodedDetId id_;
  if (hi < totalGeomModules()) {
    id_.zside  = ((int)(hi)<kHGeomHalf_ ? -1 : 1);
    int di     = ((int)(hi)%kHGeomHalf_);
    int iSubSec= (di%subSectors_);
    id_.iSubSec= (iSubSec == 0 ? -1 : 1);
    id_.iSec   = (((di-iSubSec)/subSectors_)%sectors_+1);
    id_.iLay   = (((((di-iSubSec)/subSectors_)-id_.iSec+1)/sectors_)%layers_+1);
  }
  return id_;
}

virtual DetId HGCalTopology::goEast ( const DetId &  id ) const

inlinevirtual

move the Topology east (positive ix)

Reimplemented from CaloSubdetectorTopology.

Definition at line 46 of file HGCalTopology.h.

References changeXY().

Referenced by east().

                                               {
    return changeXY(id,+1,0);
  }

virtual DetId HGCalTopology::goNorth ( const DetId &  id ) const

inlinevirtual

move the Topology north (increment iy)

Reimplemented from CaloSubdetectorTopology.

Definition at line 22 of file HGCalTopology.h.

References changeXY().

Referenced by north().

                                                {
    return changeXY(id,0,+1);
  }

virtual DetId HGCalTopology::goSouth ( const DetId &  id ) const

inlinevirtual

move the Topology south (decrement iy)

Reimplemented from CaloSubdetectorTopology.

Definition at line 34 of file HGCalTopology.h.

References changeXY().

Referenced by south().

                                               {
    return changeXY(id,0,-1);
  }

virtual DetId HGCalTopology::goWest ( const DetId &  id ) const

inlinevirtual

move the Topology west (negative ix)

Reimplemented from CaloSubdetectorTopology.

Definition at line 58 of file HGCalTopology.h.

References changeXY().

Referenced by west().

                                              {
    return changeXY(id,-1,0);
  }

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

inlinevirtual

Get the neighbors of the given cell in north direction

Implements CaloSubdetectorTopology.

Definition at line 25 of file HGCalTopology.h.

References goNorth(), and DetId::rawId().

                                                        { 
    DetId nextId= goNorth(id);
    std::vector<DetId> vNeighborsDetId;
    if (! (nextId==DetId(0)))
      vNeighborsDetId.push_back(DetId(nextId.rawId()));
    return vNeighborsDetId;
  }

DetId HGCalTopology::offsetBy	(	const DetId	startId,
		int	nrStepsX,
		int	nrStepsY
	)		const

returns a new DetId offset by nrStepsX and nrStepsY (can be negative), returns DetId(0) if invalid

Definition at line 71 of file HGCalTopology.cc.

References changeXY(), DetId::det(), DetId::Forward, subdet_, DetId::subdetId(), and valid().

                                       {

  if (startId.det() == DetId::Forward && startId.subdetId() == (int)(subdet_)){
    DetId id = changeXY(startId,nrStepsX,nrStepsY);
    if (valid(id)) return id.rawId();
  }
  return DetId(0);
}

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

inlinevirtual

Get the neighbors of the given cell in south direction

Implements CaloSubdetectorTopology.

Definition at line 37 of file HGCalTopology.h.

References goSouth(), and DetId::rawId().

                                                        { 
    DetId nextId= goSouth(id);
    std::vector<DetId> vNeighborsDetId;
    if (! (nextId==DetId(0)))
      vNeighborsDetId.push_back(DetId(nextId.rawId()));
    return vNeighborsDetId;
  }

ForwardSubdetector HGCalTopology::subDetector ( ) const

inline

Definition at line 116 of file HGCalTopology.h.

References subdet_.

Referenced by HGCalGeometryLoader::build(), and HGCalGeometry::HGCalGeometry().

{ return subdet_;}

DetId HGCalTopology::switchZSide

(

const DetId

startId

)

const

Definition at line 81 of file HGCalTopology.cc.

References decode(), DetId::det(), encode(), DetId::Forward, subdet_, DetId::subdetId(), valid(), and HGCalTopology::DecodedDetId::zside.

                                                          {

  if (startId.det() == DetId::Forward && startId.subdetId() == (int)(subdet_)){
    HGCalTopology::DecodedDetId id_ = decode(startId);
    id_.zside  =-id_.zside;
    DetId id   = encode(id_);
    if (valid(id)) return id.rawId();
  }
  return DetId(0);
}

unsigned int HGCalTopology::totalGeomModules ( ) const

inline

Definition at line 95 of file HGCalTopology.h.

References kHGeomHalf_.

Referenced by HGCalGeometryLoader::build(), geomDenseId2decId(), HGCalGeometry::HGCalGeometry(), and HGCalGeometry::sizeForDenseIndex().

{return (unsigned int)(2*kHGeomHalf_);}

unsigned int HGCalTopology::totalModules ( ) const

inline

Definition at line 94 of file HGCalTopology.h.

References kSizeForDenseIndexing.

{return kSizeForDenseIndexing;}

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

inlinevirtual

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

Implements CaloSubdetectorTopology.

Definition at line 69 of file HGCalTopology.h.

References changeZ(), and DetId::rawId().

                                                     {
    DetId nextId=changeZ(id,+1);
    std::vector<DetId> vNeighborsDetId;
    if (! (nextId==DetId(0)))
      vNeighborsDetId.push_back(DetId(nextId.rawId()));
    return vNeighborsDetId;
  }

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

virtual

Is this a valid cell id.

Reimplemented from CaloSubdetectorTopology.

Definition at line 62 of file HGCalTopology.cc.

References cells_, decode(), DetId::Forward, HGCalTopology::DecodedDetId::iCell, HGCalTopology::DecodedDetId::iLay, HGCalTopology::DecodedDetId::iSec, layers_, sectors_, and subdet_.

Referenced by changeXY(), changeZ(), offsetBy(), and switchZSide().

                                               {

  HGCalTopology::DecodedDetId id_ = decode(id);
  bool flag = (id.det() == DetId::Forward && id.subdetId() == (int)(subdet_) &&
           id_.iCell >= 0 && id_.iCell < cells_ && id_.iLay > 0 && 
           id_.iLay <= layers_ && id_.iSec > 0 && id_.iSec <= sectors_);
  return flag;
}

bool HGCalTopology::validHashIndex ( uint32_t  ix ) const

inline

Definition at line 92 of file HGCalTopology.h.

References kSizeForDenseIndexing.

Referenced by denseId2detId().

{return (ix < kSizeForDenseIndexing);}

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

inlinevirtual

Get the neighbors of the given cell in west direction

Implements CaloSubdetectorTopology.

Definition at line 61 of file HGCalTopology.h.

References goWest(), and DetId::rawId().

                                                       { 
    DetId nextId=goWest(id);
    std::vector<DetId> vNeighborsDetId;
    if (! (nextId==DetId(0)))
      vNeighborsDetId.push_back(DetId(nextId.rawId()));
    return vNeighborsDetId;
  }

Member Data Documentation

int HGCalTopology::cells_

private

Definition at line 129 of file HGCalTopology.h.

Referenced by HGCalTopology(), and valid().

bool HGCalTopology::half_

private

Definition at line 128 of file HGCalTopology.h.

Referenced by changeXY(), changeZ(), detectorType(), detId2denseGeomId(), and HGCalTopology().

const HGCalDDDConstants& HGCalTopology::hdcons_

private

Definition at line 126 of file HGCalTopology.h.

Referenced by changeXY(), changeZ(), dddConstants(), and HGCalTopology().

int HGCalTopology::kHGeomHalf_

private

Definition at line 129 of file HGCalTopology.h.

Referenced by detId2denseGeomId(), geomDenseId2decId(), HGCalTopology(), and totalGeomModules().

int HGCalTopology::kHGhalf_

private

Definition at line 129 of file HGCalTopology.h.

Referenced by denseId2detId(), detId2denseId(), and HGCalTopology().

unsigned int HGCalTopology::kSizeForDenseIndexing

private

Definition at line 131 of file HGCalTopology.h.

Referenced by HGCalTopology(), totalModules(), and validHashIndex().

int HGCalTopology::layers_

private

Definition at line 129 of file HGCalTopology.h.

Referenced by denseId2detId(), detId2denseGeomId(), detId2denseId(), geomDenseId2decId(), HGCalTopology(), and valid().

std::vector<int> HGCalTopology::maxcells_

private

Definition at line 130 of file HGCalTopology.h.

int HGCalTopology::sectors_

private

Definition at line 129 of file HGCalTopology.h.

Referenced by denseId2detId(), detId2denseGeomId(), detId2denseId(), geomDenseId2decId(), HGCalTopology(), and valid().

ForwardSubdetector HGCalTopology::subdet_

private

Definition at line 127 of file HGCalTopology.h.

Referenced by decode(), encode(), HGCalTopology(), offsetBy(), subDetector(), switchZSide(), and valid().

const int HGCalTopology::subSectors_ = 2

static

Definition at line 104 of file HGCalTopology.h.

Referenced by denseId2detId(), detId2denseId(), geomDenseId2decId(), and HGCalTopology().