InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TRACKVERTEXASSOCIATIONTOOL_H
#define TRACKVERTEXASSOCIATIONTOOL_H
 
// Includes from this package
#include "TrackVertexAssociationTool/ITrackVertexAssociationTool.h"
#include "TrackVertexAssociationTool/TrackVertexAssociationMap.h"
 
// Framework includes
#include "AsgTools/AsgTool.h"
#include "AsgTools/CurrentContext.h"
#include "AsgTools/PropertyWrapper.h"
#include "AthLinks/ElementLink.h"
#include "AsgDataHandles/ReadHandleKey.h"
#include "AsgDataHandles/ReadDecorHandleKey.h"
#include "AsgDataHandles/ReadDecorHandle.h"
 
// EDM includes
#include "xAODEventInfo/EventInfo.h"
#include "xAODTracking/TrackParticleContainer.h"
#include "xAODTracking/TrackParticleContainerFwd.h"
#include "xAODTracking/VertexFwd.h"
#include "xAODTracking/VertexContainerFwd.h"
 
// STL includes
#include <memory>
#include <string>
#include <vector>
 
namespace CP {
 
 
  class TrackVertexAssociationTool
    : public asg::AsgTool, virtual public ITrackVertexAssociationTool
  {
 
    ASG_TOOL_CLASS(TrackVertexAssociationTool, ITrackVertexAssociationTool)
 
    
    // Public methods:
  public:
 
 
    typedef SG::AuxElement::ConstAccessor<std::vector<ElementLink<xAOD::VertexContainer>>> AMVFVerticesAcc;
    typedef SG::AuxElement::ConstAccessor<std::vector<float>> AMVFWeightsAcc;
 
    class WorkingPoint {
    public:
      virtual ~WorkingPoint() = default;
      virtual bool apply(const xAOD::TrackParticle* trk, const xAOD::Vertex* vtx, const xAOD::EventInfo* evt,
        const AMVFVerticesAcc& vtxDeco, const AMVFWeightsAcc& wgtDeco) const = 0;
    };
 
 
    TrackVertexAssociationTool(const std::string& name);
 
    virtual StatusCode initialize() override;
 
    virtual bool isCompatible(const xAOD::TrackParticle& trk, const xAOD::Vertex& vx) const override;
    virtual bool isCompatible(const xAOD::TrackParticle& trk) const override;
 
    virtual xAOD::TrackVertexAssociationMap getMatchMap(std::vector<const xAOD::TrackParticle*>& trk_list, std::vector<const xAOD::Vertex*>& vx_list) const override;
    virtual xAOD::TrackVertexAssociationMap getMatchMap(const xAOD::TrackParticleContainer& trkCont, const xAOD::VertexContainer& vxCont) const override;
 
    virtual ElementLink<xAOD::VertexContainer> getUniqueMatchVertexLink(const xAOD::TrackParticle& trk, const xAOD::VertexContainer& vxCont) const override;
    virtual const xAOD::Vertex* getUniqueMatchVertex(const xAOD::TrackParticle& trk, std::vector<const xAOD::Vertex*>& vx_list) const override;
 
    virtual xAOD::TrackVertexAssociationMap getUniqueMatchMap(std::vector<const xAOD::TrackParticle*>& trk_list, std::vector<const xAOD::Vertex*>& vx_list) const override;
    virtual xAOD::TrackVertexAssociationMap getUniqueMatchMap(const xAOD::TrackParticleContainer& trkCont , const xAOD::VertexContainer& vxCont) const override;
 
    // Private data:
  private:
 
    bool isMatch(const xAOD::TrackParticle& trk, const xAOD::Vertex& vx, const xAOD::EventInfo* evtInfo = nullptr) const;
 
    template <typename T, typename U>
    xAOD::TrackVertexAssociationMap getMatchMapInternal(T& trk_list, U& vx_list) const;
 
    template <typename T, typename U>
    xAOD::TrackVertexAssociationMap getUniqueMatchMapInternal(T& trk_list, U& vx_list) const;
 
    template <typename T>
    const xAOD::Vertex* getUniqueMatchVertexInternal(const xAOD::TrackParticle& trk, T& vx_list) const;
 
    Gaudi::Property<std::string> m_wp{this, "WorkingPoint", "Old_Nominal", 
                                      "Working point to operate on."};
 
    Gaudi::Property<float> m_d0_cut{this, "d0_cut", -1.,
                                   "Cut on d0. Not applied if set to -1."};
 
    Gaudi::Property<bool> m_use_d0sig{this, "use_d0sig", false, 
                                      "Flag to cut on d0sig instead of d0."};
 
    Gaudi::Property<float> m_d0sig_cut{this, "d0sig_cut", -1., 
                                       "Cut on d0Sig. Not applied if set to -1."};
 
    Gaudi::Property<float> m_dzSinTheta_cut{this, "dzSinTheta_cut", -1.,
                                          "Cut on |dz*sinTheta| (in mm). Not applied if set to -1." };
 
    Gaudi::Property<bool> m_doUsedInFit{this, "doUsedInFit", false,
                          "Control whether to allow for a MatchStatus of UsedInFit."};
 
    Gaudi::Property<bool> m_doPVPriority{this, "doPVPriority", false, 
                        "Control whether to give priority to matching to PV instead of closest vertex."};
 
    Gaudi::Property<bool> m_requirePriVtx{this, "requirePriVtx", false,
      "Control whether a vertex must be VxType::PriVtx in order for a track (not UsedInFit) to be uniquely matched to it."};
 
    Gaudi::Property<std::string> m_hardScatterDeco{this, "HardScatterLinkDeco", "hardScatterVertexLink"};
 
    SG::ReadHandleKey<xAOD::TrackParticleContainer> m_trkKey{this, "TrackContName", "InDetTrackParticles"};
 
 
  private:
 
 
    SG::ReadHandleKey<xAOD::EventInfo> m_eventInfo {this, "EventInfo", "EventInfo", "EventInfo key"};
 
    Gaudi::Property<std::string> m_vtxDecoName{this, "AMVFVerticesDeco", "TTVA_AMVFVertices",
                                  "The per-track decoration name of the vector of AMVF used-in-fit vertex ElementLinks."};
    SG::ReadDecorHandleKey<xAOD::TrackParticleContainer> m_vtxDecoKey{this, "AMVFVerticesKey", "" , "Overwritten with the <AMVFVerticesDeco> property"};
    std::unique_ptr<AMVFVerticesAcc> m_vtxDecoAcc{nullptr};
 
    Gaudi::Property<std::string> m_wgtDecoName{this, "AMVFWeightsDeco", "TTVA_AMVFWeights",
                              "The per-track decoration name of the vector of AMVF used-in-fit annealing weights." };
    SG::ReadDecorHandleKey<xAOD::TrackParticleContainer> m_wgtDecoKey{this, "MVWeightKey", "" , "Overwritten with the <AMVFWeightsDeco> property"};
    std::unique_ptr<AMVFWeightsAcc> m_wgtDecoAcc{nullptr};
 
    SG::ReadDecorHandleKey<xAOD::EventInfo> m_hardScatterDecoKey{this, "HardScatterLinkDecoKey" ,"" , 
                                            "Will be overwritten with the <HardScatterLinkDeco> property"};
 
    std::unique_ptr<WorkingPoint> m_applicator{nullptr};
 
 
  };
 
} // namespace CP
 
#endif // TRACKVERTEXASSOCIATIONTOOL_H