GPUToAthenaImporterWithMoments.h

Go to the documentation of this file.

//
// Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
//
// Dear emacs, this is -*- c++ -*-
//
 
//Dear emacs, this is -*-c++-*-
 
#ifndef CALORECGPU_GPUTOATHENAIMPORTERWITHMOMENTS_H
#define CALORECGPU_GPUTOATHENAIMPORTERWITHMOMENTS_H
 
#include "AthenaBaseComps/AthAlgTool.h"
 
#include "CaloRecGPU/CaloClusterGPUTransformers.h"
#include "CaloRecGPU/CaloGPUTimed.h"
#include "CaloRecGPU/DataHolders.h"
#include "StoreGate/ReadHandleKey.h"
#include "StoreGate/ReadCondHandleKey.h"
 
#include "CaloDetDescr/CaloDetDescrManager.h"
#include "LArCabling/LArOnOffIdMapping.h"
#include "LArElecCalib/ILArHVScaleCorr.h"
 
#include "AthCUDAInterfaces/IStreamTool.h"
 
class CaloCell_ID;

 
class GPUToAthenaImporterWithMoments :
  public extends<AthAlgTool, ICaloClusterGPUOutputTransformer>, public CaloGPUTimed
{
 public:
 
  GPUToAthenaImporterWithMoments(const std::string & type, const std::string & name, const IInterface * parent);
 
  virtual StatusCode initialize() override;
 
  virtual StatusCode convert (const EventContext & ctx, const CaloRecGPU::ConstantDataHolder & constant_data,
                              CaloRecGPU::EventDataHolder & event_data, xAOD::CaloClusterContainer * cluster_collection) const override;
 
  virtual StatusCode finalize() override;
 
  virtual ~GPUToAthenaImporterWithMoments() = default;
 
 private:

  Gaudi::Property<bool> m_keepGPUData {this, "KeepGPUData", true, "Keep GPU allocated data"};

  SG::ReadHandleKey<CaloCellContainer> m_cellsKey {this, "CellsName", "", "Name(s) of Cell Containers"};

  Gaudi::Property<std::string> m_clusterSizeString {this, "ClusterSize", "Topo_420", "The size/type of the clusters"};
 
  xAOD::CaloCluster::ClusterSize m_clusterSize;

  const CaloCell_ID * m_calo_id {nullptr};

  SG::ReadCondHandleKey<CaloDetDescrManager> m_caloMgrKey{this, "CaloDetDescrManager", "CaloDetDescrManager",
    "SG Key for CaloDetDescrManager in the Condition Store"};
 
  //Handles for things we can't (yet) do on the GPU.

  Gaudi::Property<bool> m_fillHVMoments {this, "FillHVMoments", false, "Fill the HV-related moments using the respective tools."};

   SG::ReadCondHandleKey<LArOnOffIdMapping> m_HVCablingKey{this, "LArCablingKey","LArOnOffIdMap","SG Key of LAr Cabling object"};

   SG::ReadCondHandleKey<ILArHVScaleCorr> m_HVScaleKey{this,"HVScaleCorrKey","LArHVScaleCorr","SG key of HVScaleCorr conditions object"};

   Gaudi::Property<float> m_HVthreshold{this,"HVThreshold",0.2,"Threshold to consider a cell 'affected' by HV issues"};

  Gaudi::Property<std::vector<int>> m_missingCellsToFill {this, "MissingCellsToFill", {}, "Force fill these cells as disabled on empty containers."};

  Gaudi::Property<bool> m_saveUncalibrated {this, "SaveUncalibratedSignalState", true, "Use CaloClusterKineHelper::calculateKine instead of GPU-calculated cluster properties"};

  ToolHandle<AthCUDA::IStreamTool> m_streamTool {this, "StreamTool", "", "CUDA stream tool."};
 

  Gaudi::Property<std::vector<std::string>> m_momentsNames{this, "MomentsNames", {}, "List of names of moments to calculate"};

  CaloRecGPU::MomentsOptionsArray m_momentsToDo;
 

  bool m_doHVMoments;
 
};
 
#endif //CALORECGPU_GPUTOATHENAIMPORTERWITHMOMENTS_H