PeriodicGridBase.h

Go to the documentation of this file.

/*
 * Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
 */
 
#ifndef TRIGEFMISSINGET_PERIODICGRIDBASE_H
#define TRIGEFMISSINGET_PERIODICGRIDBASE_H
 
#include <cstddef>
#include <utility>

 
namespace HLT
{
  namespace MET
  {
    enum GridDisplacement
    {
      NoDisplacement = 0,
      EtaDisplaced = 1,
      PhiDisplaced = 2,
      EtaPhiDisplaced = 3
    }; //> end enum GridDisplacement

    struct GridParameters
    {
      double maxEta{0.};
      std::size_t nEtaTowers{0};
      std::size_t nPhiTowers{0};
      bool displaceEta{false};
      bool displacePhi{false};
      bool operator!=(const GridParameters &other) const;
      bool operator==(const GridParameters &other) const;
      GridDisplacement displacement() const;
    }; //> end struct GridParameters

    class PeriodicGridBase
    {
    public:
      class Tower
      {
      public:
        Tower(std::size_t index);
        virtual ~Tower() = default;

        virtual const PeriodicGridBase *grid() const = 0;

        double towerPhi() const;

        double towerEta() const;

        std::size_t index() const;

        std::size_t etaIndex() const;

        std::size_t phiIndex() const;

        std::pair<std::size_t, std::size_t> etaPhiIndex() const;
 
      private:
        std::size_t m_index;
      }; //> end class Tower

      PeriodicGridBase(const GridParameters &parameters);

      PeriodicGridBase(
          double maxEta,
          std::size_t nEtaTowers,
          std::size_t nPhiTowers,
          bool displaceEta = false,
          bool displacePhi = false);

      std::size_t getIndex(
          double eta,
          double phi,
          bool &outOfRange) const;

      std::size_t getEtaIndex(double eta, bool &outOfRange) const;

      std::size_t getPhiIndex(double phi) const;

      std::size_t globalIndex(std::size_t iEta, std::size_t iPhi) const;

      std::pair<std::size_t, std::size_t> etaPhiIndex(std::size_t index) const;

      double centralEta(std::size_t iEta) const;
      double centralPhi(std::size_t iPhi) const;

      const GridParameters &parameters() const;

      double maxEta() const;

      std::size_t nEtaTowers() const;

      std::size_t nPhiTowers() const;

      std::size_t nTowers() const;

      bool displaceEta() const;

      bool displacePhi() const;

      GridDisplacement displacement() const;

      double etaWidth() const;

      double phiWidth() const;
 
    private:
      const GridParameters m_params;
    }; //> end class PeriodicGridBase
  }    // namespace MET
} // namespace HLT
 
#endif //> !PUFITUTILS_PERIODICGRIDBASE_H