TileCellBuilder.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TILERECUTILS_TILECELLBUILDER_H
#define TILERECUTILS_TILECELLBUILDER_H
 
/********************************************************************
 *
 * NAME:     TileCellBuilder
 * PACKAGE:  offline/TileCalorimeter/TileRecUtils
 *
 * AUTHOR :  A. Solodkov
 * CREATED:  20-Jun-2004
 *
 * PURPOSE:  Create Cells from RawChannels and store them in container
 *
 *  Input: TileRawChannel (one by one or from TileRawChannelContainer)
 *  Output: Container or collection with TileCells
 *  Parameters:
 *    TileRawChannelContainer - Name of input container
 *   
 ********************************************************************/
 
// Tile includes
#include "TileEvent/TileCellContainer.h"
#include "TileEvent/TileRawChannelContainer.h"
#include "TileEvent/TileDQstatus.h"
#include "TileIdentifier/TileFragHash.h"
#include "TileIdentifier/TileRawChannelUnit.h"
#include "TileConditions/TileBadChannels.h"
#include "TileConditions/TileEMScale.h"
#include "TileConditions/TileCondToolTiming.h"
#include "TileConditions/TileCablingSvc.h"
#include "TileConditions/TileDCSState.h"
#include "TileRecUtils/ITileRawChannelTool.h"
 
// Calo includes
#include "CaloInterface/ICaloCellMakerTool.h"
#include "CaloConditions/CaloAffectedRegionInfo.h"
 
// Atlas includes
#include "AthenaBaseComps/AthAlgTool.h"
#include "xAODEventInfo/EventInfo.h"
#include "Identifier/HWIdentifier.h"
#include "AthenaKernel/IOVSvcDefs.h"
#include "StoreGate/ReadHandleKey.h"
#include "StoreGate/WriteHandleKey.h"
 
// Gaudi includes
#include "GaudiKernel/ToolHandle.h"
#include "GaudiKernel/ServiceHandle.h"
 
// C++ STL includes
#include <string>
#include <vector>
#include <memory>
 
// forward declarations
class TileID;
class TileTBID;
class TileHWID;
class TileCablingService;
class TileCell;
class TileRawChannel;
class MbtsDetDescrManager;
class TileDetDescrManager;
class TileCellCollection;
class CaloCellContainer;
class TileDQstatus;
class TileInfo;
 
 

class TileDrawerEvtStatus {
  public:
    int nChannels = 0;
    int nMaskedChannels = 0;
    int nBadQuality = 0;
    int nOverflow = 0;
    int nUnderflow = 0;
    int nSomeSignal = 0;
};

class TileDrawerRunStatus {
  public:
    int drawerAbsent;
    int drawerMasked;
    int channelsMasked;
};

class TileCellBuilder
  : public extends<AthAlgTool, ICaloCellMakerTool>
{
  public:
    TileCellBuilder(const std::string& type, const std::string& name, const IInterface* parent); 
 
    virtual ~TileCellBuilder(); 
 
    virtual StatusCode initialize() override;
 
    virtual StatusCode finalize() override;

    virtual StatusCode process (CaloCellContainer* theCellContainer,
                                const EventContext& ctx) const override;
 
    void reset(bool fullSizeCont, bool printReset = true); 
 
    //AlgTool InterfaceID
    static const InterfaceID& interfaceID();
 
private:
    // FIXME: Get rid of this abomination.
    friend class TileHid2RESrcID;

    typedef TileDrawerEvtStatus TileDrawerEvtStatusArray[5][64];
 
    // properties
    SG::ReadHandleKey<TileRawChannelContainer> m_rawChannelContainerKey{this, "TileRawChannelContainer", 
                                                                        "TileRawChannelCnt", 
                                                                        "Input Tile raw channel container key"};
 
    SG::ReadHandleKey<TileRawChannelContainer> m_dspRawChannelContainerKey{this, "TileDSPRawChannelContainer", 
                                                                           "TileRawChannelCnt", 
                                                                           "Input Tile DSP raw channel container key"};
 
    SG::ReadHandleKey<xAOD::EventInfo> m_eventInfoKey{this, "EventInfo", 
                                                      "EventInfo", 
                                                      "EventInfo key"};
 
 
 
    SG::ReadHandleKey<TileDQstatus> m_DQstatusKey{this, "TileDQstatus", 
                                                  "TileDQstatus", 
                                                  "TileDQstatus key"};
 
    SG::WriteHandleKey<TileCellContainer> m_MBTSContainerKey{this, "MBTSContainer", 
                                                             "MBTSContainer", 
                                                             "Output Tile MBTS container key"};
 
    SG::WriteHandleKey<TileCellContainer> m_E4prContainerKey{this, "E4prContainer", 
                                                             "E4prContainer",
                                                             "Output Tile E4 prime container key"};
 
    SG::WriteDecorHandleKey<xAOD::EventInfo> m_EventInfoTileStatusKey{this, "EventInfoTileStatus",
                                                                      m_eventInfoKey, "TileStatus",
                                                                      "Dummy decoration key to aid scheduling"};
 
 
    std::string m_dspRawChannelContainer;
 
    float m_eneForTimeCut;        
    float m_eneForTimeCutMBTS;    
    float m_zeroEnergy;           
    int m_qualityCut;           
    bool m_correctTime;          
    bool m_correctAmplitude; 
    bool m_of2;              
    bool m_mergeChannels;        
 
    // thresholds for parabolic amplitude correction
    float m_ampMinThresh;   
    float m_timeMinThresh;                
    float m_timeMaxThresh;                
 
    float m_minEneChan[3];        
    float m_eThreshold;           
    float m_maxTimeDiff;          
    float m_maxTime;              
    float m_minTime;              
    float m_maxChi2;              
    float m_minChi2;              
    bool m_thresholdNotSet;      
    bool m_fullSizeCont;
    bool m_maskBadChannels;      
    bool m_fakeCrackCells;       
    int  m_skipGain;             
    int m_useDemoCabling;
    bool m_checkDCS;
 
    const TileID* m_tileID;   
    const TileTBID* m_tileTBID; 
    const TileHWID* m_tileHWID; 
    const TileCablingService* m_cabling; 

    SG::ReadCondHandleKey<TileBadChannels> m_badChannelsKey{this,
        "TileBadChannels", "TileBadChannels", "Input Tile bad channel status"};

     SG::ReadCondHandleKey<TileEMScale> m_emScaleKey{this,
         "TileEMScale", "TileEMScale", "Input Tile EMS calibration constants"};
 
    ToolHandle<TileCondToolTiming> m_tileToolTiming{this,
        "TileCondToolTiming", "TileCondToolTiming", "Tile timing tool"};
 
    ToolHandleArray<ITileRawChannelTool> m_noiseFilterTools{this,
        "NoiseFilterTools", {}, "Tile noise filter tools"};

    SG::ReadCondHandleKey<TileDCSState> m_DCSStateKey{this,
        "TileDCS", "TileDCS", "Input Tile DCS status"};

    ServiceHandle<TileCablingSvc> m_cablingSvc{ this,
        "TileCablingSvc", "TileCablingSvc", "The Tile cabling service"};
 
    const TileDetDescrManager* m_tileMgr; 
    const MbtsDetDescrManager* m_mbtsMgr; 
 
    //unsigned int m_bsflags;              //!< other flags stored in TileRawChannelContainer
 
    // These were accumulated, but never actually used.
    // They also spoil reentrancy, so leave them commented-out for now.
    // If this information is needed in the future, these can be changed
    // to use atomics.
    //TileDrawerRunStatus m_drawerRunStatus[5][64]; //!< overall status of drawer in whole run
    //int m_eventErrorCounter[4]; //!< number of events with no errors(0), warnings(1), error(2), total(3)
 
    std::vector<CaloAffectedRegionInfo> m_affectedRegionInfo_global;
    std::vector<CaloAffectedRegionInfo> m_affectedRegionInfo_current_run;
 
   
    struct VecParams
    {
      // Type of TileRawChannels (Fit, OF2, etc.)
      TileFragHash::TYPE m_RChType;      
 
      // Unit for TileRawChannels (ADC, pCb, etc.)
      TileRawChannelUnit::UNIT m_RChUnit;
 
      // max possible time when time correction is applied
      float m_maxTimeCorr = 75.0;
 
      // If true, amplitude is corrected by parabolic function (needed for OF without iterations)
      bool m_correctAmplitude; 
 
      // should time be corrected (deltat added from CondDB)
      bool m_correctTime;          
 
      // If true, assume OF2 method for amplitude correction, otherwise - OF1
      bool m_of2;
    };
 
    template<class ITERATOR, class COLLECTION>
    void build (const EventContext& ctx,
                TileDrawerEvtStatusArray& drawerEvtStatus,
                VecParams& params,
                const ITERATOR & begin,
                const ITERATOR & end,
                COLLECTION* coll,
                TileCellContainer* MBTSCells,
                TileCellContainer* E4prCells) const;

    bool maskBadChannel (TileDrawerEvtStatusArray& drawerEvtStatus,
                         const TileDQstatus* DQstatus, const TileDCSState* dcsState,
                         const TileBadChannels* badChannels, TileCell* pCell, HWIdentifier hwid) const;
    bool maskBadChannels (TileDrawerEvtStatusArray& drawerEvtStatus,
                          const TileDQstatus* DQstatus, const TileDCSState* dcsState,
                          const TileBadChannels* badChannels, TileCell* pCell) const;
 
    void correctCell(TileCell* pCell, int correction, int pmt, int gain, float ener, float time,
        unsigned char iqual, unsigned char qbit, int ch_type) const; 
 
    unsigned char iquality(float qual) const {
         return std::min(255, abs((int) qual));
    } // keep quality within 8 bits make it "unsigned char"
 

    unsigned char qbits (TileDrawerEvtStatusArray& drawerEvtStatus,
                         TileFragHash::TYPE RChType,
                         int ros, int drawer,
                         bool count_over, bool good_time, bool good_ener,
                         bool overflow, bool underflow,
                         bool good_overflowfit) const;
 
    template<typename T, typename V>
    class DoubleVectorIterator {
        VecParams& m_params;
        T* m_first;
        const VecParams& m_params1;
        T* m_second;
        const VecParams& m_params2;
        int m_pos;
        typedef typename T::iterator itr_type;
        itr_type m_itr;
 
      public:
 
        DoubleVectorIterator(VecParams& params,
                             T* f,
                             const VecParams& params1,
                             T* s,
                             const VecParams& params2,
                             int p)
          : m_params(params),
            m_first(f),
              m_params1(params1),
              m_second(s),
              m_params2(params2),
              m_pos(p) {
 
          if (m_first->begin() != m_first->end() && m_pos < 1) {
            m_pos = 0;
            m_itr = m_first->begin();
          } else if (m_second->begin() != m_second->end() && m_pos < 2) {
            m_pos = 1;
            m_itr = m_second->begin();
            // set parameters for second vector
            m_params = m_params2;
          } else {
            m_pos = 2;
            m_itr = m_second->end();
          }
        }
 
        DoubleVectorIterator(const DoubleVectorIterator& i) = default;
        DoubleVectorIterator& operator=(const DoubleVectorIterator& other) = default;
 
 
        bool operator!=(const DoubleVectorIterator& i) {
          if (m_pos != i.m_pos || m_itr != i.m_itr) return true;
          else return false;
        }
 
        V& operator*() const { return (*m_itr); }
        V* operator->() const { return (*m_itr); }
 
        DoubleVectorIterator& operator++() {
          switch (m_pos) {
            case 0:
              if (m_itr != m_first->end()) ++m_itr;
              if (m_itr != m_first->end()) break;
              m_itr = m_second->begin();
              m_pos = 1;
              // set parameters for second vector
              m_params = m_params2;
              if (m_itr != m_second->end()) break;
              m_pos = 2;
              // recover parameters for first vector
              m_params = m_params1;
              break;
            case 1:
              if (m_itr != m_second->end()) ++m_itr;
              if (m_itr != m_second->end()) break;
              m_pos = 2;
              // recover parameters for first vector
              m_params = m_params1;
              break;
            default:
              break;
          }
          return *this;
        }
    };
 
    enum CELL_CHANNEL {E1_CHANNEL = 12};
    enum CELL_TOWER {E1_TOWER = 10, E1_TOWER_UPGRADE_ABC = 42};
    int m_towerE1 = E1_TOWER;
    bool m_notUpgradeCabling;
    bool m_run2;
 
    // TileInfo
    std::string m_infoName;
    const TileInfo* m_tileInfo;
    float m_ADCmaskValueMinusEps;
    float m_ADCmaskValuePlusEps;
    bool m_run2plus;
};
 
#endif