TrackMatchLookUp.h

/**************************************************************************
 * BASF2 (Belle Analysis Framework 2)                                     *
 * Copyright(C) 2014 - Belle II Collaboration                             *
 *                                                                        *
 * Author: The Belle II Collaboration                                     *
 * Contributors: Oliver Frost, Thomas Hauth                               *
 *                                                                        *
 * This software is provided "as is" without any warranty.                *
 **************************************************************************/
#pragma once
 
#include <mdst/dataobjects/MCParticle.h>
#include <mdst/dataobjects/TrackFitResult.h>
 
#include <tracking/dataobjects/RecoTrack.h>
 
namespace Belle2 {
  class TrackMatchLookUp {
 
  public:
    enum class MCToPRMatchInfo { c_Invalid, c_Matched, c_Merged, c_Missing };
 
    enum class PRToMCMatchInfo { c_Invalid, c_Matched, c_Clone, c_Background, c_Ghost };
 
  public:
    explicit TrackMatchLookUp(const std::string& mcRecoTrackStoreArrayName,
                              const std::string& prRecoTrackStoreArrayName = "");
 
  private:
    MCToPRMatchInfo extractMCToPRMatchInfo(const RecoTrack& mcRecoTrack,
                                           const RecoTrack* prRecoTrack,
                                           const float& efficiency) const;
 
    PRToMCMatchInfo extractPRToMCMatchInfo(const RecoTrack& prRecoTrack,
                                           const RecoTrack* mcRecoTrack,
                                           const float& purity) const;
 
  public:
    const RecoTrack* getMatchedMCRecoTrack(const RecoTrack& prRecoTrack) const;
 
    const RecoTrack* getMatchedPRRecoTrack(const RecoTrack& mcRecoTrack) const;
 
  public:
    float getMatchedPurity(const RecoTrack& recoTrack) const;
 
    float getMatchedEfficiency(const RecoTrack& recoTrack) const;
 
  public:
    MCToPRMatchInfo getMCToPRMatchInfo(const RecoTrack& mcRecoTrack) const
    {
      float efficiency = NAN;
      const RecoTrack* prRecoTrack = getRelatedPRRecoTrack(mcRecoTrack, efficiency);
      return extractMCToPRMatchInfo(mcRecoTrack, prRecoTrack, efficiency);
    }
 
    bool isMatchedPRRecoTrack(const RecoTrack& prRecoTrack) const
    {
      return getPRToMCMatchInfo(prRecoTrack) == PRToMCMatchInfo::c_Matched;
    }
 
    bool isClonePRRecoTrack(const RecoTrack& prRecoTrack) const
    {
      return getPRToMCMatchInfo(prRecoTrack) == PRToMCMatchInfo::c_Clone;
    }
 
    bool isBackgroundPRRecoTrack(const RecoTrack& prRecoTrack) const
    {
      return getPRToMCMatchInfo(prRecoTrack) == PRToMCMatchInfo::c_Background;
    }
 
    bool isGhostPRRecoTrack(const RecoTrack& prRecoTrack) const
    {
      return getPRToMCMatchInfo(prRecoTrack) == PRToMCMatchInfo::c_Ghost;
    }
 
  public:
    PRToMCMatchInfo getPRToMCMatchInfo(const RecoTrack& prRecoTrack) const
    {
      float purity = NAN;
      const RecoTrack* mcRecoTrack = getRelatedMCRecoTrack(prRecoTrack, purity);
      return extractPRToMCMatchInfo(prRecoTrack, mcRecoTrack, purity);
    }
 
    bool isMatchedMCRecoTrack(const RecoTrack& mcRecoTrack) const
    {
      return getMCToPRMatchInfo(mcRecoTrack) == MCToPRMatchInfo::c_Matched;
    }
 
    bool isMergedMCRecoTrack(const RecoTrack& mcRecoTrack) const
    {
      return getMCToPRMatchInfo(mcRecoTrack) == MCToPRMatchInfo::c_Merged;
    }
 
    bool isMissingMCRecoTrack(const RecoTrack& mcRecoTrack) const
    {
      return getMCToPRMatchInfo(mcRecoTrack) == MCToPRMatchInfo::c_Missing;
    }
 
  public:
    const MCParticle* getRelatedMCParticle(const RecoTrack& recoTrack) const;
 
    const TrackFitResult*
    getRelatedTrackFitResult(const RecoTrack& prRecoTrack,
                             Const::ChargedStable chargedStable = Const::pion) const;
 
    const RecoTrack* getRelatedMCRecoTrack(const RecoTrack& prRecoTrack) const;
 
    const RecoTrack* getRelatedPRRecoTrack(const RecoTrack& mcRecoTrack) const;
 
  public:
    float getRelatedPurity(const RecoTrack& prRecoTrack) const;
 
    float getRelatedEfficiency(const RecoTrack& mcRecoTrack) const;
 
    const RecoTrack* getRelatedMCRecoTrack(const RecoTrack& prRecoTrack, float& purity) const;
 
    const RecoTrack* getRelatedPRRecoTrack(const RecoTrack& mcRecoTrack, float& efficiency) const;
 
  public:
    bool isMCRecoTrack(const RecoTrack& recoTrack) const;
 
    bool isPRRecoTrack(const RecoTrack& recoTrack) const;
 
  public:
    const std::string& getMCTracksStoreArrayName() const
    {
      return m_mcTracksStoreArrayName;
    }
 
    const std::string& getPRTracksStoreArrayName() const
    {
      return m_prTracksStoreArrayName;
    }
 
  private:
    std::string m_mcTracksStoreArrayName;
 
    std::string m_prTracksStoreArrayName;
  };
}