SoftKillerWeightTool.h

Go to the documentation of this file.

// this file is -*- C++ -*- 
 
/*
  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
 
// SoftKillerWeightTool.h
 
#ifndef JETRECTOOLS_SOFTKILLERWEIGHTTOOL_H
#define JETRECTOOLS_SOFTKILLERWEIGHTTOOL_H
 
 
 
// \class SoftKillerWeightTool
// \author Jennifer Roloff
// \date November 2015
//
// This is the tool to reweight clusters according to the SoftKiller
// algorithm
// It creates a new cluster collection based on the original clusters
// and the grid spacing for SK
//
//
// Properties are as follows:
//   OutputContainer: Name of the output cluster collection
//   InputCollection: Name of the input cluster collection. 
//   GridSize: The grid size that should be applied for the SK 
//       algorithm. Suggested values between 0.3 and 0.6
//   SKRapMin: The minimum (absolute) rapidity over which to calculate SK
//   SKRapMax: The maximum (absolute) rapidity over which to calculate SK
//   SKRapMinApplied: The minimum (absolute) rapidity over which to apply SK
//   SKRapMaxApplied: The maximum (absolute) rapidity over which to apply SK
//   isCaloSplit: If false, SK is run the same on all clusters. If
//       true, SK is run separately for clusters in the ECal and the
//       HCal.
//   ECalGridSize: Only necessary if isCaloSplit == true. The SK grid spacing
//       used for the ECal.
//   HCalGridSize: Only necessary if isCaloSplit == true. The SK grid spacing
//     used for the HCal.
//
//
// This tool may be used on its own or in sequence with other pileup
// suppression methods. For central jets, it is suggested that the
// input collection be clusters with area subtraction (such as Voronoi)
// applied.
//
 
#include <string>
#include <utility>
#include "JetRecTools/JetConstituentModifierBase.h"
#include "xAODBase/IParticleContainer.h"
 
#include "fastjet/PseudoJet.hh"
 
class SoftKillerWeightTool : public JetConstituentModifierBase{
  ASG_TOOL_CLASS(SoftKillerWeightTool, IJetConstituentModifier)
 
  public:
  
  SoftKillerWeightTool(const std::string& name);
 
  // Check that the configuration is sane
  StatusCode initialize();
 
private:
  // Implement the correction
  StatusCode process_impl(xAOD::IParticleContainer* cont) const; 
 
  // Detailed implementation methods where clusters in
  // both calorimeters are treated consistently
  float calculateWeight(xAOD::IParticle& part, double minPt) const;
  double getSoftKillerMinPt(xAOD::IParticleContainer& cont) const;
 
  // Detailed implementation methods where clusters in
  // ECAL and HCAL are treated independently
  float calculateSplitWeight(xAOD::IParticle& part, double minPtECal, double minPtHCal) const;
  std::pair<double,double> getSoftKillerMinPtSplit(xAOD::IParticleContainer& cont) const;
 
  double findMinPt(const std::vector<fastjet::PseudoJet> &partSK) const;
  std::vector<fastjet::PseudoJet> makeSKParticles(const std::vector<fastjet::PseudoJet>& partPJ) const;
 
 
private:
  //mutable int m_initCount;
  float m_lambdaCalDivide;
 
  // Properties.
  bool m_isCaloSplit; 
  float m_gridSpacing; 
  float m_eCalGrid;
  float m_hCalGrid;
  float m_rapmin;
  float m_rapmax;
  float m_rapminApplied;
  float m_rapmaxApplied;
  bool m_ignoreChargedPFOs;
        
};
 
 
#endif