LArRODBCIDCorrAlg.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef LARROD_LARRODBCIDCORRALG_H
#define LARROD_LARRODBCIDCORRALG_H
 
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
#include "LArCabling/LArOnOffIdMapping.h"
#include "LArElecCalib/ILArMinBiasAverage.h"
#include "LArElecCalib/ILArShape.h"
#include "LArRawConditions/LArADC2MeV.h"
#include "StoreGate/ReadCondHandleKey.h"
#include "StoreGate/ReadHandleKey.h"
#include "StoreGate/WriteHandleKey.h"
#include "xAODEventInfo/EventInfo.h"
 
#include <vector>
 
class LArDigitContainer;
class LArOnlineID;

class LArRODBCIDCorrAlg : public AthReentrantAlgorithm
{
public:
  using AthReentrantAlgorithm::AthReentrantAlgorithm;
 
  virtual StatusCode initialize() override;
  virtual StatusCode execute (const EventContext& ctx) const override;
 
private:
  static constexpr int s_nBCID = 3564;
 
  SG::ReadHandleKey<LArDigitContainer> m_digitKey
  { this, "LArDigitKey", "LArDigitContainer_MC",
    "SG key of the input LArDigitContainer" };
 
  SG::WriteHandleKey<LArDigitContainer> m_digitCorrKey
  { this, "OutputDigitKey", "LArDigitContainer_PileupCorrected",
    "SG key of the output LArDigitContainer" };
 
  SG::ReadCondHandleKey<LArADC2MeV> m_adc2MeVKey
  { this, "ADC2MeVKey", "LArADC2MeV",
    "SG key of the ADC2MeV conditions object" };
 
  SG::ReadCondHandleKey<LArOnOffIdMapping> m_cablingKey
  { this, "CablingKey", "LArOnOffIdMap",
    "SG key of the LArOnOffIdMapping object" };
 
  SG::ReadCondHandleKey<ILArShape> m_shapeKey
  { this, "ShapeKey", "LArShape",
    "SG key of the LArShape conditions object" };
 
  SG::ReadCondHandleKey<ILArMinBiasAverage> m_minBiasAvgKey
  { this, "MinBiasAvgKey", "LArPileupAverageSym",
    "SG key of the LArMinBiasAverage object" };
 
  SG::ReadHandleKey<xAOD::EventInfo> m_eventInfoKey
  { this, "EventInfo", "EventInfo", "SG key of the EventInfo object" };
 
  Gaudi::Property<std::vector<float> > m_beamIntensityPattern
  { this, "BeamIntensityPattern", {}, "LHC beam intensity pattern" };
 
  Gaudi::Property<int> m_firstSample
  { this, "firstSample", 0,
    "Digitisation firstSample: the shape index seen by digit sample 0. Must be "
    "set exactly as LArHitEMapToDigitAlg.firstSample, that is "
    "-nPreceedingSamples, or LAr.ROD.FirstSample when that is zero." };
 
  Gaudi::Property<int> m_minBunchCrossing
  { this, "MinBunchCrossing", -s_nBCID,
    "Earliest bunch crossing, relative to the triggered one, included in the "
    "correction. Set this to the earliest crossing actually overlaid by the "
    "digitisation to avoid over-subtracting in the preceding samples." };
 
  Gaudi::Property<int> m_maxBunchCrossing
  { this, "MaxBunchCrossing", s_nBCID,
    "Latest bunch crossing, relative to the triggered one, included in the "
    "correction." };

  std::vector<float> m_lumi;

  const LArOnlineID* m_onlineId = nullptr;

  StatusCode fillLumi();

  void computePileupADCCorrection (float mbEnergy,
                                   const ILArShape::ShapeRef_t& pulseShape,
                                   int bcid,
                                   float adc2MeVSlope,
                                   float intperBC,
                                   bool hecShift,
                                   std::vector<float>& pileupADC) const;
};
 
#endif // LARROD_LARRODBCIDCORRALG_H