TopoAutomatonClustering.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_TOPOAUTOMATONCLUSTERING_H
#define CALORECGPU_TOPOAUTOMATONCLUSTERING_H
 
#include "AthenaBaseComps/AthAlgTool.h"
 
#include "CxxUtils/checker_macros.h"
 
#include "CaloRecGPU/CaloClusterGPUProcessor.h"
#include "CaloRecGPU/CaloGPUTimed.h"
#include "TopoAutomatonClusteringImpl.h"
#include <string>
#include <mutex>
 
#include "AthCUDAInterfaces/IStreamTool.h"
 
#include "CLHEP/Units/SystemOfUnits.h"
 
#include "CaloRecGPU/IGPUKernelSizeOptimizerSvc.h"
#include "CaloRecGPU/CaloGPUCUDAInitialization.h"
 
#include "GaudiKernel/ServiceHandle.h"

 
 
class TopoAutomatonClustering :
  public extends<AthAlgTool, CaloClusterGPUProcessor>, public CaloGPUTimed, public CaloGPUCUDAInitialization
{
 public:
 
  TopoAutomatonClustering(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 ~TopoAutomatonClustering() = default;
 
 private:

  Gaudi::Property<std::vector<std::string>>  m_caloNames {this, "CalorimeterNames", {}, "Name(s) of Calorimeters to use for clustering"};

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

  Gaudi::Property<float> m_cellThresholdOnEorAbsEinSigma {this, "CellThresholdOnEorAbsEinSigma", 0., "Cell (terminal) threshold (in units of noise Sigma)"};

  Gaudi::Property<float> m_neighborThresholdOnEorAbsEinSigma {this, "NeighborThresholdOnEorAbsEinSigma", 2., "Neighbor (grow) threshold (in units of noise Sigma)"};

  Gaudi::Property<float> m_seedThresholdOnEorAbsEinSigma {this, "SeedThresholdOnEorAbsEinSigma", 4., "Seed threshold (in units of noise Sigma)"};
 

  Gaudi::Property<bool> m_seedCutsInAbsE {this, "SeedCutsInAbsE", true, "Seed cuts in Abs E instead of E"};

  Gaudi::Property<bool> m_neighborCutsInAbsE {this, "NeighborCutsInAbsE", true, "Neighbor (grow) cuts in Abs E instead of E"};

  Gaudi::Property<bool> m_cellCutsInAbsE {this, "CellCutsInAbsE", true, "Cell (terminal) cuts in Abs E instead of E"};

  Gaudi::Property<bool> m_cutCellsInTime {this, "SeedCutsInT", false, "Do seed cuts in time"};

  Gaudi::Property<float> m_timeThreshold {this, "SeedThresholdOnTAbs", 12.5 * CLHEP::ns, "Time thresholds (in abs. val.)"};

  Gaudi::Property<float> m_thresholdForKeeping {this, "TimeCutUpperLimit", 20., "Significance upper limit for applying time cut"};
 

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

  Gaudi::Property<bool> m_excludeCutSeedsFromClustering {this, "CutOOTseed", true, "Exclude out-of-time seeds from neighbouring and cell stage"};

  Gaudi::Property<bool> m_keepSignificantCells {this, "UseTimeCutUpperLimit", false, "Do not apply time cut on cells of large significance"};

  Gaudi::Property<bool> m_twoGaussianNoise{this, "TwoGaussianNoise", false, "Use 2-gaussian noise description for TileCal"};
 

  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"};
 

  Gaudi::Property<bool> m_xtalkEM2 {this, "XTalkEM2",
                                    false, "Relax time window (if timing is used) in EM2 when xTalk is present"};

  Gaudi::Property<float> m_xtalkDeltaT {this, "XTalkDeltaT",
                                        15 * CLHEP::ns, "Delta T to add to upper time threshold for EM2 cells affected by xtalk."};
 

  TAGrowing::TACOptionsHolder 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_TOPOAUTOMATONCLUSTERING_H