CaloSubdetectorTopology Class Reference

#include <CaloSubdetectorTopology.h>

Inheritance diagram for CaloSubdetectorTopology:

Classes
struct	CellInfo

Public Member Functions
	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 >	down (const DetId &id) const =0
virtual std::vector< DetId >	east (const DetId &id) const =0
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 std::vector< DetId >	north (const DetId &id) const =0
virtual std::vector< DetId >	south (const DetId &id) const =0
virtual int	topoVersion () const
	return a version which identifies the given topology More...
virtual std::vector< DetId >	up (const DetId &id) const =0
virtual bool	valid (const DetId &) const
	is this detid present in the Topology? More...
virtual std::vector< DetId >	west (const DetId &id) const =0
virtual	~CaloSubdetectorTopology ()
	virtual destructor More...

Protected Types
typedef std::pair< int, int >	Coordinate

Protected Member Functions
Coordinate	getNeighbourIndex (const Coordinate &coord, const CaloDirection &dir) const

Detailed Description

Revision

1.7

Author

P.Meridiani INFN Roma1

J. Mans - Minnesota

Definition at line 17 of file CaloSubdetectorTopology.h.

Member Typedef Documentation

Coordinate

typedef std::pair<int, int> CaloSubdetectorTopology::Coordinate

protected

Definition at line 108 of file CaloSubdetectorTopology.h.

Constructor & Destructor Documentation

CaloSubdetectorTopology()

CaloSubdetectorTopology::CaloSubdetectorTopology ( )

inline

standard constructor

Definition at line 20 of file CaloSubdetectorTopology.h.

{};

~CaloSubdetectorTopology()

virtual CaloSubdetectorTopology::~CaloSubdetectorTopology ( )

inlinevirtual

virtual destructor

Definition at line 22 of file CaloSubdetectorTopology.h.

{}

Member Function Documentation

denseId2detId()

virtual DetId CaloSubdetectorTopology::denseId2detId ( unsigned int  ) const

inlinevirtual

return a linear packed id

Reimplemented in HcalTopology.

Definition at line 28 of file CaloSubdetectorTopology.h.

{ return DetId(0); }

denseIdConsistent()

virtual bool CaloSubdetectorTopology::denseIdConsistent ( int  topoVer ) const

inlinevirtual

return whether this topology is consistent with the numbering in the given topology

Definition at line 34 of file CaloSubdetectorTopology.h.

References topoVersion().

Referenced by HcalCondObjectContainerBase::setTopo().

{ return topoVer == topoVersion(); }

detId2denseId()

virtual unsigned int CaloSubdetectorTopology::detId2denseId ( const DetId &  ) const

inlinevirtual

return a linear packed id

Reimplemented in HGCalTBTopology, HGCalTopology, and HcalTopology.

Definition at line 26 of file CaloSubdetectorTopology.h.

{ return 0; }

down()

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

pure virtual

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

Implemented in HcalTopology, EcalBarrelTopology, EcalEndcapTopology, EcalPreshowerTopology, HGCalTBTopology, HGCalTopology, EcalBarrelHardcodedTopology, EcalEndcapHardcodedTopology, CastorTopology, ZdcTopology, and CaloTowerTopology.

Referenced by CaloTopology::down(), and goDown().

east()

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

pure virtual

Get the neighbors of the given cell in east direction

Implemented in HcalTopology, EcalBarrelTopology, EcalEndcapTopology, CastorTopology, HGCalTBTopology, HGCalTopology, EcalPreshowerTopology, EcalBarrelHardcodedTopology, EcalEndcapHardcodedTopology, ZdcTopology, and CaloTowerTopology.

Referenced by CaloTopology::east(), getNeighbours(), and goEast().

getAllNeighbours()

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

inlinevirtual

Get all the neighbors of the given cell

Definition at line 105 of file CaloSubdetectorTopology.h.

References getWindow().

Referenced by CaloTopology::getAllNeighbours().

{ return getWindow(id, 3, 3); }

getNeighbourIndex()

Coordinate CaloSubdetectorTopology::getNeighbourIndex ( const Coordinate &  coord, const CaloDirection &  dir  ) const

inlineprotected

Definition at line 120 of file CaloSubdetectorTopology.h.

References DeadROC_duringRun::dir, EAST, Exception, NORTH, SOUTH, and WEST.

Referenced by getWindow().

                                                                                               {
    switch (dir) {
      case NORTH:
        return Coordinate(coord.first, coord.second + 1);
      case SOUTH:
        return Coordinate(coord.first, coord.second - 1);

      case EAST:
        return Coordinate(coord.first + 1, coord.second);
      case WEST:
        return Coordinate(coord.first - 1, coord.second);

      default:
        throw cms::Exception("getWindowError") << "Unsopported direction";
    }
  }

getNeighbours()

virtual std::vector<DetId> CaloSubdetectorTopology::getNeighbours ( const DetId &  id, const CaloDirection &  dir  ) const

inlinevirtual

Get the neighbors of the given cell given direction

Definition at line 77 of file CaloSubdetectorTopology.h.

References DeadROC_duringRun::dir, EAST, east(), Exception, NONE, NORTH, north(), SOUTH, south(), WEST, and west().

Referenced by CaloTopology::getNeighbours(), getWindow(), CaloGeometryHelper::simplemove(), spr::simpleMove(), and PFECALHashNavigator::stdsimplemove().

                                                                                          {
    std::vector<DetId> aNullVector;
    switch (dir) {
      case NONE:
        return aNullVector;
        break;
      case SOUTH:
        return south(id);
        break;
      case NORTH:
        return north(id);
        break;
      case EAST:
        return east(id);
        break;
      case WEST:
        return west(id);
        break;
      default:
        throw cms::Exception("getNeighboursError") << "Unsopported direction";
    }
    return aNullVector;
  }

getWindow()

std::vector< DetId > CaloSubdetectorTopology::getWindow ( const DetId &  id, const int &  northSouthSize, const int &  eastWestSize  ) const

virtual

Get the neighbors of the given cell in a window of given size

Definition at line 4 of file CaloSubdetectorTopology.cc.

References cms::cuda::assert(), EAST, Exception, getNeighbourIndex(), getNeighbours(), NORTH, SOUTH, class-composition::visited, and WEST.

Referenced by DQMSourcePi0::analyze(), ElectronCalibrationUniv::analyze(), CaloGeometryHelper::buildNeighbourArray(), HLTEcalResonanceFilter::calcShowerShape(), HLTRegionalEcalResonanceFilter::calcShowerShape(), PFECALHashNavigator::ecalNeighbArray(), HLTEcalResonanceFilter::filter(), HLTRegionalEcalResonanceFilter::filter(), getAllNeighbours(), CaloTopology::getWindow(), ReducedEGProducer::linkCaloClusters(), PiZeroAnalyzer::makePizero(), InterestingEcalDetIdProducer::produce(), InterestingTrackEcalDetIdProducer::produce(), pat::PATPhotonProducer::produce(), InterestingDetIdFromSuperClusterProducer::produce(), InterestingDetIdCollectionProducer::produce(), pat::PATElectronProducer::produce(), and ecaldqm::PiZeroTask::runOnEBRecHits().

                                                                                     {
  std::vector<DetId> cellsInWindow;
  // check pivot
  if (id.null())
    return cellsInWindow;

  //
  DetId myTmpId(id);
  std::vector<std::pair<Coordinate, DetId> > fringe;
  fringe.emplace_back(std::pair<Coordinate, DetId>(Coordinate(0, 0), myTmpId));

  int halfWestEast = eastWestSize / 2;
  int halfNorthSouth = northSouthSize / 2;

  std::vector<CellInfo> visited_cells;
  visited_cells.resize(northSouthSize * eastWestSize);

  while (!fringe.empty()) {
    std::pair<Coordinate, DetId> cur = fringe.back();
    fringe.pop_back();

    // check all four neighbours
    const CaloDirection directions[4] = {NORTH, SOUTH, EAST, WEST};

    for (auto direction : directions) {
      Coordinate neighbour = getNeighbourIndex(cur.first, direction);
      //If outside the window range
      if (neighbour.first < -halfWestEast || neighbour.first > halfWestEast || neighbour.second < -halfNorthSouth ||
          neighbour.second > halfNorthSouth)
        continue;

      //Found integer index in the matrix
      unsigned int_index = neighbour.first + halfWestEast + eastWestSize * (neighbour.second + halfNorthSouth);
      assert(int_index < visited_cells.size());

      // check whether we have seen this neighbour already
      if (visited_cells[int_index].visited)
        // we have seen this one already
        continue;

      // a new cell, get the DetId of the neighbour, mark it
      // as visited and add it to the fringe
      visited_cells[int_index].visited = true;
      std::vector<DetId> neighbourCells = getNeighbours(cur.second, direction);

      if (neighbourCells.size() == 1)
        visited_cells[int_index].cell = neighbourCells[0];
      else if (neighbourCells.empty())
        visited_cells[int_index].cell = DetId(0);
      else
        throw cms::Exception("getWindowError") << "Not supported subdetector for getWindow method";

      if (!visited_cells[int_index].cell.null())
        fringe.emplace_back(std::pair<Coordinate, DetId>(neighbour, visited_cells[int_index].cell));

    }  // loop over all possible directions
  }    // while some cells are left on the fringe

  for (auto& visited_cell : visited_cells)
    if (!visited_cell.cell.null())
      cellsInWindow.emplace_back(visited_cell.cell);

  return cellsInWindow;
}

goDown()

virtual DetId CaloSubdetectorTopology::goDown ( const DetId &  id ) const

inlinevirtual

Reimplemented in EcalPreshowerTopology.

Definition at line 71 of file CaloSubdetectorTopology.h.

References down().

                                              {
    std::vector<DetId> ids = down(id);
    return ids.empty() ? DetId() : ids[0];
  }

goEast()

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

inlinevirtual

Reimplemented in EcalBarrelTopology, EcalEndcapTopology, HGCalTBTopology, HGCalTopology, EcalPreshowerTopology, EcalBarrelHardcodedTopology, and EcalEndcapHardcodedTopology.

Definition at line 51 of file CaloSubdetectorTopology.h.

References east().

Referenced by offsetBy().

                                              {
    std::vector<DetId> ids = east(id);
    return ids.empty() ? DetId() : ids[0];
  }

goNorth()

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

inlinevirtual

Reimplemented in EcalBarrelTopology, EcalEndcapTopology, HGCalTBTopology, HGCalTopology, EcalPreshowerTopology, EcalBarrelHardcodedTopology, and EcalEndcapHardcodedTopology.

Definition at line 59 of file CaloSubdetectorTopology.h.

References north().

Referenced by offsetBy().

                                               {
    std::vector<DetId> ids = north(id);
    return ids.empty() ? DetId() : ids[0];
  }

goSouth()

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

inlinevirtual

Reimplemented in EcalBarrelTopology, EcalEndcapTopology, HGCalTBTopology, HGCalTopology, EcalPreshowerTopology, EcalBarrelHardcodedTopology, and EcalEndcapHardcodedTopology.

Definition at line 63 of file CaloSubdetectorTopology.h.

References south().

Referenced by offsetBy().

                                               {
    std::vector<DetId> ids = south(id);
    return ids.empty() ? DetId() : ids[0];
  }

goUp()

virtual DetId CaloSubdetectorTopology::goUp ( const DetId &  id ) const

inlinevirtual

Reimplemented in EcalPreshowerTopology.

Definition at line 67 of file CaloSubdetectorTopology.h.

References up().

                                            {
    std::vector<DetId> ids = up(id);
    return ids.empty() ? DetId() : ids[0];
  }

goWest()

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

inlinevirtual

Reimplemented in EcalBarrelTopology, EcalEndcapTopology, HGCalTBTopology, HGCalTopology, EcalPreshowerTopology, EcalBarrelHardcodedTopology, and EcalEndcapHardcodedTopology.

Definition at line 55 of file CaloSubdetectorTopology.h.

References west().

Referenced by offsetBy().

                                              {
    std::vector<DetId> ids = west(id);
    return ids.empty() ? DetId() : ids[0];
  }

ncells()

virtual unsigned int CaloSubdetectorTopology::ncells ( ) const

inlinevirtual

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

Reimplemented in HcalTopology.

Definition at line 30 of file CaloSubdetectorTopology.h.

Referenced by ZdcTopology::ncells(), and CastorTopology::ncells().

{ return 1; }

north()

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

pure virtual

Get the neighbors of the given cell in north direction

Implemented in HcalTopology, CastorTopology, ZdcTopology, EcalBarrelTopology, EcalEndcapTopology, CaloTowerTopology, HGCalTBTopology, HGCalTopology, EcalPreshowerTopology, EcalBarrelHardcodedTopology, and EcalEndcapHardcodedTopology.

Referenced by getNeighbours(), goNorth(), and CaloTopology::north().

south()

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

pure virtual

Get the neighbors of the given cell in south direction

Implemented in HcalTopology, CastorTopology, ZdcTopology, EcalBarrelTopology, EcalEndcapTopology, HGCalTBTopology, HGCalTopology, EcalPreshowerTopology, CaloTowerTopology, EcalBarrelHardcodedTopology, and EcalEndcapHardcodedTopology.

Referenced by getNeighbours(), goSouth(), and CaloTopology::south().

topoVersion()

virtual int CaloSubdetectorTopology::topoVersion ( ) const

inlinevirtual

return a version which identifies the given topology

Reimplemented in HcalTopology.

Definition at line 32 of file CaloSubdetectorTopology.h.

Referenced by denseIdConsistent().

{ return 0; }

up()

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

pure virtual

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

Implemented in HcalTopology, EcalBarrelTopology, EcalEndcapTopology, EcalPreshowerTopology, HGCalTBTopology, HGCalTopology, EcalBarrelHardcodedTopology, EcalEndcapHardcodedTopology, CastorTopology, ZdcTopology, and CaloTowerTopology.

Referenced by goUp(), and CaloTopology::up().

valid()

virtual bool CaloSubdetectorTopology::valid ( const DetId &  ) const

inlinevirtual

is this detid present in the Topology?

Reimplemented in HGCalTBTopology, HGCalTopology, HcalTopology, and CaloTowerTopology.

Definition at line 24 of file CaloSubdetectorTopology.h.

{ return false; };

west()

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

pure virtual

Get the neighbors of the given cell in west direction

Implemented in HcalTopology, EcalBarrelTopology, EcalEndcapTopology, HGCalTBTopology, HGCalTopology, EcalPreshowerTopology, EcalBarrelHardcodedTopology, EcalEndcapHardcodedTopology, CastorTopology, ZdcTopology, and CaloTowerTopology.

Referenced by getNeighbours(), goWest(), and CaloTopology::west().