CaloSubdetectorTopology.h

Go to the documentation of this file.

#ifndef TOPOLOGY_CALOTOPOLOGY_CALOSUBDETECTORTOPOLOGY_H
#define TOPOLOGY_CALOTOPOLOGY_CALOSUBDETECTORTOPOLOGY_H 1


#include "DataFormats/DetId/interface/DetId.h"
#include "Geometry/CaloTopology/interface/CaloDirection.h"
#include "FWCore/Utilities/interface/Exception.h"

#include <vector>

#include "FWCore/Utilities/interface/GCC11Compatibility.h"

class CaloSubdetectorTopology {
public:
  CaloSubdetectorTopology() {};
  virtual ~CaloSubdetectorTopology() { }
  virtual bool valid(const DetId& /*id*/) const { return false; };
  virtual unsigned int detId2denseId(const DetId& /*id*/) const { return 0; }
  virtual DetId denseId2detId(unsigned int /*denseid*/) const { return DetId(0); }
  virtual unsigned int ncells() const { return 1; }
  virtual int topoVersion() const { return 0; }
  virtual bool denseIdConsistent(int topoVer) const { return topoVer==topoVersion(); }

  virtual std::vector<DetId> east(const DetId& id) const = 0;
  virtual std::vector<DetId> west(const DetId& id) const = 0;
  virtual std::vector<DetId> north(const DetId& id) const = 0;
  virtual std::vector<DetId> south(const DetId& id) const = 0;
  virtual std::vector<DetId> up(const DetId& id) const = 0;
  virtual std::vector<DetId> down(const DetId& id) const = 0;

  // interface valid for most subdetectors
  // see for instance RecoCaloTools/Navigation/interface/CaloNavigator.h
  virtual DetId goEast(const DetId& id) const {
    std::vector<DetId> ids = east(id);
    return ids.empty() ? DetId() : ids[0];    
  }
  virtual DetId goWest(const DetId& id) const {
    std::vector<DetId> ids = west(id);
    return ids.empty() ? DetId() : ids[0];    
  }
  virtual DetId goNorth(const DetId& id) const {
    std::vector<DetId> ids = north(id);
    return ids.empty() ? DetId() : ids[0];    
  }
  virtual DetId goSouth(const DetId& id) const {
    std::vector<DetId> ids = south(id);
    return ids.empty() ? DetId() : ids[0];    
  }
  virtual DetId goUp(const DetId& id) const {
    std::vector<DetId> ids = up(id);
    return ids.empty() ? DetId() : ids[0];    
  }
  virtual DetId goDown(const DetId& id) const {
    std::vector<DetId> ids = down(id);
    return ids.empty() ? DetId() : ids[0];    
  }


  virtual std::vector<DetId> getNeighbours(const DetId& id, const CaloDirection& dir) const
    {
      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;
    }

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

  virtual std::vector<DetId> getAllNeighbours(const DetId& id) const
    {
      return getWindow(id,3,3);
    }

 protected:
  typedef std::pair<int,int> Coordinate;

  struct CellInfo
  {
    bool visited;
    
    DetId cell;
    
    CellInfo() : 
      visited(false)
    {
    }
    
    CellInfo(bool a_visited, const DetId &a_cell) : 
      visited(a_visited),
     cell(a_cell)
    {
    }
  };

  inline Coordinate getNeighbourIndex(const Coordinate &coord, const CaloDirection& dir) const
    {
      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";
        }
    }
  
};


#endif