IPTag.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef JETTAGTOOLS_IPTAG_H
#define JETTAGTOOLS_IPTAG_H
 
/******************************************************
    @class IPTag
    b-jet tagger based on 2D or 3D impact parameter
    @author CPPM Marseille
********************************************************/
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "GaudiKernel/ToolHandle.h"
#include "JetTagTools/ITagTool.h"
#include <string>
#include <vector>
#include <atomic>
 
namespace Trk  { class ITrackToVertexIPEstimator; }
 
namespace Analysis { 
 
  class NewLikelihoodTool;
  class HistoHelperRoot;
  class TrackSelector;
  class TrackGrade;
  class TrackGradePartition;
  class SVForIPTool;
  class ITrackGradeFactory;
  
 
  class IPTag : public extends<AthAlgTool, ITagTool>
  {
  public:
    IPTag(const std::string&,const std::string&,const IInterface*);
      
    virtual ~IPTag();
    virtual StatusCode initialize() override;
    virtual StatusCode finalize() override;
      
 
    virtual StatusCode tagJet(const xAOD::Vertex& priVtx,
                              const xAOD::Jet& jetToTag,
                              xAOD::BTagging& BTag,
                              const std::string &jetName) const override;
 
    void trackWeight(const std::string& jetAuthor, const TrackGrade& grade, double sa0, double sz0,
                     double & twb, double & twu, double & twc) const;
    
    virtual void finalizeHistos() override {};
    
  private:      
 
    std::string    m_runModus;          
 
    std::string m_xAODBaseName;
      
    HistoHelperRoot* m_histoHelper;
 
    bool m_flipIP;              // reverse impact parameter signs for negative tag calibration method
    bool m_flipZIP;             // reverse Z impact parameter signs for negative tag calibration method
    bool m_usePosIP;            // use tracks with positive impact parameter for tagging
    bool m_useNegIP;            // use tracks with negative impact parameter for tagging
    bool m_useZIPSignForPosNeg; // use Z impact parameter sign as well to select Pos and Neg tracks
    bool m_use2DSignForIP3D;    // force to use 2D IP sign even for IP3D IP
    bool m_useD0SignForZ0;      // force to use transverse IP sign for Z impact parameter for IP3D
    bool m_sortPt;              // sorting input tracks by pt
    bool m_sortD0sig;           // sorting input tracks by d0sig
    bool m_sortZ0D0sig;         // sorting input tracks by z0d0sig
    bool m_RejectBadTracks;
    bool m_SignWithSvx;
    bool m_checkOverflows;      // if true put the overflows in the first/last bins
    bool m_doForcedCalib;
    bool m_useCHypo;
    bool m_unbiasIPEstimation;  // remove track from vertex when computing IP
 
    // make the output smaller
    bool m_storeTrackParticles;
    bool m_storeIpValues;
    bool m_storeTrackParameters;
 
 
    std::string m_trackAssociationName;
     
    std::string m_impactParameterView;
    
    std::string m_forcedCalibName;
 
    std::string m_referenceType;     // label to use for reference mode
    double m_purificationDeltaR;     // skip light jets with heavy flavor in this cone
    double m_jetPtMinRef;            // min cut on jet pT for reference
 
    std::string m_secVxFinderName;
 
    int m_NtrkMin;          // minimum number of tracks to consider
    int m_NtrkMax;          // maximum number of tracks to consider (min will always prevail)
    float m_trkFract;       // fraction of total tracks to consider (min will alwayt prevail)
    std::string m_sortOption; // steering option
 
 
    std::vector<std::string> m_hypotheses; // hypotheses: b | u
    std::vector<std::string>          m_trackGradePartitionsDefinition;
    std::vector<TrackGradePartition*> m_trackGradePartitions;
    std::vector<std::string> m_jetCollectionList;
    
    
 
    ToolHandle< TrackSelector >        m_trackSelectorTool;
 
    ToolHandle< NewLikelihoodTool >    m_likelihoodTool;
 
    ToolHandle< SVForIPTool >          m_SVForIPTool;
 
    ToolHandle< ITrackGradeFactory > m_trackGradeFactory;
 
    ToolHandle< Trk::ITrackToVertexIPEstimator > m_trackToVertexIPEstimator;
 
    // VD: for debugging
    mutable std::atomic<int> m_nbjet;
    mutable std::atomic<int> m_ncjet;
    mutable std::atomic<int> m_nljet;
  
  }; // End class
 
} // End namespace 
 
#endif