InDetTrackSmearingTool.h

Go to the documentation of this file.

// -*- c++ -*-
/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef INDETTRACKSYSTEMATICSTOOLS_INDETTRACKSMEARINGTOOL_H
#define INDETTRACKSYSTEMATICSTOOLS_INDETTRACKSMEARINGTOOL_H
 
// Framework include(s):
#include "AsgTools/AsgTool.h"
#include "AsgTools/PropertyWrapper.h"
#include "PATInterfaces/CorrectionTool.h"
#include "PATInterfaces/SystematicVariation.h"
 
//EDM include(s):
#include "xAODTracking/TrackParticleContainer.h"
 
// Local include(s):
#include "InDetTrackSystematicsTools/IInDetTrackSmearingTool.h"
#include "InDetTrackSystematicsTools/InDetTrackSystematicsTool.h"
 
#include <TFile.h>
#include <TH2F.h>
#include <TF2.h>
 
namespace InDet {
 
  class InDetTrackSmearingTool
    : public virtual IInDetTrackSmearingTool
    , public virtual InDetTrackSystematicsTool
    , public virtual CP::CorrectionTool< xAOD::TrackParticleContainer >
  {

    ASG_TOOL_CLASS( InDetTrackSmearingTool, 
            InDet::IInDetTrackSmearingTool )
    public:
    InDetTrackSmearingTool( const std::string& name );

    virtual StatusCode initialize() override;
    virtual CP::CorrectionCode applyCorrection( xAOD::TrackParticle& ID ) override;
    virtual CP::CorrectionCode applyCorrection(
        xAOD::TrackParticle& ID, const CP::SystematicSet& syst) const override;
 
    // we need explicit forwarding calls because CP::CorrectionTool does not have a pure interface
    // this isn't really elegant (ideally these would come automatically) but we'd need IInDetTrackSmearingTool
    //  to inherit from CP::CorrectionTool, which would make it not pure-virtual.
    // at least, forwarding calls are easy enough to read and understand.
    virtual CP::CorrectionCode correctedCopy( const xAOD::TrackParticle& in,
                          xAOD::TrackParticle*& out ) override;
    virtual CP::CorrectionCode applyContainerCorrection( xAOD::TrackParticleContainer& cont ) override;

    virtual bool isAffectedBySystematic( const CP::SystematicVariation& ) const override;
    virtual CP::SystematicSet affectingSystematics() const override;
    virtual CP::SystematicSet recommendedSystematics() const override;
    virtual StatusCode applySystematicVariation( const CP::SystematicSet& ) override;
 
  private:

    CP::CorrectionCode applyCorrectionImpl(xAOD::TrackParticle& track,
                                           const CP::SystematicSet& filtered) const;

    float GetSmearD0Sigma(const xAOD::TrackParticle&,
                          const CP::SystematicSet& filtered) const;
    float GetSmearZ0Sigma(const xAOD::TrackParticle&,
                          const CP::SystematicSet& filtered) const;
 
    // StatusCode initHistogram(TH1*& histogram, std::string rootFileName, std::string histogramName) const;
    // StatusCode initFunction(TF2*& function, std::string rootFileName, std::string functionName) const;
    float readHistogram( const TH2*, float pt, float eta ) const;
 
    // float readHistogram(TH1* histogram, float pt, float eta) const;
    // float readHistograms(std::vector<TH1 *> histogram, float pt, float eta) const;
    // histograms for dead module smearing as a function of p
    std::unique_ptr<TH2> m_smearD0 = nullptr;
    std::unique_ptr<TH2> m_smearZ0 = nullptr;
 
    // allow the user to configure which calibration files to use if desired
    Gaudi::Property<std::string> m_calibFileIP_CTIDE{this, "calibFileIP_CTIDE", ""};
    Gaudi::Property<int> m_seed{this, "Seed", 4,
        "Seed offset mixed with per-track phi/eta hash for deterministic RNG"};
  }; 
 
} 
 
#endif