IInDetTrackSelectionTool.h

Go to the documentation of this file.

// -*- c++ -*-
 
/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef INDETTRACKSELECTIONTOOL_IINDETTRACKSELECTIONTOOL_H
#define INDETTRACKSELECTIONTOOL_IINDETTRACKSELECTIONTOOL_H
 
// Framework include(s):
#include "PATCore/IAsgSelectionTool.h"
 
// EDM include(s):
#include "xAODTracking/TrackParticleFwd.h"
#include "xAODTracking/VertexFwd.h"
 
// forward declarations
namespace asg {
  class AcceptInfo;
  class AcceptData;
}
#ifndef XAOD_ANALYSIS
namespace Trk {
  class Track;
  class Vertex;
  class TrackParticleBase;
  class FitQuality;
}
#endif
 
namespace InDet {
 
  // define the flags to select cut level of tool
  // see https://twiki.cern.ch/twiki/bin/view/AtlasProtected/InDetTrackingPerformanceGuidelines
  // if you add levels, make sure to add entries to the map in InDetTrackSelectionTool.cxx
  // so that they can be set from athena as well.
  enum class
  CutLevel {
    NoCut, Loose, LoosePrimary, TightPrimary,
      LooseMuon, LooseElectron, LooseTau,
      MinBias, HILoose, HITight,
      HITightOptimized, HILooseOptimized
      };
  
  class IInDetTrackSelectionTool : public virtual IAsgSelectionTool
{ 
    ASG_TOOL_INTERFACE( InDet::IInDetTrackSelectionTool )
 
  public:
    virtual StatusCode initialize() = 0;
    virtual StatusCode finalize() = 0;

    virtual const asg::AcceptInfo& getAcceptInfo() const = 0;

    virtual  asg::AcceptData accept( const xAOD::IParticle* p ) const = 0;

    virtual  asg::AcceptData accept( const xAOD::TrackParticle& track,
                                     const xAOD::Vertex* vertex = 0 ) const = 0;
 
#ifndef XAOD_ANALYSIS
    virtual  asg::AcceptData accept( const Trk::Track& track,
                                     const Trk::Vertex* vertex = 0 ) const = 0;
#endif

    // This function should not be public in Athena, as the cut level should be 
    //   set in the job options. Allow it for now, so as to not break compatibility
    virtual void setCutLevel( InDet::CutLevel level, bool overwrite = true )
      __attribute__ ((deprecated("The cut level should be set in the job options through the \"CutLevel\" property.")))
      = 0;
 
  }; // class IInDetTrackSelectionTool
 
} // namespace InDet
 
#endif // INDETTRACKSELECTIONTOOL_IINDETTRACKSELECTIONTOOL_H