JetCleaningTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef JETSELECTORTOOLS_JETCLEANINGTOOL_H
#define JETSELECTORTOOLS_JETCLEANINGTOOL_H

 
// Stdlib includes
#include <string>
#include <vector>
#include <unordered_map>
 
// Base classes
#include "AsgTools/AsgTool.h"
#include "AsgTools/PropertyWrapper.h"
#include "AsgDataHandles/ReadDecorHandleKey.h"
#include "AsgDataHandles/WriteDecorHandleKey.h"
#include "JetInterface/IJetDecorator.h"
#include "JetInterface/IJetSelector.h" 
 
 
// The xAOD jet type
#include "xAODJet/Jet.h"
 
// Return object
#include "PATCore/AcceptInfo.h"
#include "PATCore/AcceptData.h"
 
namespace JCT { class HotCell; }
 
class JetCleaningTool : public asg::AsgTool, virtual public IJetDecorator, virtual public IJetSelector
{
 
  ASG_TOOL_CLASS2(JetCleaningTool, IJetDecorator, IJetSelector)
 
public:
  enum CleaningLevel
  {
    SuperLooseBadLLP,
    VeryLooseBadLLP,
    LooseBad,
    LooseBadLLP,
    LooseBadTrigger,
    TightBad,
    UnknownCut
  };

  JetCleaningTool(const std::string &name = "JetCleaningTool");

  JetCleaningTool(const CleaningLevel alevel, const bool doUgly = false);

  JetCleaningTool(const std::string &name, const CleaningLevel alevel, const bool doUgly = false);

  virtual ~JetCleaningTool();

  virtual StatusCode initialize() override;
 
  const asg::AcceptInfo &getAcceptInfo() const
  {
    return m_accept;
    }

    asg::AcceptData accept( const int isJetClean, const int fmaxIndex ) const;
    
    asg::AcceptData accept( const int isJetClean,
                                              const double sumpttrk, //in MeV, same as sumpttrk
                                              const double fmax,
                          const double eta,
                          const double pt, 
                                              const int    fmaxIndex ) const;

    asg::AcceptData accept( const double emf,
                 const double hecf,
                 const double larq,
                 const double hecq,
                 const double sumpttrk, //in MeV, same as sumpttrk
                 const double eta,      //emscale Eta  
                 const double pt,       //in MeV, same as sumpttrk
                 const double fmax,
                 const double negE ,     //in MeV
                 const double AverageLArQF,
                 const int    fMaxIndex     ) const;

    asg::AcceptData accept( const xAOD::Jet& jet) const;
 
    int keep(const xAOD::Jet& jet) const final
    { return static_cast<bool>(accept(jet)); }
 
    virtual StatusCode decorate(const xAOD::JetContainer &jets) const override;

    bool containsHotCells( const xAOD::Jet& jet, const unsigned int runNumber) const;

    static CleaningLevel getCutLevel( const std::string& );
    static std::string   getCutName( const CleaningLevel );
 
  private:
    
    Gaudi::Property<std::string> m_cutName{this, "CutLevel", "" }; 
    CleaningLevel m_cutLevel{LooseBad};
    Gaudi::Property<bool> m_doUgly{this, "DoUgly", false};
    Gaudi::Property<bool> m_useDecorations{this, "UseDecorations", true};
    Gaudi::Property<bool> m_useLooseDecorForTightCut{this, "UseLooseDecorForTightCut", false};
    SG::ConstAccessor<char> m_acc_jetClean{"DFCommonJets_jetClean_LooseBad"};
  
    //
    Gaudi::Property<std::string> m_jetContainerName{this, "JetContainer", "", "SG key for input jet container"};
    SG::WriteDecorHandleKey<xAOD::JetContainer> m_jetCleanKey{this, "JetCleaningName", "isClean", "SG key for output jet cleaning decoration"};
    asg::AcceptInfo m_accept;

    Gaudi::Property<std::string> m_hotCellsFile{this, "HotCellsFile", ""};
    std::unordered_map<unsigned int, std::vector<std::unique_ptr<JCT::HotCell>>> m_hotCellsMap;
    StatusCode readHotCells();
    
    void missingVariable(const std::string& varName) const;
 
}; // End: class definition
 
 
 
#endif