LuminosityCondAlg.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-2025 CERN for the benefit of the ATLAS collaboration.
 */
 
 
#ifndef LUMIBLOCKCOMPS_LUMINOSITYCONDALG_H
#define LUMIBLOCKCOMPS_LUMINOSITYCONDALG_H
 
 
#include "LumiBlockData/LuminosityCondData.h"
#include "CoolLumiUtilities/OnlineLumiCalibrationCondData.h"
#include "CoolLumiUtilities/FillParamsCondData.h"
#include "CoolLumiUtilities/BunchLumisCondData.h"
#include "CoolLumiUtilities/BunchGroupCondData.h"
#include "AthenaBaseComps/AthCondAlgorithm.h"
#include "AthenaPoolUtilities/CondAttrListCollection.h"
#include "PersistentDataModel/AthenaAttributeList.h"
#include "StoreGate/ReadCondHandleKey.h"
#include "StoreGate/WriteCondHandleKey.h"
#include "CoralBase/Blob.h"
#include "xAODEventInfo/EventInfo.h"
#include "ByteStreamData/ByteStreamMetadataContainer.h"
 

class LuminosityCondAlg
  : public AthCondAlgorithm
{
public:
  using AthCondAlgorithm::AthCondAlgorithm;
 

  virtual StatusCode initialize() override;
 

  virtual StatusCode execute (const EventContext& ctx) const override;
 
 
private:
  StatusCode
  updateAvgLumi (const CondAttrListCollection& lumiData,
                 LuminosityCondData& lumi,
                 unsigned int& preferredChannel,
                 unsigned int& calibChannel,
                 const coral::Blob*& bunchInstLumiBlob) const;
 

  StatusCode
  updatePerBunchLumi (const EventContext& ctx,
                      const coral::Blob* bunchInstLumiBlob,
                      unsigned int preferredChannel,
                      unsigned int calibChannel,
                      SG::WriteCondHandle<LuminosityCondData>& wHdl,
                      LuminosityCondData& lumi) const;
 

  StatusCode
  updateMuToLumi (const EventContext& ctx,
                  unsigned int calibChannel,
                  SG::WriteCondHandle<LuminosityCondData>& wHdl,
                  LuminosityCondData& lumi,
                  bool& isValid) const;
 

  StatusCode
  updatePerBunchLumiRun2 (const coral::Blob& bunchInstLumiBlob,
                          unsigned int preferredChannel,
                          LuminosityCondData& lumi) const;
 

  StatusCode
  updatePerBunchLumiRun1 (const EventContext& ctx,
                          unsigned int preferredChannel,
                          SG::WriteCondHandle<LuminosityCondData>& wHdl,
                          LuminosityCondData& lumi) const;
 
 
  Gaudi::Property<unsigned long> m_lumiChannel
    { this, "LumiChannelNumber", 0, "Luminosity channel to read.  0 means to determine from the data." };
 
  Gaudi::Property<unsigned long> m_calibBackupChannel
    { this, "CalibBackupChannel", 112, "Backup channel in case calibChannel doesn't exist in online calibration folder" };
 
  Gaudi::Property<bool> m_skipInvalid
    { this, "SkipInvalid", true, "Flag to control whether invalid data is skipped:  True (default), returning a zero luminosity; false, returning available luminosity values anyway." };
 
  Gaudi::Property<bool> m_expectInvalid
    { this, "ExpectInvalid", false, "Flag to control printouts when invalid data are encountered: True suppresses messages, False (default) leaves them in" };
 
  // following properties are for MC
  Gaudi::Property<bool> m_isMC
    { this, "IsMC", false, "Set to true when running on MC instead of data" };
 
  Gaudi::Property<float> m_muToLumi
    { this, "MCMuToLumi", 0.140569, "mu to lumi conversion factor in MC (80 mb/LHC rev freq)" };
 
 
  SG::ReadCondHandleKey<CondAttrListCollection> m_luminosityFolderInputKey
  { this, "LuminosityFolderInputKey", "/TRIGGER/OFLLUMI/LBLESTOFL",
    "Input luminosity COOL folder." };
 
  SG::ReadCondHandleKey<OnlineLumiCalibrationCondData> m_onlineLumiCalibrationInputKey
  { this, "OnlineLumiCalibrationInputKey", "OnlineLumiCalibrationCondData",
    "Input luminosity calibration." };
 
  SG::ReadCondHandleKey<BunchLumisCondData> m_bunchLumisInputKey
  { this, "BunchLumisInputKey", "",
    "Input raw luminosities.  Only used for Run 1." };
 
  SG::ReadCondHandleKey<BunchGroupCondData> m_bunchGroupInputKey
  { this, "BunchGroupInputKey", "",
    "Input filled bunch data.  Only used for Run 1." };
 
  SG::ReadCondHandleKey<FillParamsCondData> m_fillParamsInputKey
  { this, "FillParamsInputKey", "",
    "Input luminous bunch data.  Only used for Run 1." };
 
  // the following are for MC
  SG::ReadCondHandleKey<AthenaAttributeList> m_mcDigitizationInputKey
  { this, "DigitizationFolderInputKey", "/Digitization/Parameters",
    "Digitization parameters metadata folder." };
 
  SG::ReadHandleKey<ByteStreamMetadataContainer> m_byteStreamMetadataKey
  { this, "ByteStreamMetadataKey", "",
    "ByteStream metadata (for reading IOV metadata from BS files in MC mode)" };
 
  SG::ReadHandleKey<xAOD::EventInfo> m_eventInfoKey 
  { this, "EventInfoKey", "EventInfo", "EventInfo key, used to read in simulated mu in MC" };
 
  SG::ReadDecorHandleKey<xAOD::EventInfo> m_actualMuKey 
  { this, "actualMuKey", m_eventInfoKey, "actualInteractionsPerCrossing",
    "Decoration for Actual Interaction Per Crossing, for MC" };
 
  SG::ReadDecorHandleKey<xAOD::EventInfo> m_averageMuKey 
  { this, "averageMuKey", m_eventInfoKey, "averageInteractionsPerCrossing",
    "Decoration for Average Interaction Per Crossing" };

  SG::WriteCondHandleKey<LuminosityCondData> m_luminosityOutputKey
  { this, "LuminosityOutputKey", "LuminosityCondData",
    "Output luminosity data." };
};
 
 
#endif // not LUMIBLOCKCOMPS_LUMINOSITYCONDALG_H