PUSplitPufitFex.h

Go to the documentation of this file.

/*
 * Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
 */
 
/******************************************************************************
 * @package Trigger/TrigAlgorithms/TrigEFMissingET
 * @class   PUSplitPufitFex
 *
 * @brief Fex class for the pufit algorithm, where inputs are split into 
 * pile-up categories
 * @author Jon Burr
 *****************************************************************************/
 
#ifndef TRIGEFMISSINGET_PUSPLITPUFITFEX_H
#define TRIGEFMISSINGET_PUSPLITPUFITFEX_H
 
#include "FexBase.h"
#include "TrigEFMissingET/SignedKinematics.h"
#include "xAODBase/IParticleContainer.h"
#include "StoreGate/ReadDecorHandleKey.h"
#include "TrigEFMissingET/PUClassification.h"
#include "Gaudi/Property.h"
 
namespace HLT
{
  namespace MET
  {
    /**************************************************************************
     * @class PUSplitPufitFex
     * 
     * Class to calculate pufit MET using pu-split inputs
     * 
     * Uses a generalised pufit technique. The inputs are classified using the
     * @see PUClassification enum and the algorithm is able to treat them
     * differently
     *************************************************************************/
    class PUSplitPufitFex : public FexBase
    {
    public:
      PUSplitPufitFex(const std::string &name, ISvcLocator *pSvcLocator);

      virtual StatusCode initialize() override;
 
    private:
      /************************************************************************
       * Properties
       ***********************************************************************/
      SG::ReadHandleKey<xAOD::IParticleContainer> m_inputKey{
          this, "InputName", "", "The input particle collection"};
      SG::ReadDecorHandleKey<xAOD::IParticleContainer> m_inputCategoryKey{
          this, "InputCategoryName", "PUCategory",
          "The name of PU classification auxdata"};

      Gaudi::Property<float> m_nSigma{
          this, "NSigma", 5, "Set the threshold at mean + NSigma*variance"};

      Gaudi::Property<float> m_maxEta{
          this, "MaxEta", 5, "The maximum eta range"};

      Gaudi::Property<std::size_t> m_nEtaBins{
          this, "NEtaBins", 14, "The number of eta bins"};
      Gaudi::Property<std::size_t> m_nPhiBins{
          this, "NPhiBins", 8, "The number of phi bins"};

      Gaudi::Property<float> m_trimFraction{
          this, "TrimFraction", 0.9,
          "The fraction of bins to use when calculating the mean and variance"};

      Gaudi::Property<float> m_caloNoise{
          this, "CaloNoise", 50,
          "The coefficient of the noise term in the calorimeter resolution estimate [MeV]"};

      Gaudi::Property<float> m_caloStoch{
          this, "CaloStochastic", 15.81,
          "The coefficient of the stochastic term in the calorimeter resolution estimate [MeV^1/2]"};

      Gaudi::Property<float> m_constraintImportance{
          this, "ConstraintImportance", 1,
          "The relative importance of the two constraints to the fit"};

      Gaudi::Property<std::size_t> m_neutralThresholdMode{
          this, "NeutralThresholdMode", PUClassification::All,
          "Which towers to use to calculate mean/variance and the masking threshold"};

      Gaudi::Property<bool> m_subtractCPUFromMean{
          this, "SubtractCPUFromMean", false,
          "Whether to remove the cPU component from the expected pileup value"};
      /************************************************************************
       * Internal functions
       ***********************************************************************/
      virtual StatusCode fillMET(
          xAOD::TrigMissingET &met,
          const EventContext &context,
          MonGroupBuilder &monitors) const override;

      double getSigma(const SignedKinematics &kin) const;
    }; //> end class PUSplitPufixFex
  }    // namespace MET
} // namespace HLT
 
#endif //> !TRIGEFMISSINGET_PUSPLITPUFITFEX_H