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 20 of file CaloSubdetectorTopology.h.

Member Typedef Documentation

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

protected

Definition at line 117 of file CaloSubdetectorTopology.h.

Constructor & Destructor Documentation

CaloSubdetectorTopology::CaloSubdetectorTopology ( )

inline

standard constructor

Definition at line 23 of file CaloSubdetectorTopology.h.

{};

virtual CaloSubdetectorTopology::~CaloSubdetectorTopology ( )

inlinevirtual

virtual destructor

Definition at line 25 of file CaloSubdetectorTopology.h.

{ }

Member Function Documentation

virtual DetId CaloSubdetectorTopology::denseId2detId ( unsigned int  ) const

inlinevirtual

return a linear packed id

Reimplemented in HcalTopology.

Definition at line 31 of file CaloSubdetectorTopology.h.

{ return DetId(0); }

virtual bool CaloSubdetectorTopology::denseIdConsistent ( int  topoVer ) const

inlinevirtual

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

Definition at line 37 of file CaloSubdetectorTopology.h.

References topoVersion().

Referenced by HcalCondObjectContainerBase::setTopo().

{ return topoVer==topoVersion(); }

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

inlinevirtual

return a linear packed id

Reimplemented in HcalTopology.

Definition at line 29 of file CaloSubdetectorTopology.h.

{ return 0; }

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 GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, HcalTopology, CastorTopology, ZdcTopology, and GCC11_FINAL< T, TOPO >.

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

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

pure virtual

Get the neighbors of the given cell in east direction

Implemented in GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, HcalTopology, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, CastorTopology, ZdcTopology, and GCC11_FINAL< T, TOPO >.

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

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

inlinevirtual

Get all the neighbors of the given cell

Definition at line 111 of file CaloSubdetectorTopology.h.

References getWindow().

Referenced by CaloTopology::getAllNeighbours().

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

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

inlineprotected

Definition at line 137 of file CaloSubdetectorTopology.h.

References EAST, edm::hlt::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";
        }
    }

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 81 of file CaloSubdetectorTopology.h.

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

Referenced by CaloTopology::getNeighbours(), getWindow(), spr::simpleMove(), CaloGeometryHelper::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;
    }

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 EAST, edm::hlt::Exception, getNeighbourIndex(), getNeighbours(), i, NORTH, SOUTH, and WEST.

Referenced by HLTAlCaMonPi0::analyze(), DQMSourcePi0::analyze(), HLTAlCa::analyze(), CaloGeometryHelper::buildNeighbourArray(), HLTEcalResonanceFilter::calcShowerShape(), PFECALHashNavigator::ecalNeighbArray(), HLTEcalResonanceFilter::filter(), getAllNeighbours(), BetaCalculatorECAL::getDetailedTrackLengthInXtals(), CaloTopology::getWindow(), EgammaHLTNxNClusterProducer::makeNxNClusters(), EcalDeadChannelRecoveryNN< EEDetId >::makeNxNMatrice_RelDC(), EcalDeadChannelRecoveryNN< EBDetId >::makeNxNMatrice_RelDC(), PiZeroAnalyzer::makePizero(), InterestingEcalDetIdProducer::produce(), InterestingDetIdCollectionProducer::produce(), InterestingDetIdFromSuperClusterProducer::produce(), ReducedEGProducer::produce(), InterestingTrackEcalDetIdProducer::produce(), pat::PATPhotonProducer::produce(), pat::PATElectronProducer::produce(), HighPtTrackEcalDetIdProducer::produce(), and SingleEleCalibSelector::select().

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

  //
  DetId myTmpId(id);
  std::vector<std::pair<Coordinate,DetId> > fringe;
  fringe.push_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.size() > 0)
    {
      std::pair<Coordinate,DetId> cur = fringe.back();
      fringe.pop_back();
      
      // check all four neighbours
      const CaloDirection directions[4] = { NORTH, SOUTH, EAST, WEST };
      
      for (unsigned dirnum = 0; dirnum < 4; ++dirnum)
        {
          Coordinate neighbour = getNeighbourIndex(cur.first,directions[dirnum]);
      //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,directions[dirnum]);

      if ( neighbourCells.size() == 1 )
        visited_cells[int_index].cell = neighbourCells[0];
      else if ( neighbourCells.size() == 0 )
        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.push_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 (unsigned int i=0; i<visited_cells.size(); i++)
    if (!visited_cells[i].cell.null())
      cellsInWindow.push_back(visited_cells[i].cell);
  
  return cellsInWindow;
}

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

inlinevirtual

Reimplemented in GCC11_FINAL< T, TOPO >.

Definition at line 74 of file CaloSubdetectorTopology.h.

References down().

Referenced by GCC11_FINAL< T, TOPO >::down().

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

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

inlinevirtual

Reimplemented in GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, and GCC11_FINAL< T, TOPO >.

Definition at line 54 of file CaloSubdetectorTopology.h.

References east().

Referenced by GCC11_FINAL< T, TOPO >::east().

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

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

inlinevirtual

Reimplemented in GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, and GCC11_FINAL< T, TOPO >.

Definition at line 62 of file CaloSubdetectorTopology.h.

References north().

Referenced by GCC11_FINAL< T, TOPO >::north().

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

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

inlinevirtual

Reimplemented in GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, and GCC11_FINAL< T, TOPO >.

Definition at line 66 of file CaloSubdetectorTopology.h.

References south().

Referenced by GCC11_FINAL< T, TOPO >::south().

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

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

inlinevirtual

Reimplemented in GCC11_FINAL< T, TOPO >.

Definition at line 70 of file CaloSubdetectorTopology.h.

References up().

Referenced by GCC11_FINAL< T, TOPO >::up().

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

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

inlinevirtual

Reimplemented in GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, and GCC11_FINAL< T, TOPO >.

Definition at line 58 of file CaloSubdetectorTopology.h.

References west().

Referenced by GCC11_FINAL< T, TOPO >::west().

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

virtual unsigned int CaloSubdetectorTopology::ncells ( ) const

inlinevirtual

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

Reimplemented in HcalTopology.

Definition at line 33 of file CaloSubdetectorTopology.h.

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

{ return 1; }

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, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, and GCC11_FINAL< T, TOPO >.

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

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, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, CastorTopology, ZdcTopology, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, and GCC11_FINAL< T, TOPO >.

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

virtual int CaloSubdetectorTopology::topoVersion ( ) const

inlinevirtual

return a version which identifies the given topology

Reimplemented in HcalTopology.

Definition at line 35 of file CaloSubdetectorTopology.h.

Referenced by denseIdConsistent().

{ return 0; }

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 GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, HcalTopology, CastorTopology, ZdcTopology, and GCC11_FINAL< T, TOPO >.

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

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

inlinevirtual

is this detid present in the Topology?

Reimplemented in HcalTopology, and GCC11_FINAL< T, TOPO >.

Definition at line 27 of file CaloSubdetectorTopology.h.

Referenced by CaloTopology::valid().

{ return false; };

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

pure virtual

Get the neighbors of the given cell in west direction

Implemented in GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, GCC11_FINAL< T, TOPO >, HcalTopology, CastorTopology, ZdcTopology, and GCC11_FINAL< T, TOPO >.

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