LArCellPreparationAlg.h

Go to the documentation of this file.

/*
 *   Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
 */
 
#ifndef GLOBALSIM_LARCELLPREPARATIONALG_H
#define GLOBALSIM_LARCELLPREPARATIONALG_H
 
/*
  This Algorithm simulates the energy encoding of all LAr cells for Global and simulated the truncation of cells
  from overflowing FEB2s. The hardware-accurate cells are then stored in a GlobalLArCellContainer object within 
  StoreGate
*/
 
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
#include "AthenaBaseComps/AthAlgTool.h"
#include "xAODEventInfo/EventInfo.h"
#include "GaudiKernel/ToolHandle.h"
#include "CaloEvent/CaloCellContainer.h"
#include "CaloConditions/CaloNoise.h"
 
#include "GlobalLArCell.h"
#include "GlobalLArCellContainer.h"
 
#include <vector>
#include <boost/dynamic_bitset.hpp>
 
namespace GlobalSim {
 
  class LArCellPreparationAlg : public AthReentrantAlgorithm { 
  public:
 
    using AthReentrantAlgorithm::AthReentrantAlgorithm;

    virtual StatusCode  initialize() override;   
    virtual StatusCode  execute(const EventContext& ) const override;    
 
  private:

    std::pair<float,boost::dynamic_bitset<>> encodeEnergy(float energy) const;
    StatusCode removeCellsFromOverloadedFEB(std::vector<GlobalSim::GlobalLArCell> &cells) const;
    
    int m_readoutRanges[5] = {-1,-1,-1,-1,-1};
    int m_stepsPerRange = -1;
    unsigned m_maxCellsPerFEB = -1;

    std::map<int,GlobalSim::GlobalLArCell> m_gblLArCellMap = {};
    std::unique_ptr<GlobalSim::GlobalLArCellContainer> m_gblLArCellContainerTemplate;

    SG::ReadHandleKey<xAOD::EventInfo> m_eventInfo{this, "EventInfo", "EventInfo", "Key for the EventInfo container"};

    Gaudi::Property<int> m_numberOfEnergyBits {this, "numberOfEnergyBits", 6, "Number of bits reserved for the multilinear energy encoding"};
    Gaudi::Property<int> m_valueLSB {this, "valueLeastSignificantBit", 40, "Value of the least significant bit in MeV"};
    Gaudi::Property<int> m_valueGainFactor {this, "valueGainFactor", 4, "Value of the gain factor of the multilinear energey encoding"};

    Gaudi::Property<std::string> m_LArCellMap {this, "LArCellMapFile", "UpgradePerformanceFunctions/LAr_Cell_Map_offlineID_1.csv",
      "File associating LAr cells with readout FEBs and connection technology"};

    SG::ReadHandleKey<CaloCellContainer> m_caloCellsKey {this, "caloCells", "AllCalo", "key to read in a CaloCell container"};

    SG::ReadCondHandleKey<CaloNoise> m_totalNoiseKey{this, "totalNoiseKey", "totalNoise", "SG Key of CaloNoise data object"};

    SG::WriteHandleKey<GlobalSim::GlobalLArCellContainer> m_LArCellContainerKey{this, "GlobalLArCellsKey", "GlobalLArCells", "Key for the output container of the LAr cells sent to Global"};
 
  };
 
}
#endif