HIJetConstituentSubtractionTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
// HIJetConstituentSubtractionTool.h
 
#ifndef HIJETREC_HIJETCONSTITUENTSUBTRACTIONTOOL_H
#define HIJETREC_HIJETCONSTITUENTSUBTRACTIONTOOL_H

 
#include <string>
#include "JetRec/JetModifierBase.h"
#include "HIJetRec/HIJetRecDefs.h"
#include "HIJetRec/IHISubtractorTool.h"
#include "HIJetRec/IHIUEModulatorTool.h"
#include "AsgTools/ToolHandle.h"
#include "HIEventUtils/HIEventShapeMapTool.h"
 
#include "StoreGate/ReadHandleKey.h"
#include "StoreGate/WriteHandleKey.h"
 
#include "xAODHIEvent/HIEventShapeContainer.h"
#include "xAODTracking/VertexContainer.h"
 
class HIJetConstituentSubtractionTool : public JetModifierBase
{
 
  ASG_TOOL_CLASS0(HIJetConstituentSubtractionTool);
 
public:
 
  HIJetConstituentSubtractionTool(const std::string& t);
 
  virtual StatusCode initialize() override;

  virtual StatusCode modify(xAOD::JetContainer& jets) const override;

  virtual int modifyJet(xAOD::Jet&) const override {return 1;};
 
private:
 
  // Migration to data handles
  SG::ReadHandleKey< xAOD::HIEventShapeContainer > m_eventShapeKey { this, "EventShapeKey", "", "The input HI Event Shape"};
 
  //That looks useless. commented out for the moment
  //std::string m_modulation_key;
  Gaudi::Property< std::string > m_momentName { this, "MomentName", HIJetRec::subtractedJetState(), "Subtracted Jet Kineamtics are stored using this string like a signal/state moment" }  ;

  Gaudi::Property< bool > m_momentOnly { this, "SetMomentOnly", true,
          "If this flag is set, the primary jet kinematics are also set to reflect this subtraction eventually do this w/ a signal state" }  ;

  ToolHandle<IHISubtractorTool> m_subtractorTool { this, "Subtractor", "HIJetClusterSubtractorTool", "" };
  ToolHandle<IHIUEModulatorTool> m_modulatorTool { this, "Modulator" , "HIUEModulatorTool ", "" };
  ToolHandle<IHIEventShapeMapTool> m_eventShapeMapTool { this, "EventShapeMapTool", "HIEventShapeMapTool", "Handle to Event Shape Map Tool"};
 
  Gaudi::Property< bool > m_originCorrection { this, "ApplyOriginCorrection", false, "Apply Origin Correction boolean switch"};
 
protected:
  inline const SG::ReadHandleKey< xAOD::HIEventShapeContainer >& EventShapeKey()  { return m_eventShapeKey; };
  //That looks useless. commented out for the moment
  //inline std::string ModulationKey() const {return m_modulation_key;};
  inline const std::string& momentName() const { return m_momentName; };
  inline bool momentOnly() const { return m_momentOnly; };
 
  inline void setEventShapeKey( const SG::ReadHandleKey< xAOD::HIEventShapeContainer >& key ) { m_eventShapeKey=key; };
  inline void setMomentName(const std::string& key) { m_momentName=key; };
  inline void setMomentOnly(bool x) { m_momentOnly=x; };
 
};
 
#endif