TileTTL1Cell.h

Go to the documentation of this file.

// This file's extension implies that it's C, but it's really -*- C++ -*-.
 
/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
//***************************************************************************
// Filename : TileTTL1Cell.h
// Author   : Ed Frank, Ambreesh Gupta
//          : University of Chicago
//
//
// DESCRIPTION:
// TTL1Cell is the class for Tile Level 1 Trigger Towers where the energy and time are build from Tile cells
// This container is to add the L1Calo calibration where they can compare their tower energy to the tower energy
// from Tile's readout
// Each tower is contains a sum of Tile cells energies
// The time is the average time of all cells
// the correction factor is any pC to GeV correction factors that L1-Calo wants to account for separately
// the quality factor is defined as
// bit [0] -- individual PMTs bad
// bit [1] -- at least one cell bad
// bit [2] -- full tower is bad
// HISTORY:
//
// BUGS:
//
// ***************************************************************************
 
#ifndef TILEEVENT_TILETTL1CELL_H
#define TILEEVENT_TILETTL1CELL_H
 
#include "Identifier/Identifier.h"
 
#include <string>
#include <cstdint> //for uint16_t
 
class TileTTL1Cell {
 
public:

  enum QUALITY_BITS {  
    MASK_BADTOWER = 0x04,
    MASK_BADCELL  = 0x02, 
    MASK_BADCHAN  = 0x01, 
 
    SHIFT_BADTOWER = 2,
    SHIFT_BADCELL  = 1, 
    SHIFT_BADCHAN  = 0 
  };

  TileTTL1Cell()
    : m_eneTower(0.0),
      m_timeAve(0.0),
      m_corrFactor(0.0),
      m_quality(0)
  {}

  TileTTL1Cell(const Identifier& id,
           float energy, float time, float correction_factor, 
           uint16_t quality);

  ~TileTTL1Cell() = default;

  void setEnergy(float ene);
  void setTime(float tave);
  void setCorrectionFactor(float corrfact);
  void setQuality(uint16_t qual);

  const Identifier & TTL1_ID() const;
  inline Identifier identify(void) const { return m_ID; }

  inline float   eneTower(void)  const  { return m_eneTower; }
  inline float   timeAve(void)  const  { return m_timeAve; }
  inline float   corrFactor(void)  const  { return m_corrFactor; }
  inline uint16_t  qualTower(void)  const  { return m_quality; }

  bool cellbad (void) const  { return ((m_quality&TileTTL1Cell::MASK_BADCELL) != 0); }
  bool towerbad (void) const { return ((m_quality&TileTTL1Cell::MASK_BADTOWER) != 0); }
  bool chanbad (void) const  { return ((m_quality&TileTTL1Cell::MASK_BADCHAN) != 0); }

  std::string whoami   (void) const { return "TileTTL1Cell"; }
  void        print    (void) const;
  operator std::string() const;
 
private:

  Identifier m_ID;
  float      m_eneTower;
  float      m_timeAve; 
  float      m_corrFactor; 
  uint16_t  m_quality; 
  
  
};
 
#endif  // TILEEVENT_TILETTL1CELL_H