TopoAutomatonSplitting.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++ -*-
//
 
#ifndef CALORECGPU_TOPOAUTOMATONSPLITTING_H
#define CALORECGPU_TOPOAUTOMATONSPLITTING_H
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "CaloRecGPU/CaloClusterGPUProcessor.h"
#include "CaloRecGPU/CaloGPUTimed.h"
#include "CaloRecGPU/CaloGPUCUDAInitialization.h"
#include "TopoAutomatonSplittingImpl.h"
#include <string>
 
#include "AthCUDAInterfaces/IStreamTool.h"
 
#include "GaudiKernel/ServiceHandle.h"
 
#include "CLHEP/Units/SystemOfUnits.h"
 
#include "CaloRecGPU/IGPUKernelSizeOptimizerSvc.h"

 
 
class TopoAutomatonSplitting :
  public extends<AthAlgTool, CaloClusterGPUProcessor>, public CaloGPUTimed, public CaloGPUCUDAInitialization
{
 public:
 
  TopoAutomatonSplitting(const std::string & type, const std::string & name, const IInterface * parent);
 
  virtual StatusCode initialize() override
  {
    return CaloGPUCUDAInitialization::initialize();
  }
 
  virtual StatusCode initialize_non_CUDA() override;
 
  virtual StatusCode initialize_CUDA() override;
 
  virtual StatusCode execute (const EventContext & ctx,
                              const CaloRecGPU::ConstantDataHolder & constant_data,
                              CaloRecGPU::EventDataHolder & event_data,
                              void * temporary_buffer) const override;
 
  virtual StatusCode finalize() override;
 
  virtual ~TopoAutomatonSplitting() = default;
 
 private:

  Gaudi::Property<std::vector<std::string>>  m_samplingNames {this, "SamplingNames", {}, "Name(s) of Calorimeter Samplings to consider for local maxima"};

  Gaudi::Property<std::vector<std::string>> m_secondarySamplingNames {this, "SecondarySamplingNames", {}, "Name(s) of secondary Calorimeter Samplings to consider for local maxima"};

  Gaudi::Property<int> m_nCells {this, "NumberOfCellsCut", 4, "Local maxima need at least this number of neighbors to become seeds. Must be a non-negative number (obviously)."};

  Gaudi::Property<float> m_minEnergy {this, "EnergyCut", 500 * CLHEP::MeV, "Minimal energy for a local max"};
 

  Gaudi::Property<bool> m_shareBorderCells {this, "ShareBorderCells", false, "Whether or not to share cells at the boundary between two clusters"};
 

  Gaudi::Property<float> m_emShowerScale {this, "EMShowerScale", 5 * CLHEP::cm, "Typical EM shower distance for which the energy density should drop to 1/e"};

  Gaudi::Property<bool> m_absOpt {this, "WeightingOfNegClusters", false, "Should absolute value be used to identify potential seed cells"};

  Gaudi::Property<bool> m_treatL1PredictedCellsAsGood {this, "TreatL1PredictedCellsAsGood", true, "Treat bad cells with dead OTX if predicted from L1 as good"};

  Gaudi::Property<std::string> m_neighborOptionString {this, "NeighborOption", "super3D",
    "Neighbor option to be used for cell neighborhood relations"};

  Gaudi::Property<bool> m_restrictHECIWandFCalNeighbors {this, "RestrictHECIWandFCalNeighbors",
    false, "Limit the neighbors in HEC IW and FCal2&3"};

  Gaudi::Property<bool> m_restrictPSNeighbors {this, "RestrictPSNeighbors",
    false, "Limit the neighbors in presampler Barrel and Endcap"};
 
  //WARNING: the CPU version of the algorithm does not seem to have this option. Given the description,
  //         maybe it makes some sense to still allow this here? In our configuration we'll keep it disabled, but...

  TASplitting::TASOptionsHolder m_options;

  ServiceHandle<IGPUKernelSizeOptimizerSvc> m_kernelSizeOptimizer { this, "KernelSizeOptimizer", "GPUKernelSizeOptimizerSvc", "CUDA kernel size optimization service." };

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