egammaSuperClusterBuilderBase.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef EGAMMAALGS_EGAMMASUPERCLUSTERBUILDERBASE_H
#define EGAMMAALGS_EGAMMASUPERCLUSTERBUILDERBASE_H
 
//
#include "AthLinks/DataLink.h"
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
#include "GaudiKernel/EventContext.h"
#include "GaudiKernel/SystemOfUnits.h"
#include "GaudiKernel/ToolHandle.h"
//
#include "CaloDetDescr/CaloDetDescrManager.h"
#include "CaloUtils/CaloCellDetPos.h"
//
#include "EgammaAnalysisInterfaces/IegammaMVASvc.h"
#include "egammaInterfaces/IegammaCheckEnergyDepositTool.h"
#include "egammaInterfaces/IegammaCellRecoveryTool.h"
#include "egammaInterfaces/IegammaSwTool.h"
#include "egammaRecEvent/egammaRecContainer.h"
#include "egammaCaloUtils/CookieCutterHelpers.h"
//
#include "xAODCaloEvent/CaloClusterFwd.h"
#include "xAODEgamma/EgammaEnums.h"
#include "xAODTracking/TrackParticleContainerFwd.h"
 
#include <memory>
#include <vector>
 
class CaloDetDescrManager;
class egammaSuperClusterBuilderBase : public AthReentrantAlgorithm
{
protected:
  egammaSuperClusterBuilderBase(const std::string& name,
                                ISvcLocator* pSvcLocator);

  virtual StatusCode initialize() override;

  virtual StatusCode execute(const EventContext &ctx) const override;
  virtual xAOD::EgammaParameters::EgammaType getEgammaRecType(const egammaRec *egRec) const = 0;
  virtual bool egammaRecPassesSelection(const egammaRec *egRec) const;
  virtual StatusCode redoMatching(
    const EventContext &ctx,
    SG::WriteHandle<EgammaRecContainer> &newEgammaRecs
  ) const;
 
  virtual std::vector<std::size_t> searchForSecondaryClusters(
    std::size_t egammaInd,
    const EgammaRecContainer* egammaRecs,
    std::vector<bool>& isUsed) const = 0;
  bool matchesInWindow(const xAOD::CaloCluster* ref,
                       const xAOD::CaloCluster* clus) const;

  std::unique_ptr<xAOD::CaloCluster> createNewCluster(
    const EventContext& ctx,
    const std::vector<const xAOD::CaloCluster*>& clusters,
    const DataLink<CaloCellContainer>& cellCont,
    const CaloDetDescrManager& mgr,
    xAOD::EgammaParameters::EgammaType egType,
    xAOD::CaloClusterContainer* precorrClusters) const;

  bool seedClusterSelection(const xAOD::CaloCluster* clus) const;
 
  // some constants to use
  static constexpr float s_cellEtaSize = 0.025;
  static constexpr float s_cellPhiSize = M_PI / 128.;
  static constexpr float s_TG3Run3E4cellEtaMax = 1.72;
  static constexpr float s_TG3Run3E3cellEtaMin = 1.2;
  static constexpr float s_TG3Run2E4cellEtaMax = 1.6;
  static constexpr float s_TG3Run2E4cellEtaMin = 1.4;
  // Run2 here
  static constexpr float s_ClEtaMinForTG3cell = s_TG3Run2E4cellEtaMin - 0.03;
  static constexpr float s_ClEtaMaxForTG3cell = s_TG3Run3E4cellEtaMax + 0.03;

  Gaudi::Property<float> m_EtThresholdCut{
    this,
    "EtThresholdCut",
    1.5 * Gaudi::Units::GeV,
    "The minimum EM Et required of SEED clusters (not applied to secondaries)"
  };

  SG::ReadHandleKey<EgammaRecContainer> m_inputEgammaRecContainerKey{
    this,
    "InputEgammaRecContainerName",
    "egammaRecCollection",
    "input egammaRec container"
  };
 
  SG::ReadCondHandleKey<CaloDetDescrManager> m_caloDetDescrMgrKey {
    this,
    "CaloDetDescrManager",
    "CaloDetDescrManager",
    "SG Key for CaloDetDescrManager in the Condition Store"
  };

  SG::WriteHandleKey<EgammaRecContainer> m_outputEgammaRecContainerKey {
    this,
    "OutputEgammaRecContainerKey",
    "egammaSuperRecContainer",
    "output egammaRec container"
  };

  SG::WriteHandleKey<xAOD::CaloClusterContainer> m_outputSuperClusterCollectionName {
    this,
    "SuperClusterCollectionName",
    "egammaSuperClusters",
    "output calo cluster container"
  };

  SG::WriteHandleKey<xAOD::CaloClusterContainer> m_precorrClustersKey{ 
    this,
    "precorrClustersName",
    "",
    "optional pre-correction clusters"
  };
 
  // these are calculated search window values
  // half of search window size, converted to units of eta,phi
  float m_searchWindowEtaBarrel = 0.0F;
  float m_searchWindowPhiBarrel = 0.0F;
  float m_searchWindowEtaEndcap = 0.0F;
  float m_searchWindowPhiEndcap = 0.0F;
 
private:
  StatusCode fillClusterConstrained(
    xAOD::CaloCluster& tofill,
    const std::vector<const xAOD::CaloCluster*>& clusters,
    const CookieCutterHelpers::CentralPosition& cp0) const;

  StatusCode addTileGap3CellsinWindow(xAOD::CaloCluster& tofill,
                                      const CaloDetDescrManager& mgr) const;

  StatusCode calibrateCluster(
    const EventContext& ctx,
    xAOD::CaloCluster* newCluster,
    const CaloDetDescrManager& mgr,
    const xAOD::EgammaParameters::EgammaType egType,
    xAOD::CaloClusterContainer* precorrClusters) const;
 
  // window values for the windows
  // in which cells of topoclusters are added
  // half of addCells window size, converted in units of eta/phi
  float m_addCellsWindowEtaBarrel = 0.0F;
  float m_addCellsWindowEtaEndcap = 0.0F;
  // Extra opening in phi for L0,L1
  float m_extraL0L1PhiSize = 0.0F;
  // Extra opening in eta for L3 cells
  float m_extraL3EtaSize = 0.0F;

  Gaudi::Property<bool> m_linkToConstituents{
    this,
    "LinkToConstituents",
    true,
    "Link sister clusters to new cluster"
  };

  Gaudi::Property<bool> m_useExtendedTG3{
    this,
    "UseExtendedTG3",
    false,
    "Extend TG3 definition from |eta| = 1.2 to |eta| = 1.72"
  };

  Gaudi::Property<int> m_searchWindowEtaCellsBarrel{
    this,
    "SearchWindowEtaCellsBarrel",
    5,
    "Number of cells in eta of window in which to search for topoclusters"
  };

  Gaudi::Property<int> m_searchWindowPhiCellsBarrel{
    this,
    "SearchWindowPhiCellsBarrel",
    5,
    "Number of cells in phi of window in which to search for topoclusters"
  };

  Gaudi::Property<int> m_searchWindowEtaCellsEndcap{
    this,
    "SearchWindowEtaCellsEndcap",
    5,
    "Number of cells in eta of window in which to search for topoclusters"
  };

  Gaudi::Property<int> m_searchWindowPhiCellsEndcap{
    this,
    "SearchWindowPhiCellsEndcap",
    5,
    "Number of cells in phi of window in which to search for topoclusters"
  };

  Gaudi::Property<int> m_addCellsWindowEtaCellsBarrel{
    this,
    "AddCellsWindowEtaCellsBarrel",
    3,
    "Number of cells in eta of window around topocluster center to add cells"
  };

  Gaudi::Property<int> m_addCellsWindowEtaCellsEndcap{
    this,
    "AddCellsWindowEtaCellsEndcap",
    5,
    "Number of cells in eta of window around topocluster center to add cells"
  };

  Gaudi::Property<int> m_extraL0L1PhiSizeCells{
    this,
    "ExtraL0L1PhiSize",
    1,
    "When adding L0 (PS) and L1 cells in phi, "
    "how much wider (+/- of the value) than the L2 phi size of the "
    "cluster (in L2 cells units) is the acceptance"
  };

  Gaudi::Property<int> m_extraL3EtaSizeCells{
    this,
    "ExtraL3EtaSizeCells",
    0,
    "When adding L3 cells how much wider (+/- 0.5 of the value) "
    "than L2 (in L2 cells "
    "units) is the acceptance in eta"
  };

  ServiceHandle<IegammaMVASvc> m_MVACalibSvc{ this,
                                              "MVACalibSvc",
                                              "egammaMVASvc",
                                              "calibration service" };

  ToolHandle<IegammaSwTool> m_clusterCorrectionTool{
    this,
    "ClusterCorrectionTool",
    "egammaSwTool/egammaswtool",
    "tool that applies cluster corrections"
  };

  ToolHandle<IegammaCheckEnergyDepositTool> m_egammaCheckEnergyDepositTool{
    this,
    "egammaCheckEnergyDepositTool",
    "",
    "Optional tool that performs basic checks of viability of cluster"
  };

  ToolHandle<IegammaCellRecoveryTool> m_egammaCellRecoveryTool{
    this,
    "egammaCellRecoveryTool",
    "",
    "Optional tool that adds cells in L2 or L3 "
    "that could have been rejected by timing cut"
  };
 
};
 
#endif