ITrackMatchingLookup.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef INDETTRACKPERFMON_ITRACKMATCHINGLOOKUP_H
#define INDETTRACKPERFMON_ITRACKMATCHINGLOOKUP_H

 

#include "AsgMessaging/StatusCode.h"

#include <string>
#include <vector>

#include "xAODTracking/TrackParticle.h"
#include "xAODTruth/TruthParticle.h"
 
 
namespace IDTPM {
 
  class ITrackMatchingLookup {
 
  public:

    virtual ~ITrackMatchingLookup() = default;

    virtual unsigned getNmatches( bool getRefN = false ) const = 0;

    const std::string& anaTag() const { return m_anaTag; }
    void anaTag( std::string_view anaTag_s ) {
      m_anaTag = anaTag_s;
    }
    const std::string& chainRoiName() const { return m_chainRoiName; }
    void chainRoiName( std::string_view chainRoiName_s ) {
      m_chainRoiName = chainRoiName_s;
    }

    virtual const xAOD::TrackParticle* getMatchedRefTrack(
        const xAOD::TrackParticle& t ) const = 0;
    virtual const xAOD::TrackParticle* getMatchedRefTrack(
        const xAOD::TruthParticle& t ) const = 0;
    virtual const xAOD::TruthParticle* getMatchedRefTruth(
        const xAOD::TrackParticle& t ) const = 0;
    const xAOD::TruthParticle* getMatchedRefTruth(
        const xAOD::TruthParticle& ) const { return nullptr; };

    virtual const std::vector< const xAOD::TrackParticle* >& getMatchedTestTracks(
        const xAOD::TrackParticle& r ) const = 0;
    virtual const std::vector< const xAOD::TrackParticle* >& getMatchedTestTracks(
        const xAOD::TruthParticle& r ) const = 0;
    virtual const std::vector< const xAOD::TruthParticle* >& getMatchedTestTruths(
        const xAOD::TrackParticle& r ) const = 0;
    const std::vector< const xAOD::TruthParticle* >& getMatchedTestTruths(
        const xAOD::TruthParticle& ) const { return m_nullTruthVec; }

    const xAOD::TrackParticle* getBestMatchedTestTrack(
        const xAOD::TrackParticle& r ) const
    {
      const std::vector< const xAOD::TrackParticle* >& vec =
        getMatchedTestTracks( r );
      return vec.empty() ? nullptr : vec[0];
    }

    const xAOD::TrackParticle* getBestMatchedTestTrack(
        const xAOD::TruthParticle& r ) const
    {
      const std::vector< const xAOD::TrackParticle* >& vec =
        getMatchedTestTracks( r );
      return vec.empty() ? nullptr : vec[0];
    }

    virtual const xAOD::TruthParticle* getBestMatchedTestTruth(
        const xAOD::TrackParticle& r ) const
    {
      const std::vector< const xAOD::TruthParticle* >& vec =
        getMatchedTestTruths( r );
      return vec.empty() ? nullptr : vec[0];
    }

    const xAOD::TruthParticle* getBestMatchedTestTruth(
        const xAOD::TruthParticle& ) const { return nullptr; };

    virtual bool isTestMatched( const xAOD::TrackParticle& t ) const = 0;
    virtual bool isTestMatched( const xAOD::TruthParticle& t ) const = 0;

    virtual bool isRefMatched( const xAOD::TrackParticle& r ) const = 0;
    virtual bool isRefMatched( const xAOD::TruthParticle& r ) const = 0;

    virtual StatusCode update( const xAOD::TrackParticle& t,
                               const xAOD::TrackParticle& r,
                               float dist = 0. ) = 0;
    virtual StatusCode update( const xAOD::TrackParticle& t,
                               const xAOD::TruthParticle& r,
                               float dist = 0. ) = 0;
    virtual StatusCode update( const xAOD::TruthParticle& t,
                               const xAOD::TrackParticle& r,
                               float dist = 0. ) = 0;

    virtual void clear() = 0;

    virtual std::string printInfo(
        const std::vector< const xAOD::TrackParticle* >& testVec,
        const std::vector< const xAOD::TrackParticle* >& refVec ) const = 0;
    virtual std::string printInfo(
        const std::vector< const xAOD::TrackParticle* >& testVec,
        const std::vector< const xAOD::TruthParticle* >& refVec ) const = 0;
    virtual std::string printInfo(
        const std::vector< const xAOD::TruthParticle* >& testVec,
        const std::vector< const xAOD::TrackParticle* >& refVec ) const = 0;
 
  protected:

    std::vector< const xAOD::TrackParticle* > m_nullTrackVec{};
    std::vector< const xAOD::TruthParticle* > m_nullTruthVec{};
 
  private:

    std::string m_anaTag;
    std::string m_chainRoiName;
    
 
  }; // class ITrackMatchingLookup
 
} // namespace IDTPM
 
#endif // > !INDETTRACKPERFMON_ITRACKMATCHINGLOOKUP_H