TrackMatchLookUp Class Reference

Class to provide convenient methods to look up matching information between pattern recognition and Monte Carlo tracks. More...

#include <TrackMatchLookUp.h>

Public Types
enum class	MCToPRMatchInfo {   c_undefined ,   c_matched ,   c_matchedWrongCharge ,   c_merged ,   c_mergedWrongCharge ,   c_missing }
	Matching categories for the Monte Carlo tracks. More...
enum class	PRToMCMatchInfo {   c_undefined ,   c_matched ,   c_matchedWrongCharge ,   c_clone ,   c_cloneWrongCharge ,   c_background ,   c_ghost }
	Matching categories for the pattern recognition tracks. More...

Public Member Functions
	TrackMatchLookUp (const std::string &mcRecoTrackStoreArrayName, const std::string &prRecoTrackStoreArrayName="")
	Constructor taking the names of the StoreArrays containing the Monte Carlo tracks and the pattern recognition tracks respectively.
const RecoTrack *	getCorrectChargeMatchedMCRecoTrack (const RecoTrack &prRecoTrack) const
	Looks up the matched Monte Carlo track for the given pattern recognition track.
const RecoTrack *	getWrongChargeMatchedMCRecoTrack (const RecoTrack &prRecoTrack) const
	Looks up the matched Monte Carlo track for the given pattern recognition track with the wrong charge.
const RecoTrack *	getAnyChargeMatchedMCRecoTrack (const RecoTrack &prRecoTrack) const
	Check whether any matched MC RecoTracks for the given prRecoTrack, independent of whether both pattern and charge are matched correctly, or only the pattern is correct but the charge is wrong.
const RecoTrack *	getCorrectChargeMatchedPRRecoTrack (const RecoTrack &mcRecoTrack) const
	Looks up the matched pattern recognition track for the given Monte Carlo track.
const RecoTrack *	getWrongChargeMatchedPRRecoTrack (const RecoTrack &mcRecoTrack) const
	Looks up the matched pattern recognition track for the given Monte Carlo track.
const RecoTrack *	getAnyChargeMatchedPRRecoTrack (const RecoTrack &mcRecoTrack) const
	Check whether any matched PR RecoTracks for the given mcRecoTrack, independent of whether both pattern and charge are matched correctly, or only the pattern is correct but the charge is wrong.
float	getMatchedPurity (const RecoTrack &recoTrack) const
	Get the hit purity of the matched track.
float	getMatchedEfficiency (const RecoTrack &recoTrack) const
	Get the hit efficiency of the matched track.
bool	isChargeMatched (const RecoTrack &recoTrack) const
	Checks if the recoTrack charge is correctly assigned.
MCToPRMatchInfo	getMCToPRMatchInfo (const RecoTrack &mcRecoTrack) const
	Gets the matching category of Monte Carlo track.
bool	isCorrectChargeMatchedPRRecoTrack (const RecoTrack &prRecoTrack) const
	Checks, if the pattern recognition track was matched to a Monte Carlo track with both hit pattern and charge being matched.
bool	isWrongChargeMatchedPRRecoTrack (const RecoTrack &prRecoTrack) const
	Checks, if the pattern recognition track was matched to a Monte Carlo track but with the wrong charge.
bool	isAnyChargeMatchedPRRecoTrack (const RecoTrack &prRecoTrack) const
	Checks, if the pattern recognition track was matched to a Monte Carlo track, independent of whether the charge is matched.
bool	isCorrectChargeClonePRRecoTrack (const RecoTrack &prRecoTrack) const
	Checks, if the pattern recognition track is a clone of an other pattern recognition track.
bool	isWrongChargeClonePRRecoTrack (const RecoTrack &prRecoTrack) const
	Checks, if the pattern recognition track is a clone of an other pattern recognition track, but with the wrong charge.
bool	isAnyChargeClonePRRecoTrack (const RecoTrack &prRecoTrack) const
	Checks, if the pattern recognition track is a clone of an other pattern recognition track, independent of whether the charge is correct.
bool	isBackgroundPRRecoTrack (const RecoTrack &prRecoTrack) const
	Checks, if the pattern recognition track is mostly made from background hits.
bool	isGhostPRRecoTrack (const RecoTrack &prRecoTrack) const
	Checks, if the pattern recognition track has contributions of different Monte Carlo tracks and/or background hits, such that a match is not possible.
PRToMCMatchInfo	getPRToMCMatchInfo (const RecoTrack &prRecoTrack) const
	Gets the matching category of pattern recognition track.
bool	isCorrectChargeMatchedMCRecoTrack (const RecoTrack &mcRecoTrack) const
	Checks, if the Monte Carlo Track was matched to a pattern recognition track based on the hit pattern and the correct charge.
bool	isWrongChargeMatchedMCRecoTrack (const RecoTrack &mcRecoTrack) const
	Checks, if the Monte Carlo Track was matched to a pattern recognition track based on the hit pattern, but was assigned the wrong charge.
bool	isAnyChargeMatchedMCRecoTrack (const RecoTrack &mcRecoTrack) const
	Checks, if the Monte Carlo Track was matched to a pattern recognition track independent of the charge.
bool	isCorrectChargeMergedMCRecoTrack (const RecoTrack &mcRecoTrack) const
	Checks, if the Monte Carlo Track has been merged into another pattern recognition track.
bool	isWrongChargeMergedMCRecoTrack (const RecoTrack &mcRecoTrack) const
	Checks, if the Monte Carlo Track has been merged into another pattern recognition track and with the wrong charge.
bool	isAnyChargeMergedMCRecoTrack (const RecoTrack &mcRecoTrack) const
	Checks, if the Monte Carlo Track has been merged into another pattern recognition track.
bool	isMissingMCRecoTrack (const RecoTrack &mcRecoTrack) const
	Checks, if the Monte Carlo Track has no corresponding pattern recognition track.
const MCParticle *	getRelatedMCParticle (const RecoTrack &recoTrack) const
	Looks for a relation of the given track to a Monte Carlo particle.
const TrackFitResult *	getRelatedTrackFitResult (const RecoTrack &prRecoTrack, Const::ChargedStable chargedStable=Const::pion) const
	Looks up the TrackFitResult of a pattern recognition track.
const RecoTrack *	getRelatedMCRecoTrack (const RecoTrack &prRecoTrack) const
	Looks for a related Monte Carlo track for the given pattern recognition track and return it if found.
const RecoTrack *	getRelatedPRRecoTrack (const RecoTrack &mcRecoTrack) const
	Looks for a related pattern recognition track for the given Monte Carlo track and return it if found.
float	getRelatedPurity (const RecoTrack &prRecoTrack) const
	Getter for the absolute value of the purity that is stored in the purity relation from pattern recognition tracks to Monte Carlo tracks.
float	getRelatedEfficiency (const RecoTrack &mcRecoTrack) const
	Getter for the absolute value of the efficiency that is stored in the efficiency relation from Monte Carlo tracks to pattern recognition tracks.
const RecoTrack *	getRelatedMCRecoTrack (const RecoTrack &prRecoTrack, float &purity) const
	Helper function looking for a related Monte Carlo track to the given pattern recognition track in the purity relation.
const RecoTrack *	getRelatedPRRecoTrack (const RecoTrack &mcRecoTrack, float &efficiency) const
	Helper function looking for a related Monte Carlo track to the given pattern recognition track in the efficiency relation.
bool	isMCRecoTrack (const RecoTrack &recoTrack) const
	Checks if the given track is in the Monte Carlo track StoreArray.
bool	isPRRecoTrack (const RecoTrack &recoTrack) const
	Checks if the given track is in the pattern recognition StoreArray.
const std::string &	getMCTracksStoreArrayName () const
	Getter for the name of the StoreArray of the Monte Carlo tracks.
const std::string &	getPRTracksStoreArrayName () const
	Getter for the name of the StoreArray of the pattern recognition tracks.

Private Member Functions
MCToPRMatchInfo	extractMCToPRMatchInfo (const RecoTrack &mcRecoTrack, const RecoTrack *prRecoTrack, const float &efficiency) const
	Helper function to assume the correct matching category for the Monte Carlo tracks from the information efficiency relation.
PRToMCMatchInfo	extractPRToMCMatchInfo (const RecoTrack &prRecoTrack, const RecoTrack *mcRecoTrack, const float &purity) const
	Helper function to assume the correct matching category for the pattern recognition tracks from the information purity relation.
const RecoTrack *	getMCRecoTrackWithStatus (const RecoTrack &prRecoTrack, const PRToMCMatchInfo matchingStatus=PRToMCMatchInfo::c_matched) const
	Looks up the matched Monte Carlo track with the PRToMCMatchInfo matchingStatus for the given pattern recognition track.
const RecoTrack *	getPRRecoTrackWithStatus (const RecoTrack &mcRecoTrack, const MCToPRMatchInfo matchingStatus=MCToPRMatchInfo::c_matched) const
	Looks up the matched pattern recognition track with the MCToPRMatchInfo matchingStatus for the given Monte Carlo track.

Private Attributes
std::string	m_mcTracksStoreArrayName
	Name of the StoreArray of Monte Carlo tracks.
std::string	m_prTracksStoreArrayName
	Name of the StoreArray of Pattern recognition tracks.

Detailed Description

Class to provide convenient methods to look up matching information between pattern recognition and Monte Carlo tracks.

It provides a more user friendly look up interface into the relations that were generated by the MCTrackMatcherModule.

Instead of looking through the relations directly to find the matching information on your own the methods of this class exhibit a conceptual view on them.

This class is also accessible in python steering files.

Definition at line 33 of file TrackMatchLookUp.h.

Member Enumeration Documentation

MCToPRMatchInfo

enum class MCToPRMatchInfo

strong

Matching categories for the Monte Carlo tracks.

c_undefined, //until the matcher module sets it c_matched, // hit pattern and charge are both correct c_matchedWrongCharge, // hit pattern is correct, but the charge is wrong c_merged, //a clone with the correct charge c_mergedWrongCharge, //a clone with the wrong charge c_missing

Definition at line 45 of file TrackMatchLookUp.h.

{ c_undefined, c_matched, c_matchedWrongCharge, c_merged, c_mergedWrongCharge, c_missing };

PRToMCMatchInfo

enum class PRToMCMatchInfo

strong

Matching categories for the pattern recognition tracks.

c_undefined, //until the matcher module sets it c_matched, // hit pattern and charge are both correct c_matchedWrongCharge, // hit pattern is correct, but the charge is wrong c_clone, //a clone with the correct charge c_cloneWrongCharge, //a clone with the wrong charge c_background, c_ghost

Definition at line 57 of file TrackMatchLookUp.h.

{ c_undefined, c_matched, c_matchedWrongCharge, c_clone, c_cloneWrongCharge, c_background, c_ghost };

Constructor & Destructor Documentation

TrackMatchLookUp()

TrackMatchLookUp ( const std::string &  mcRecoTrackStoreArrayName, const std::string &  prRecoTrackStoreArrayName = ""  )

explicit

Constructor taking the names of the StoreArrays containing the Monte Carlo tracks and the pattern recognition tracks respectively.

Only the name of StoreArray of the Monte Carlo reference tracks has to be given. The name of the StoreArray of the pattern recognition tracks to defaults to the standard name.

Definition at line 17 of file TrackMatchLookUp.cc.

  : m_mcTracksStoreArrayName(DataStore::arrayName<RecoTrack>(mcRecoTrackStoreArrayName))
  , m_prTracksStoreArrayName(DataStore::arrayName<RecoTrack>(prRecoTrackStoreArrayName))
{
  if (m_mcTracksStoreArrayName == m_prTracksStoreArrayName) {
    B2WARNING("Pattern recognition and Monte Carlo track StoreArray are the same.");
  }
}

Member Function Documentation

extractMCToPRMatchInfo()

TrackMatchLookUp::MCToPRMatchInfo extractMCToPRMatchInfo ( const RecoTrack &  mcRecoTrack, const RecoTrack *  prRecoTrack, const float &  efficiency  ) const

private

Helper function to assume the correct matching category for the Monte Carlo tracks from the information efficiency relation.

Definition at line 68 of file TrackMatchLookUp.cc.

{
  if (not prRecoTrack) return MCToPRMatchInfo::c_missing;
  if (std::isnan(efficiency)) return MCToPRMatchInfo::c_undefined;
  B2ASSERT("This RecoTrack isn't a MC RecoTrack as it is supposed to be.", isMCRecoTrack(mcRecoTrack));
  B2ASSERT("This RecoTrack isn't a PR RecoTrack as it is supposed to be.", isPRRecoTrack(*prRecoTrack));
 
  const RecoTrack* roundTripMCRecoTrack =
    prRecoTrack->getRelatedTo<RecoTrack>(m_mcTracksStoreArrayName);
 
  const bool wrongCharge = roundTripMCRecoTrack->getChargeSeed() != mcRecoTrack.getChargeSeed();
 
  if (roundTripMCRecoTrack == &mcRecoTrack) {
    if (wrongCharge) return MCToPRMatchInfo::c_matchedWrongCharge;
    else return MCToPRMatchInfo::c_matched;
  } else {
    if (wrongCharge) return MCToPRMatchInfo::c_mergedWrongCharge;
    else return MCToPRMatchInfo::c_merged;
  }
}

extractPRToMCMatchInfo()

TrackMatchLookUp::PRToMCMatchInfo extractPRToMCMatchInfo ( const RecoTrack &  prRecoTrack, const RecoTrack *  mcRecoTrack, const float &  purity  ) const

private

Helper function to assume the correct matching category for the pattern recognition tracks from the information purity relation.

Definition at line 92 of file TrackMatchLookUp.cc.

{
  B2ASSERT("This RecoTrack isn't a PR RecoTrack as it is supposed to be.", isPRRecoTrack(prRecoTrack));
  const RecoTrack::MatchingStatus matchingStatus = prRecoTrack.getMatchingStatus();
 
  if (matchingStatus == RecoTrack::MatchingStatus::c_ghost) {
    return PRToMCMatchInfo::c_ghost;
  } else if (matchingStatus == RecoTrack::MatchingStatus::c_background) {
    return PRToMCMatchInfo::c_background;
  } else if (matchingStatus == RecoTrack::MatchingStatus::c_clone) {
    if (not mcRecoTrack) B2WARNING("Clone with no related Monte Carlo RecoTrack");
    return PRToMCMatchInfo::c_clone;
  }  else if (matchingStatus == RecoTrack::MatchingStatus::c_cloneWrongCharge) {
    if (not mcRecoTrack) B2WARNING("Clone with no related Monte Carlo RecoTrack");
    return PRToMCMatchInfo::c_cloneWrongCharge;
  } else if (matchingStatus == RecoTrack::MatchingStatus::c_matched) {
    if (not mcRecoTrack) B2WARNING("Match with no related Monte Carlo RecoTrack");
    return PRToMCMatchInfo::c_matched;
  }  else if (matchingStatus == RecoTrack::MatchingStatus::c_matchedWrongCharge) {
    if (not mcRecoTrack) B2WARNING("Match with no related Monte Carlo RecoTrack");
    return PRToMCMatchInfo::c_matchedWrongCharge;
  } else if (matchingStatus == RecoTrack::MatchingStatus::c_undefined) {
    return PRToMCMatchInfo::c_undefined;
  }
  return PRToMCMatchInfo::c_undefined;
}

getAnyChargeMatchedMCRecoTrack()

const RecoTrack * getAnyChargeMatchedMCRecoTrack ( const RecoTrack &  prRecoTrack ) const

inline

Check whether any matched MC RecoTracks for the given prRecoTrack, independent of whether both pattern and charge are matched correctly, or only the pattern is correct but the charge is wrong.

If no match exists at all, a nullptr is returned.

Definition at line 131 of file TrackMatchLookUp.h.

    {
      const RecoTrack* anyMatchedRecoTrack = getMCRecoTrackWithStatus(prRecoTrack, PRToMCMatchInfo::c_matched);
      if (anyMatchedRecoTrack == nullptr) {
        anyMatchedRecoTrack = getMCRecoTrackWithStatus(prRecoTrack, PRToMCMatchInfo::c_matchedWrongCharge);
      }
      return anyMatchedRecoTrack;
    }

getAnyChargeMatchedPRRecoTrack()

const RecoTrack * getAnyChargeMatchedPRRecoTrack ( const RecoTrack &  mcRecoTrack ) const

inline

Check whether any matched PR RecoTracks for the given mcRecoTrack, independent of whether both pattern and charge are matched correctly, or only the pattern is correct but the charge is wrong.

If no match exists at all, a nullptr is returned.

Definition at line 165 of file TrackMatchLookUp.h.

    {
      const RecoTrack* anyMatchedRecoTrack = getPRRecoTrackWithStatus(mcRecoTrack, MCToPRMatchInfo::c_matched);
      if (anyMatchedRecoTrack == nullptr) {
        anyMatchedRecoTrack = getPRRecoTrackWithStatus(mcRecoTrack, MCToPRMatchInfo::c_matchedWrongCharge);
      }
      return anyMatchedRecoTrack;
    }

getCorrectChargeMatchedMCRecoTrack()

const RecoTrack * getCorrectChargeMatchedMCRecoTrack ( const RecoTrack &  prRecoTrack ) const

inline

Looks up the matched Monte Carlo track for the given pattern recognition track.

If there is no match or the pattern recognition track is a clone, or the charge is wrong return nullptr.

Definition at line 110 of file TrackMatchLookUp.h.

    {
      return getMCRecoTrackWithStatus(prRecoTrack, PRToMCMatchInfo::c_matched);
    }

getCorrectChargeMatchedPRRecoTrack()

const RecoTrack * getCorrectChargeMatchedPRRecoTrack ( const RecoTrack &  mcRecoTrack ) const

inline

Looks up the matched pattern recognition track for the given Monte Carlo track.

If there is no match or the Monte Carlo track is a over-merged, or the charge is wrong return nullptr.

Definition at line 145 of file TrackMatchLookUp.h.

    {
      return getPRRecoTrackWithStatus(mcRecoTrack, MCToPRMatchInfo::c_matched);
    }

getMatchedEfficiency()

float getMatchedEfficiency

(

const RecoTrack &

recoTrack

)

const

Get the hit efficiency of the matched track.

The given track can be both Monte Carlo track or pattern recognition track since the match is one to one relation. The returned efficiency is positive, hence the absolute value of the relation weight. If no exact match is associated with the track return NAN.

Definition at line 220 of file TrackMatchLookUp.cc.

{
  if (isPRRecoTrack(recoTrack)) {
    const RecoTrack& prRecoTrack = recoTrack;
    const RecoTrack* mcRecoTrack = getAnyChargeMatchedMCRecoTrack(prRecoTrack);
    if (mcRecoTrack) {
      return getRelatedEfficiency(*mcRecoTrack);
    } else {
      return NAN;
    }
 
  } else {
    const RecoTrack& mcRecoTrack = recoTrack;
    const RecoTrack* prRecoTrack = getAnyChargeMatchedPRRecoTrack(mcRecoTrack);
    if (prRecoTrack) {
      return getRelatedEfficiency(mcRecoTrack);
    } else {
      return NAN;
    }
  }
}

getMatchedPurity()

float getMatchedPurity

(

const RecoTrack &

recoTrack

)

const

Get the hit purity of the matched track.

The given track can be both Monte Carlo track or pattern recognition track since the match is one to one relation. The returned purity is positive, hence the absolute value of the relation weight. If no exact match is associated with the track return NAN.

Definition at line 197 of file TrackMatchLookUp.cc.

{
 
  if (isMCRecoTrack(recoTrack)) {
    const RecoTrack& mcRecoTrack = recoTrack;
    const RecoTrack* prRecoTrack = getAnyChargeMatchedPRRecoTrack(mcRecoTrack);
    if (prRecoTrack) {
      return getRelatedPurity(*prRecoTrack);
    } else {
      return NAN;
    }
 
  } else {
    const RecoTrack& prRecoTrack = recoTrack;
    const RecoTrack* mcRecoTrack = getAnyChargeMatchedMCRecoTrack(prRecoTrack);
    if (mcRecoTrack) {
      return getRelatedPurity(prRecoTrack);
    } else {
      return NAN;
    }
  }
}

getMCRecoTrackWithStatus()

const RecoTrack * getMCRecoTrackWithStatus ( const RecoTrack &  prRecoTrack, const PRToMCMatchInfo  matchingStatus = PRToMCMatchInfo::c_matched  ) const

private

Looks up the matched Monte Carlo track with the PRToMCMatchInfo matchingStatus for the given pattern recognition track.

If there is no match or the pattern recognition track is a clone return nullptr.

Definition at line 167 of file TrackMatchLookUp.cc.

{
  B2ASSERT("This RecoTrack isn't a PR RecoTrack as it is supposed to be.", isPRRecoTrack(prRecoTrack));
 
  float purity = NAN;
  const RecoTrack* mcRecoTrack = getRelatedMCRecoTrack(prRecoTrack, purity);
 
  if (extractPRToMCMatchInfo(prRecoTrack, mcRecoTrack, purity) == matchingStatus) {
    return mcRecoTrack;
  } else {
    return nullptr;
  }
}

getMCToPRMatchInfo()

MCToPRMatchInfo getMCToPRMatchInfo ( const RecoTrack &  mcRecoTrack ) const

inline

Gets the matching category of Monte Carlo track.

Definition at line 208 of file TrackMatchLookUp.h.

    {
      float efficiency = NAN;
      const RecoTrack* prRecoTrack = getRelatedPRRecoTrack(mcRecoTrack, efficiency);
      return extractMCToPRMatchInfo(mcRecoTrack, prRecoTrack, efficiency);
    }

getMCTracksStoreArrayName()

const std::string & getMCTracksStoreArrayName ( ) const

inline

Getter for the name of the StoreArray of the Monte Carlo tracks.

Definition at line 455 of file TrackMatchLookUp.h.

    {
      return m_mcTracksStoreArrayName;
    }

getPRRecoTrackWithStatus()

const RecoTrack * getPRRecoTrackWithStatus ( const RecoTrack &  mcRecoTrack, const MCToPRMatchInfo  matchingStatus = MCToPRMatchInfo::c_matched  ) const

private

Looks up the matched pattern recognition track with the MCToPRMatchInfo matchingStatus for the given Monte Carlo track.

If there is no match or the Monte Carlo track return nullptr.

Definition at line 182 of file TrackMatchLookUp.cc.

{
  B2ASSERT("This RecoTrack isn't a MC RecoTrack as it is supposed to be.", isMCRecoTrack(mcRecoTrack));
 
  float efficiency = NAN;
  const RecoTrack* prRecoTrack = getRelatedPRRecoTrack(mcRecoTrack, efficiency);
 
  if (extractMCToPRMatchInfo(mcRecoTrack, prRecoTrack, efficiency) == matchingStatus) {
    return prRecoTrack;
  } else {
    return nullptr;
  }
}

getPRToMCMatchInfo()

PRToMCMatchInfo getPRToMCMatchInfo ( const RecoTrack &  prRecoTrack ) const

inline

Gets the matching category of pattern recognition track.

Definition at line 291 of file TrackMatchLookUp.h.

    {
      float purity = NAN;
      const RecoTrack* mcRecoTrack = getRelatedMCRecoTrack(prRecoTrack, purity);
      return extractPRToMCMatchInfo(prRecoTrack, mcRecoTrack, purity);
    }

getPRTracksStoreArrayName()

const std::string & getPRTracksStoreArrayName ( ) const

inline

Getter for the name of the StoreArray of the pattern recognition tracks.

Definition at line 463 of file TrackMatchLookUp.h.

    {
      return m_prTracksStoreArrayName;
    }

getRelatedEfficiency()

float getRelatedEfficiency

(

const RecoTrack &

mcRecoTrack

)

const

Getter for the absolute value of the efficiency that is stored in the efficiency relation from Monte Carlo tracks to pattern recognition tracks.

The efficiency relation on the DataStore encodes some information about the match category in the sign of the efficiency. However user code is always interested in the absolute value of the efficiency but may forget apply an absolute value. Since the matching category can be found by other methods of this class, we only provide the absolute value here.

Definition at line 159 of file TrackMatchLookUp.cc.

{
  B2ASSERT("This RecoTrack isn't a MC RecoTrack as it is supposed to be.", isMCRecoTrack(mcRecoTrack));
  float efficiency = NAN;
  getRelatedPRRecoTrack(mcRecoTrack, efficiency);
  return std::fabs(efficiency);
}

getRelatedMCParticle()

const MCParticle * getRelatedMCParticle

(

const RecoTrack &

recoTrack

)

const

Looks for a relation of the given track to a Monte Carlo particle.

Returns nullptr if not found.

Works for both pattern recognition and Monte Carlo tracks.

Whether clones have a related MCParticle depends on the settings of the MCTrackMatcher module that filled the relations.

Definition at line 121 of file TrackMatchLookUp.cc.

{
  return recoTrack.getRelatedTo<MCParticle>();
}

getRelatedMCRecoTrack() [1/2]

const RecoTrack * getRelatedMCRecoTrack

(

const RecoTrack &

prRecoTrack

)

const

Looks for a related Monte Carlo track for the given pattern recognition track and return it if found.

Return nullptr if not found.

Definition at line 126 of file TrackMatchLookUp.cc.

{
  B2ASSERT("This RecoTrack isn't a PR RecoTrack as it is supposed to be.", isPRRecoTrack(prRecoTrack));
  return prRecoTrack.getRelatedTo<RecoTrack>(getMCTracksStoreArrayName());
}

getRelatedMCRecoTrack() [2/2]

const RecoTrack * getRelatedMCRecoTrack	(	const RecoTrack &	prRecoTrack,
		float &	purity
	)		const

Helper function looking for a related Monte Carlo track to the given pattern recognition track in the purity relation.

Also returns to found purity as output parameter.

Definition at line 38 of file TrackMatchLookUp.cc.

{
  B2ASSERT("This RecoTrack isn't a PR RecoTrack as it is supposed to be.", isPRRecoTrack(prRecoTrack));
  std::pair<RecoTrack*, float> mcRecoTrackAndWeight =
    prRecoTrack.getRelatedToWithWeight<RecoTrack>(getMCTracksStoreArrayName());
  const RecoTrack* mcRecoTrack = mcRecoTrackAndWeight.first;
  if (mcRecoTrack) {
    purity = mcRecoTrackAndWeight.second;
  } else {
    purity = NAN;
  }
  return mcRecoTrack;
}

getRelatedPRRecoTrack() [1/2]

const RecoTrack * getRelatedPRRecoTrack

(

const RecoTrack &

mcRecoTrack

)

const

Looks for a related pattern recognition track for the given Monte Carlo track and return it if found.

Return nullptr if not found.

Definition at line 145 of file TrackMatchLookUp.cc.

{
  B2ASSERT("This RecoTrack isn't a MC RecoTrack as it is supposed to be.", isMCRecoTrack(mcRecoTrack));
  return mcRecoTrack.getRelatedTo<RecoTrack>(getPRTracksStoreArrayName());
}

getRelatedPRRecoTrack() [2/2]

const RecoTrack * getRelatedPRRecoTrack	(	const RecoTrack &	mcRecoTrack,
		float &	efficiency
	)		const

Helper function looking for a related Monte Carlo track to the given pattern recognition track in the efficiency relation.

Also returns to found efficiency as output parameter.

Definition at line 53 of file TrackMatchLookUp.cc.

{
  B2ASSERT("This RecoTrack isn't a MC RecoTrack as it is supposed to be.", isMCRecoTrack(mcRecoTrack));
  std::pair<RecoTrack*, float> prRecoTrackAndWeight =
    mcRecoTrack.getRelatedToWithWeight<RecoTrack>(getPRTracksStoreArrayName());
  const RecoTrack* prRecoTrack = prRecoTrackAndWeight.first;
  if (prRecoTrack) {
    efficiency = prRecoTrackAndWeight.second;
  } else {
    efficiency = NAN;
  }
  return prRecoTrack;
}

getRelatedPurity()

float getRelatedPurity

(

const RecoTrack &

prRecoTrack

)

const

Getter for the absolute value of the purity that is stored in the purity relation from pattern recognition tracks to Monte Carlo tracks.

The purity relation on the DataStore encodes some information about the match category in the sign of the purity. However user code is always interested in the absolute value of the purity but may forget apply an absolute value. Since the matching category can be found by other methods of this class, we only provide the absolute value here.

Definition at line 151 of file TrackMatchLookUp.cc.

{
  B2ASSERT("This RecoTrack isn't a PR RecoTrack as it is supposed to be.", isPRRecoTrack(prRecoTrack));
  float purity = NAN;
  getRelatedMCRecoTrack(prRecoTrack, purity);
  return std::fabs(purity);
}

getRelatedTrackFitResult()

const TrackFitResult * getRelatedTrackFitResult	(	const RecoTrack &	prRecoTrack,
		Const::ChargedStable	chargedStable = Const::pion
	)		const

Looks up the TrackFitResult of a pattern recognition track.

Return nullptr if there is no related track fit result.

The relations are setup to be from the Belle2::Track to the RecoTrack.

Then the TrackFitResults stored within the Belle2::Tracks are retrieved and the one selected particle hypothesises given via chargedStable is returned.

The default is the Pion fit.

Definition at line 132 of file TrackMatchLookUp.cc.

{
  B2ASSERT("This RecoTrack isn't a PR RecoTrack as it is supposed to be.", isPRRecoTrack(prRecoTrack));
  Belle2::Track* b2track = prRecoTrack.getRelatedFrom<Belle2::Track>();
  if (b2track) {
    // Query the Belle2::Track for the selected fit hypothesis
    return b2track->getTrackFitResult(chargedStable);
  } else {
    return nullptr;
  }
}

getWrongChargeMatchedMCRecoTrack()

const RecoTrack * getWrongChargeMatchedMCRecoTrack ( const RecoTrack &  prRecoTrack ) const

inline

Looks up the matched Monte Carlo track for the given pattern recognition track with the wrong charge.

If there is no match or the pattern recognition track is a clone, or the charge is correct return nullptr.

Definition at line 121 of file TrackMatchLookUp.h.

    {
      return getMCRecoTrackWithStatus(prRecoTrack, PRToMCMatchInfo::c_matchedWrongCharge);
    }

getWrongChargeMatchedPRRecoTrack()

const RecoTrack * getWrongChargeMatchedPRRecoTrack ( const RecoTrack &  mcRecoTrack ) const

inline

Looks up the matched pattern recognition track for the given Monte Carlo track.

If there is no match or the Monte Carlo track is a over-merged or the charge is correct return nullptr.

Definition at line 155 of file TrackMatchLookUp.h.

    {
      return getPRRecoTrackWithStatus(mcRecoTrack, MCToPRMatchInfo::c_matchedWrongCharge);
    }

isAnyChargeClonePRRecoTrack()

bool isAnyChargeClonePRRecoTrack ( const RecoTrack &  prRecoTrack ) const

inline

Checks, if the pattern recognition track is a clone of an other pattern recognition track, independent of whether the charge is correct.

Definition at line 264 of file TrackMatchLookUp.h.

    {
      return getPRToMCMatchInfo(prRecoTrack) == PRToMCMatchInfo::c_clone or
             getPRToMCMatchInfo(prRecoTrack) == PRToMCMatchInfo::c_cloneWrongCharge;
    }

isAnyChargeMatchedMCRecoTrack()

bool isAnyChargeMatchedMCRecoTrack ( const RecoTrack &  mcRecoTrack ) const

inline

Checks, if the Monte Carlo Track was matched to a pattern recognition track independent of the charge.

Definition at line 320 of file TrackMatchLookUp.h.

    {
      return getMCToPRMatchInfo(mcRecoTrack) == MCToPRMatchInfo::c_matched or
             getMCToPRMatchInfo(mcRecoTrack) == MCToPRMatchInfo::c_matchedWrongCharge;
    }

isAnyChargeMatchedPRRecoTrack()

bool isAnyChargeMatchedPRRecoTrack ( const RecoTrack &  prRecoTrack ) const

inline

Checks, if the pattern recognition track was matched to a Monte Carlo track, independent of whether the charge is matched.

Definition at line 237 of file TrackMatchLookUp.h.

    {
      return getPRToMCMatchInfo(prRecoTrack) == PRToMCMatchInfo::c_matched or
             getPRToMCMatchInfo(prRecoTrack) == PRToMCMatchInfo::c_matchedWrongCharge;
    }

isAnyChargeMergedMCRecoTrack()

bool isAnyChargeMergedMCRecoTrack ( const RecoTrack &  mcRecoTrack ) const

inline

Checks, if the Monte Carlo Track has been merged into another pattern recognition track.

Definition at line 346 of file TrackMatchLookUp.h.

    {
      return getMCToPRMatchInfo(mcRecoTrack) == MCToPRMatchInfo::c_merged or
             getMCToPRMatchInfo(mcRecoTrack) == MCToPRMatchInfo::c_mergedWrongCharge;
    }

isBackgroundPRRecoTrack()

bool isBackgroundPRRecoTrack ( const RecoTrack &  prRecoTrack ) const

inline

Checks, if the pattern recognition track is mostly made from background hits.

Definition at line 273 of file TrackMatchLookUp.h.

    {
      return getPRToMCMatchInfo(prRecoTrack) == PRToMCMatchInfo::c_background;
    }

isChargeMatched()

bool isChargeMatched

(

const RecoTrack &

recoTrack

)

const

Checks if the recoTrack charge is correctly assigned.

Returns NAN if the recoTrack is not matched. The given track can be both Monte Carlo track or pattern recognition track.

Definition at line 243 of file TrackMatchLookUp.cc.

{
  const MCParticle* mcParticle = getRelatedMCParticle(recoTrack);
 
  if (mcParticle)
    return (mcParticle->getCharge() == recoTrack.getChargeSeed());
  else
    return NAN;
 
}

isCorrectChargeClonePRRecoTrack()

bool isCorrectChargeClonePRRecoTrack ( const RecoTrack &  prRecoTrack ) const

inline

Checks, if the pattern recognition track is a clone of an other pattern recognition track.

Definition at line 246 of file TrackMatchLookUp.h.

    {
      return getPRToMCMatchInfo(prRecoTrack) == PRToMCMatchInfo::c_clone;
    }

isCorrectChargeMatchedMCRecoTrack()

bool isCorrectChargeMatchedMCRecoTrack ( const RecoTrack &  mcRecoTrack ) const

inline

Checks, if the Monte Carlo Track was matched to a pattern recognition track based on the hit pattern and the correct charge.

Definition at line 302 of file TrackMatchLookUp.h.

    {
      return getMCToPRMatchInfo(mcRecoTrack) == MCToPRMatchInfo::c_matched;
    }

isCorrectChargeMatchedPRRecoTrack()

bool isCorrectChargeMatchedPRRecoTrack ( const RecoTrack &  prRecoTrack ) const

inline

Checks, if the pattern recognition track was matched to a Monte Carlo track with both hit pattern and charge being matched.

Definition at line 219 of file TrackMatchLookUp.h.

    {
      return getPRToMCMatchInfo(prRecoTrack) == PRToMCMatchInfo::c_matched;
    }

isCorrectChargeMergedMCRecoTrack()

bool isCorrectChargeMergedMCRecoTrack ( const RecoTrack &  mcRecoTrack ) const

inline

Checks, if the Monte Carlo Track has been merged into another pattern recognition track.

Definition at line 329 of file TrackMatchLookUp.h.

    {
      return getMCToPRMatchInfo(mcRecoTrack) == MCToPRMatchInfo::c_merged;
    }

isGhostPRRecoTrack()

bool isGhostPRRecoTrack ( const RecoTrack &  prRecoTrack ) const

inline

Checks, if the pattern recognition track has contributions of different Monte Carlo tracks and/or background hits, such that a match is not possible.

Definition at line 282 of file TrackMatchLookUp.h.

    {
      return getPRToMCMatchInfo(prRecoTrack) == PRToMCMatchInfo::c_ghost;
    }

isMCRecoTrack()

bool isMCRecoTrack

(

const RecoTrack &

recoTrack

)

const

Checks if the given track is in the Monte Carlo track StoreArray.

Definition at line 27 of file TrackMatchLookUp.cc.

{
  return recoTrack.getArrayName() == getMCTracksStoreArrayName();
}

isMissingMCRecoTrack()

bool isMissingMCRecoTrack ( const RecoTrack &  mcRecoTrack ) const

inline

Checks, if the Monte Carlo Track has no corresponding pattern recognition track.

Definition at line 355 of file TrackMatchLookUp.h.

    {
      return getMCToPRMatchInfo(mcRecoTrack) == MCToPRMatchInfo::c_missing;
    }

isPRRecoTrack()

bool isPRRecoTrack

(

const RecoTrack &

recoTrack

)

const

Checks if the given track is in the pattern recognition StoreArray.

Definition at line 32 of file TrackMatchLookUp.cc.

{
  return recoTrack.getArrayName() == getPRTracksStoreArrayName();
}

isWrongChargeClonePRRecoTrack()

bool isWrongChargeClonePRRecoTrack ( const RecoTrack &  prRecoTrack ) const

inline

Checks, if the pattern recognition track is a clone of an other pattern recognition track, but with the wrong charge.

Definition at line 255 of file TrackMatchLookUp.h.

    {
      return getPRToMCMatchInfo(prRecoTrack) == PRToMCMatchInfo::c_cloneWrongCharge;
    }

isWrongChargeMatchedMCRecoTrack()

bool isWrongChargeMatchedMCRecoTrack ( const RecoTrack &  mcRecoTrack ) const

inline

Checks, if the Monte Carlo Track was matched to a pattern recognition track based on the hit pattern, but was assigned the wrong charge.

Definition at line 311 of file TrackMatchLookUp.h.

    {
      return getMCToPRMatchInfo(mcRecoTrack) == MCToPRMatchInfo::c_matchedWrongCharge;
    }

isWrongChargeMatchedPRRecoTrack()

bool isWrongChargeMatchedPRRecoTrack ( const RecoTrack &  prRecoTrack ) const

inline

Checks, if the pattern recognition track was matched to a Monte Carlo track but with the wrong charge.

Definition at line 228 of file TrackMatchLookUp.h.

    {
      return getPRToMCMatchInfo(prRecoTrack) == PRToMCMatchInfo::c_matchedWrongCharge;
    }

isWrongChargeMergedMCRecoTrack()

bool isWrongChargeMergedMCRecoTrack ( const RecoTrack &  mcRecoTrack ) const

inline

Checks, if the Monte Carlo Track has been merged into another pattern recognition track and with the wrong charge.

Definition at line 338 of file TrackMatchLookUp.h.

    {
      return getMCToPRMatchInfo(mcRecoTrack) == MCToPRMatchInfo::c_mergedWrongCharge;
    }

Member Data Documentation

m_mcTracksStoreArrayName

std::string m_mcTracksStoreArrayName

private

Name of the StoreArray of Monte Carlo tracks.

Definition at line 470 of file TrackMatchLookUp.h.

m_prTracksStoreArrayName

std::string m_prTracksStoreArrayName

private

Name of the StoreArray of Pattern recognition tracks.

Definition at line 473 of file TrackMatchLookUp.h.

---

The documentation for this class was generated from the following files:

• tracking/mcMatcher/include/TrackMatchLookUp.h
• tracking/mcMatcher/src/TrackMatchLookUp.cc