TrackCaloClusterTool.h

Go to the documentation of this file.

// this file is -*- C++ -*-
/*
  Copyright (C) 2020 CERN for the benefit of the ATLAS collaboration
*/
 
 
#ifndef TRACKCALOCLUSTERREC_TRACKCALOCLUSTERRECTOOLS_TRACKCALOCLUSTER_H
#define TRACKCALOCLUSTERREC_TRACKCALOCLUSTERRECTOOLS_TRACKCALOCLUSTER_H
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "xAODPFlow/PFOContainer.h"
#include "xAODPFlow/FlowElementContainer.h"
#include "StoreGate/ReadDecorHandleKey.h"
 
#include "TrackCaloClusterRecInterfaces/ITrackCaloClusterTool.h"
#include "TrackVertexAssociationTool/ITrackVertexAssociationTool.h"
#include "TrackCaloClusterRecInterfaces/IClusterFilterTool.h"
 
 
 
class TrackCaloClusterBaseTool : virtual public ITrackCaloClusterTool, public AthAlgTool {
public:
  TrackCaloClusterBaseTool(const std::string&,const std::string&,const IInterface*);
  virtual ~TrackCaloClusterBaseTool();
 
  virtual StatusCode initialize() override ;
 
  virtual StatusCode fillTCC(xAOD::FlowElementContainer* container, const TrackCaloClusterInfo & tccInfo ) const override =0;
    
protected:    
 
  ToolHandle<CP::ITrackVertexAssociationTool> m_trackVertexAssoTool {this ,"TrackVertexAssoTool", ""};
  
  Gaudi::Property<bool> m_useEnergy {this, "UseEnergy", false, "if false will use pT for weights evaluation"};
 
 
  SG::ReadDecorHandleKey<xAOD::TrackParticleContainer> m_assoClustersKey{this, "AssoClustersDecor", "TCCAssoClusters", "Key to access clusters associated to a track. IMPORTANT must be constistent with the TrackParticleContainer the parent alg will operate on"};
  
 
  
  SG::ReadDecorHandleKey<xAOD::TrackParticleContainer> m_caloEntryParsDecor {this, "CaloEntryParsDecorKey" , "","IMPORTANT must be constistent with the TrackParticleContainer the parent alg will operate on, REQUIRED if SaveDetectorEta or DoOriginCorrection, else leave blank so the scheduler won't require it unnecessarily."};
 
  Gaudi::Property<bool> m_saveDetectorEta {this, "SaveDetectorEta", false, ""};       
};
 
 
 
class TCCCombinedTool : public TrackCaloClusterBaseTool {
public:
  TCCCombinedTool(const std::string&,const std::string&,const IInterface*);
  virtual ~TCCCombinedTool() {}
 
  virtual StatusCode fillTCC(xAOD::FlowElementContainer* container, const TrackCaloClusterInfo & tccInfo ) const override;
 
protected:  
  // enable origin correction
  Gaudi::Property<bool> m_doOriginCorrection {this, "DoOriginCorrection", false, ""};
  Gaudi::Property<bool> m_storeCorrectedPosition{this, "StoreCorrectedPosition", false, ""};
};
 
 
class TCCChargedTool : public TrackCaloClusterBaseTool {
public:
  TCCChargedTool(const std::string&,const std::string&,const IInterface*);
 
  virtual StatusCode fillTCC(xAOD::FlowElementContainer* container, const TrackCaloClusterInfo & tccInfo ) const override;
 
protected:
  
};
 
 
 
class TCCNeutralTool : public TrackCaloClusterBaseTool {
public:
  TCCNeutralTool(const std::string&,const std::string&,const IInterface*);
 
  virtual StatusCode fillTCC(xAOD::FlowElementContainer* container, const TrackCaloClusterInfo & tccInfo ) const override ;
  virtual StatusCode initialize() override;
 
protected:
  ToolHandle<IClusterFilterTool> m_clusterFilterTool {this, "ClusterFilterTool", ""};
  bool m_applyFilter = false ; // set automatically according to ClusterFilterTool
};
 
 
 
class UFOTool : public TrackCaloClusterBaseTool {
public:
  UFOTool(const std::string&,const std::string&,const IInterface*);
  virtual StatusCode initialize() override;// force override of base class to add extra handles  
  virtual StatusCode fillTCC(xAOD::FlowElementContainer* container, const TrackCaloClusterInfo & tccInfo ) const override;
 
protected:
 
  SG::ReadHandleKey<xAOD::FlowElementContainer> m_inputPFOHandle {this, "InputPFO", "CHSParticleFlowObjects", ""};
  // no need for a ReadDecorHandleKey here : access to this deco is optional (tested through is isAvailable, see TCCHelpers.h)  
  Gaudi::Property<std::string> m_orig_pfo{this, "OriginPFO", "originalObjectLink", "Key to access original un-modified pfo"};
 
  Gaudi::Property<float> m_clusterEcut{this , "ClusterECut", 0, " Impotant !! : must be the same value as in TrackCaloClusterInfoUFOAlg"};
};
 
#endif // TRACKCALOCLUSTERREC_TRACKCALOCLUSTERRECTOOLS_PARTICLETOCALOEXTRAPOLATIONTOOL_H