METRecoTool.h

Go to the documentation of this file.

 
/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
// METRecoTool.h 
// Header file for class METRecoTool
//
// This is a scheduler for the MET Reconstruction, and sets up
// the sequence in which the individual terms are constructed.
//
//  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
//
// Author: P Loch, S Resconi, TJ Khoo
#ifndef METRECONSTRUCTION_METRECOTOOL_H
#define METRECONSTRUCTION_METRECOTOOL_H 1
 
// STL includes
#include <string>
 
// FrameWork includes
#include "AsgTools/ToolHandle.h"
#include "AsgTools/AsgTool.h"
#include "CxxUtils/checker_macros.h"
 
 
// METRecoInterface includes
#include "METRecoInterface/IMETRecoTool.h"
#include "METRecoInterface/IMETToolBase.h"
 
// EDM includes
#include "xAODMissingET/MissingETContainer.h"
 
// Timing
#include "TStopwatch.h"
 
// Forward declaration
 
namespace met{
  /* @brief Top-level class scheduling MET reconstruction tools
   *
   *  @author  Peter Loch <loch_AT_physics.arizona.edu>
   *  @author  Silvia Resconi <Silvia.Resconi_AT_cern.ch>
   *  @author  Teng Jian Khoo <Teng.Jian.Khoo_AT_cern.ch>
   *  
   *  @date    Nov. 21, 2013
   *  @version v1.0
   *
   *  The METRecoTool can be called within an Athena algorithm or a ROOT programme
   *  to carry out the reconstruction of a MET configuration, and will produce a
   *  MissingETContainer, the contents of which will be the MissingET objects produced
   *  by the various tools scheduled by METRecoTool.
   *
   */
  class METRecoTool
  //    ^ the (optional) use of TStopwatch makes this not thread-safe
    : public asg::AsgTool,
      virtual public IMETRecoTool
  { 
    // This macro defines the constructor with the interface declaration
    ASG_TOOL_CLASS(METRecoTool, IMETRecoTool)
 
 
    
    // Public methods: 
    public: 
 
    // Constructor with name (does this have to be a non-const
    // std::string and not a const reference?)
    METRecoTool(const std::string& name);
 
    // AsgTool Hooks
    virtual StatusCode initialize();
    virtual StatusCode execute(const EventContext& ctx) const;
    virtual StatusCode finalize();

    // Private data: 
  private: 

    METRecoTool();
 
    // Run the MET tools here
    StatusCode buildMET(xAOD::MissingETContainer* metCont, xAOD::MissingETComponentMap* metMap) const;
 
    // Data members
    bool m_doMetSum{false};
    Gaudi::Property<bool> m_warnOfDupes{this, "WarnIfDuplicate", true};
    SG::WriteHandleKey<xAOD::MissingETContainer> m_contname{this, "METContainer", "MET"};
    SG::WriteHandleKey<xAOD::MissingETComponentMap> m_mapname{this, "METComponentMap", "METMap"};
    Gaudi::Property<std::string> m_metfinalname{this, "METFinalName", ""};
    ToolHandleArray<IMETToolBase> m_metbuilders{this, "METBuilders", {} };
    ToolHandleArray<IMETToolBase> m_metrefiners{this, "METRefiners", {} };
 
    mutable std::atomic<unsigned int> m_nevt{0};
  }; 
 
}
 
#endif //> !METRECONSTRUCTION_METRECOTOOL_H