PufitGrid.h

Go to the documentation of this file.

/*
 * Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
 */
 
/******************************************************************************
 * @package Trigger/TrigAlgorithms/TrigEFMissingET
 * @class   PufitGrid
 *
 * @brief Grid to use in the pufit calculation
 * @author Bob Kowalewski, Jon Burr
 *****************************************************************************/
 
#ifndef TRIGEFMISSINGET_PUFITGRID_H
#define TRIGEFMISSINGET_PUFITGRID_H
 
#include <vector>
#include <utility>
#include <array>
#include "TrigEFMissingET/PeriodicGridBase.h"
#include "TrigEFMissingET/SignedKinematics.h"
 
namespace HLT
{
  namespace MET
  {
    // Forward declare
    class METComponent;

    class PufitGrid : public PeriodicGridBase
    {
    public:
      class Tower : public PeriodicGridBase::Tower
      {
      public:
        Tower(const PufitGrid *parent, std::size_t index);
 
        Tower(const Tower &) = default;

        Tower &operator=(const Tower &other);

        double ex() const;

        double ey() const;

        double ez() const;

        double sumEt() const;

        double sumE() const;

        double phi() const;

        double eta() const;

        bool masked() const;

        void mask(bool value = true);

        virtual const PufitGrid *grid() const override;

        SignedKinematics kinematics() const;
        operator SignedKinematics() const;

        Tower &operator+=(const SignedKinematics &kin);
        Tower &operator-=(const SignedKinematics &kin);

        Tower &operator+=(const Tower &other);
        Tower &operator-=(const Tower &other);
 
      private:
        const PufitGrid *const m_parent;
 
        SignedKinematics m_kin;
        double m_sumEt{0.};
        double m_sumE{0.};
        bool m_mask{false};
      }; //> end class Tower

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

      PufitGrid(const GridParameters &parameters);

      PufitGrid(const PufitGrid &other);

      PufitGrid &operator=(const PufitGrid &other);

      void reset();

      PufitGrid &operator+=(const SignedKinematics &kin);
      PufitGrid &operator-=(const SignedKinematics &kin);

      Tower &operator[](const std::pair<std::size_t, std::size_t> &indices);
      const Tower &operator[](
          const std::pair<std::size_t, std::size_t> &indices) const;

      Tower &operator[](std::size_t index);
      const Tower &operator[](std::size_t index) const;

      std::vector<Tower>::iterator begin();
      std::vector<Tower>::const_iterator begin() const;
      std::vector<Tower>::iterator end();
      std::vector<Tower>::const_iterator end() const;

      enum class SumStrategy
      {
        All,     //> Sum all towers, regardless of masks
        Masked,  //> Only sum masked towers
        Unmasked //> Only sum unmasked towers
      };
      METComponent sum(SumStrategy strategy = SumStrategy::All) const;
 
      // All of these fail if the grid parameters do not match!
      PufitGrid &operator+=(const PufitGrid &other);
      PufitGrid &operator-=(const PufitGrid &other);
 
    private:
      std::vector<Tower> m_towers;
    }; //> end class PufitGrid

    struct PufitGridSet
    {
      PufitGridSet(double maxEta, std::size_t nEta, std::size_t nPhi);
      std::array<PufitGrid, 4> grids;
      PufitGridSet &operator+=(const SignedKinematics &kin);
      PufitGridSet &operator-=(const SignedKinematics &kin);
      PufitGrid &operator[](GridDisplacement displacement);
      const PufitGrid &operator[](GridDisplacement displacement) const;
    };

    PufitGrid operator+(const PufitGrid &lhs, const PufitGrid &rhs);
    PufitGrid operator-(const PufitGrid &lhs, const PufitGrid &rhs);
  } // namespace MET
} // namespace HLT
 
#endif //> !TRIGEFMISSINGET_PUFITGRID_H