TrackIsolationTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ISOLATIONTOOL_TRACKISOLATIONTOOL_H
#define ISOLATIONTOOL_TRACKISOLATIONTOOL_H
 
#include "AsgTools/AsgTool.h"
#include "AsgTools/PropertyWrapper.h"
#include "AsgTools/ToolHandle.h"
#include "AsgDataHandles/ReadHandleKey.h"
#include "RecoToolInterfaces/ITrackIsolationTool.h"
#include "RecoToolInterfaces/IsolationCommon.h"
 
#ifndef XAOD_ANALYSIS
// #include "GaudiKernel/ToolHandle.h"
#include "ParticlesInConeTools/ITrackParticlesInConeTool.h"
#endif // XAOD_STANDALONE
 
#include "InDetTrackSelectionTool/IInDetTrackSelectionTool.h"
#include "TrackVertexAssociationTool/ITrackVertexAssociationTool.h"
#include "xAODTracking/TrackParticle.h"
#include "xAODTracking/TrackParticleContainer.h"
#include "xAODTracking/VertexContainer.h"
#include "xAODTracking/Vertex.h"
 
#include "xAODPrimitives/IsolationType.h"
 
#include <set>
#include <math.h>
 
// namespace InDet{
//   class IInDetTrackSelectionTool;
// }
 
namespace xAOD {
 
  class TrackIsolationTool: public asg::AsgTool,
    virtual public ITrackIsolationTool {
    ASG_TOOL_CLASS( TrackIsolationTool, ITrackIsolationTool )
  public:
      typedef std::vector< const TrackParticle* > TPVec;
      
      // struct to cache inputs to simplify interfaces, for internal usage only
      struct TrackIsolationInput {
    TrackIsolationInput(const IParticle* particle_,TrackCorrection corrections_,
                const Vertex* vertex_,
                const std::set<const TrackParticle*>* exclusionSet_, float maxRadius_=0.4) :
      particle(particle_),
      corrections(corrections_),
      vertex(vertex_),
      exclusionSet(exclusionSet_),
          maxRadius(maxRadius_), 
        ptvarconeRadiusSquared(particle->pt() > 0 ? pow( 10000. / particle->pt() , 2 ) : maxRadius_*maxRadius_) // protection should not be needed... but at some point some 0 pt electrons have been seen...
        {}
    
    const IParticle* particle;                     
    std::vector<float>  coneSizesSquared;          
    TrackCorrection corrections;                   
    const Vertex* vertex;                          
    const std::set<const TrackParticle*>* exclusionSet; 
    float maxRadius;                               
    float ptvarconeRadiusSquared;                  
      };
      
  public:
      TrackIsolationTool(const std::string& name);
      
      virtual ~TrackIsolationTool(void); 
      
      virtual StatusCode initialize() override;
        
      virtual 
      bool trackIsolation( TrackIsolation& result, const IParticle& tp, 
               const std::vector<Iso::IsolationType>& cones, 
               TrackCorrection corrections, 
               const Vertex* vertex = 0, 
               const std::set<const TrackParticle*>* exclusionSet = 0, 
               const TrackParticleContainer* indetTrackParticles = 0 ) const override; 
 
 
  private:
    static constexpr float m_2PI = 2*M_PI;
    
    inline float phiInRange(float phi) const { 
      while (phi >= M_PI) phi -= m_2PI;
      while (phi < -M_PI) phi += m_2PI;
      return phi;
    }

    bool simpleIsolation( TrackIsolationInput& input, TrackIsolation& result, const TrackParticleContainer* indetTrackParticles = 0 ) const;

    bool binnedIsolation( TrackIsolationInput& input, TrackIsolation& result ) const;

    void add( TrackIsolationInput& input, const TrackParticle& tp2, TrackIsolation& result ) const;

    const IParticle* getReferenceParticle(const IParticle& particle) const;

    static void initresult(TrackIsolation& result, TrackCorrection corrlist, unsigned int typesize) ;
 
#ifdef XAOD_ANALYSIS // particlesInCone tool will not be avaible. Write our own...
    bool getparticlesInCone( float eta, float phi, float dr, std::vector< const TrackParticle*>& output ) const;
#endif // XAOD_STANDALONE

    SG::ReadHandleKey<TrackParticleContainer> m_indetTrackParticleLocation {this,
    "TrackParticleLocation", "InDetTrackParticles"};

    Gaudi::Property<bool> m_simpleIsolation{this, "SimpleIsolation", false};
    
    Gaudi::Property<float> m_overlapCone{this, "OverlapCone", 0.1};
 
    float m_overlapCone2 = 0.0F; 

    Gaudi::Property<float> m_coreTrackEtaRange{this,
     "CoreTrackEtaRange", 0.0, "The maximum eta range to consider something a core track"};

    bool m_useLooseTrackCore{false};
#ifndef XAOD_ANALYSIS
    ToolHandle<ITrackParticlesInConeTool> m_tracksInConeTool {this, 
    "TracksInConeTool", "xAOD::TrackParticlesInConeTool/TrackParticlesInConeTool"};
#endif // XAOD_STANDALONE
    ToolHandle<InDet::IInDetTrackSelectionTool> m_trkselTool {this,
    "TrackSelectionTool", "InDet::InDetTrackSelectionTool/TrackSelectionTool"};

    ToolHandle<CP::ITrackVertexAssociationTool> m_ttvaTool{this,
      "TTVATool", "", "Optional track to vertex association tool to filter tracks"};

    bool m_useTTVATool{false};
 
    SG::ReadHandleKey<VertexContainer> m_vertexLocation {this,
    "VertexLocation", "PrimaryVertices"};

    const Vertex* retrieveIDBestPrimaryVertex(const VertexContainer* vtxC) const;
 
  };
 
}   // end of namespace
 
#endif