MatcherByPullsAlgorithm Class Reference

#include <MuonAnalysis/MuonAssociators/interface/MatcherByPullsAlgorithm.cc>

Public Member Functions
void	fillInvCov (const reco::Track &tk, AlgebraicSymMatrix55 &invCov) const
	Fill the inverse covariance matrix for the match(track, candidate, invCov) method. More...
std::pair< bool, float >	match (const reco::Track &tk, const reco::Candidate &mc, const AlgebraicSymMatrix55 &invertedCovariance) const
std::pair< int, float >	match (const reco::RecoCandidate &src, const std::vector< reco::GenParticle > &cands, const std::vector< uint8_t > &good) const
std::pair< int, float >	match (const reco::Track &src, const std::vector< reco::GenParticle > &cands, const std::vector< uint8_t > &good) const
	MatcherByPullsAlgorithm (const edm::ParameterSet &)
void	matchMany (const reco::RecoCandidate &src, const std::vector< reco::GenParticle > &cands, const std::vector< uint8_t > &good, std::vector< std::pair< double, int > > &matchesToFill) const
void	matchMany (const reco::Track &src, const std::vector< reco::GenParticle > &cands, const std::vector< uint8_t > &good, std::vector< std::pair< double, int > > &matchesToFill) const
	~MatcherByPullsAlgorithm ()

Private Types
enum	TrackChoice { StaTrack, TrkTrack, GlbTrack }
	Enum to define which track to use. More...

Private Member Functions
const reco::Track *	track (const reco::RecoCandidate &src) const
	Get track out of Candidate, NULL if missing. More...

Private Attributes
double	cut_
	Cut on the pull. More...
bool	diagOnly_
	Use only the diagonal terms of the covariance matrix. More...
double	dr2_
	DeltaR of the matching cone. More...
TrackChoice	track_
	Track to be used in matching. More...
bool	useVertex_
	Use also dxy / dsz in the matching. More...

Detailed Description

Description: Matches a RecoCandidate to a GenParticle (or any other Candidate) using the pulls of the helix parameters

Implementation: <Notes on="" implementation>="">

Definition at line 34 of file MatcherByPullsAlgorithm.h.

Member Enumeration Documentation

TrackChoice

enum MatcherByPullsAlgorithm::TrackChoice

private

Enum to define which track to use.

Enumerator
StaTrack
TrkTrack
GlbTrack

Definition at line 83 of file MatcherByPullsAlgorithm.h.

{ StaTrack, TrkTrack, GlbTrack };

Constructor & Destructor Documentation

MatcherByPullsAlgorithm()

MatcherByPullsAlgorithm::MatcherByPullsAlgorithm ( const edm::ParameterSet &  iConfig )

explicit

Definition at line 13 of file MatcherByPullsAlgorithm.cc.

References Exception, edm::ParameterSet::getParameter(), GlbTrack, StaTrack, AlCaHLTBitMon_QueryRunRegistry::string, track(), track_, and TrkTrack.

    : dr2_(std::pow(iConfig.getParameter<double>("maxDeltaR"), 2)),
      cut_(iConfig.getParameter<double>("maxPull")),
      diagOnly_(iConfig.getParameter<bool>("diagonalElementsOnly")),
      useVertex_(iConfig.getParameter<bool>("useVertexVariables")) {
  std::string track = iConfig.getParameter<std::string>("track");
  if (track == "standAloneMuon")
    track_ = StaTrack;
  else if (track == "combinedMuon")
    track_ = GlbTrack;
  else if (track == "track")
    track_ = TrkTrack;
  else
    throw cms::Exception("Configuration")
        << "MatcherByPullsAlgorithm: track '" << track << "' is not known\n"
        << "Allowed values are: 'track', 'combinedMuon', 'standAloneMuon' (as per reco::RecoCandidate object)\n";
}

~MatcherByPullsAlgorithm()

MatcherByPullsAlgorithm::~MatcherByPullsAlgorithm

(

)

Definition at line 31 of file MatcherByPullsAlgorithm.cc.

{}

Member Function Documentation

fillInvCov()

void MatcherByPullsAlgorithm::fillInvCov	(	const reco::Track &	tk,
		AlgebraicSymMatrix55 &	invCov
	)		const

Fill the inverse covariance matrix for the match(track, candidate, invCov) method.

Definition at line 143 of file MatcherByPullsAlgorithm.cc.

References reco::TrackBase::covariance(), diagOnly_, mps_fire::i, dqmiolumiharvest::j, and useVertex_.

Referenced by match(), and matchMany().

                                                                                                {
  if (useVertex_) {
    invCov = tk.covariance();
    if (diagOnly_) {
      for (size_t i = 0; i < 5; ++i) {
        for (size_t j = i + 1; j < 5; ++j) {
          invCov(i, j) = 0;
        }
      }
    }
    invCov.Invert();
  } else {
    AlgebraicSymMatrix33 momCov = tk.covariance().Sub<AlgebraicSymMatrix33>(0, 0);  // get 3x3 matrix
    if (diagOnly_) {
      momCov(0, 1) = 0;
      momCov(0, 2) = 0;
      momCov(1, 2) = 0;
    }
    momCov.Invert();
    invCov.Place_at(momCov, 0, 0);
  }
}

match() [1/3]

std::pair< bool, float > MatcherByPullsAlgorithm::match	(	const reco::Track &	tk,
		const reco::Candidate &	mc,
		const AlgebraicSymMatrix55 &	invertedCovariance
	)		const

Match Track to MC Candidate, using already inverted covariance matrix Return status of match and pull, or (-1,9e9)

Definition at line 40 of file MatcherByPullsAlgorithm.cc.

References HltBtagPostValidation_cff::c, reco::TrackBase::charge(), gather_cfg::cout, cut_, SiPixelRawToDigiRegional_cfi::deltaPhi, HLTMuonOfflineAnalyzer_cfi::deltaR2, change_name::diff, dr2_, reco::TrackBase::dsz(), reco::TrackBase::dxy(), reco::TrackBase::eta(), mps_fire::i, reco::TrackBase::phi(), reco::TrackBase::pt(), reco::TrackBase::qoverp(), mathSSE::sqrt(), reco::TrackBase::theta(), reco::TrackBase::vx(), reco::TrackBase::vy(), and reco::TrackBase::vz().

Referenced by match(), and matchMany().

                                                                                                {
  if (::deltaR2(tk, c) <= dr2_) {
    AlgebraicVector5 diff(tk.qoverp() - c.charge() / c.p(),
                          tk.theta() - c.theta(),
                          ::deltaPhi(tk.phi(), c.phi()),
                          tk.dxy(c.vertex()),
                          tk.dsz(c.vertex()));
    double pull = ROOT::Math::Similarity(diff, invCov);
#if 0
        std::cout << "Tk charge/pt/eta/phi/vx/vy/vz " << tk.charge() << "\t" << tk.pt() << "\t" << tk.eta() << "\t" << tk.phi() << "\t" << tk.vx() << "\t" << tk.vy() << "\t" << tk.vz() << std::endl;
        std::cout << "MC charge/pt/eta/phi/vx/vy/vz " << c.charge() << "\t" << c.pt() << "\t" << c.eta() << "\t" << c.phi() << "\t" << c.vx() << "\t" << c.vy() << "\t" << c.vz() << std::endl;
        std::cout << "Delta: " << diff << std::endl;
        std::cout << "Sigmas: ";
        for (size_t i = 0; i < 5; ++i) {
            if (invCov(i,i) == 0) std::cout << "---\t";
            else std::cout << std::sqrt(1.0/invCov(i,i)) << "\t";
        }
        std::cout << std::endl;
        std::cout << "Items: ";
        for (size_t i = 0; i < 5; ++i) {
            if (invCov(i,i) == 0) std::cout << "---\t";
            else std::cout << diff(i)*std::sqrt(invCov(i,i)) << "\t";
        }
        std::cout << std::endl;
        std::cout << "Pull: "  << pull << std::endl;
#endif
    return std::pair<bool, float>(pull < cut_, pull);
  }
  return std::pair<bool, float>(false, 9e9);
}

match() [2/3]

std::pair< int, float > MatcherByPullsAlgorithm::match	(	const reco::RecoCandidate &	src,
		const std::vector< reco::GenParticle > &	cands,
		const std::vector< uint8_t > &	good
	)		const

Match Reco Candidate to MC Candidates, skipping the ones which are not good Return index of matchin and pull, or (-1,9e9)

Definition at line 73 of file MatcherByPullsAlgorithm.cc.

References HLT_2023v12_cff::cands, caHitNtupletGeneratorKernels::good, match(), TrackRefitter_38T_cff::src, and track().

                                                                                           {
  const reco::Track *tk = track(src);
  return (tk == nullptr ? std::pair<int, float>(-1, 9e9) : match(*tk, cands, good));
}

match() [3/3]

std::pair< int, float > MatcherByPullsAlgorithm::match	(	const reco::Track &	src,
		const std::vector< reco::GenParticle > &	cands,
		const std::vector< uint8_t > &	good
	)		const

Match Reco Track to MC Tracks, skipping the ones which are not good Return index of matchin and pull, or (-1,9e9)

Definition at line 80 of file MatcherByPullsAlgorithm.cc.

References HLT_2023v12_cff::cands, fillInvCov(), caHitNtupletGeneratorKernels::good, mps_fire::i, visualization-live-secondInstance_cfg::m, match(), and dqmiodumpmetadata::n.

                                                                                           {
  std::pair<int, float> best(-1, 9e9);

  AlgebraicSymMatrix55 invCov;
  fillInvCov(tk, invCov);
  for (int i = 0, n = cands.size(); i < n; ++i) {
    if (!good[i])
      continue;
    std::pair<bool, float> m = match(tk, cands[i], invCov);
    if (m.first && (m.second < best.second)) {
      best.first = i;
      best.second = m.second;
    }
  }
  return best;
}

matchMany() [1/2]

void MatcherByPullsAlgorithm::matchMany	(	const reco::RecoCandidate &	src,
		const std::vector< reco::GenParticle > &	cands,
		const std::vector< uint8_t > &	good,
		std::vector< std::pair< double, int > > &	matchesToFill
	)		const

Match Reco Candidate to MC Candidates, allowing multiple matches and skipping the ones which are not good It will fill in the vector of <double,int> with pull and index for all matching candidates, already sorted by pulls. This method assumes that matchesToFill is empty when the method is called

Definition at line 99 of file MatcherByPullsAlgorithm.cc.

References HLT_2023v12_cff::cands, caHitNtupletGeneratorKernels::good, TrackRefitter_38T_cff::src, and track().

                                                                                               {
  const reco::Track *tk = track(src);
  if (tk != nullptr)
    matchMany(*tk, cands, good, matchesToFill);
}

matchMany() [2/2]

void MatcherByPullsAlgorithm::matchMany	(	const reco::Track &	src,
		const std::vector< reco::GenParticle > &	cands,
		const std::vector< uint8_t > &	good,
		std::vector< std::pair< double, int > > &	matchesToFill
	)		const

Match Reco Track to MC Tracks, allowing multiple matches and skipping the ones which are not good It will fill in the vector of <double,int> with pull and index for all matching candidates, already sorted by pulls. This method assumes that matchesToFill is empty when the method is called

Definition at line 108 of file MatcherByPullsAlgorithm.cc.

References HLT_2023v12_cff::cands, fillInvCov(), caHitNtupletGeneratorKernels::good, mps_fire::i, visualization-live-secondInstance_cfg::m, match(), dqmiodumpmetadata::n, and jetUpdater_cfi::sort.

                                                                                               {
  AlgebraicSymMatrix55 invCov;
  fillInvCov(tk, invCov);
  for (int i = 0, n = cands.size(); i < n; ++i) {
    if (!good[i])
      continue;
    std::pair<bool, double> m = match(tk, cands[i], invCov);
    if (m.first)
      matchesToFill.push_back(std::make_pair(m.second, i));
  }
  std::sort(matchesToFill.begin(), matchesToFill.end());
}

track()

const reco::Track * MatcherByPullsAlgorithm::track ( const reco::RecoCandidate &  src ) const

private

Get track out of Candidate, NULL if missing.

Definition at line 131 of file MatcherByPullsAlgorithm.cc.

References cms::cuda::assert(), GlbTrack, StaTrack, track_, and TrkTrack.

Referenced by match(), MatcherByPullsAlgorithm(), and matchMany().

                                                                                   {
  switch (track_) {
    case StaTrack:
      return muon.standAloneMuon().isNonnull() ? muon.standAloneMuon().get() : nullptr;
    case GlbTrack:
      return muon.combinedMuon().isNonnull() ? muon.combinedMuon().get() : nullptr;
    case TrkTrack:
      return muon.track().isNonnull() ? muon.track().get() : nullptr;
  }
  assert(false);
}

Member Data Documentation

cut_

double MatcherByPullsAlgorithm::cut_

private

Cut on the pull.

Definition at line 92 of file MatcherByPullsAlgorithm.h.

Referenced by match().

diagOnly_

bool MatcherByPullsAlgorithm::diagOnly_

private

Use only the diagonal terms of the covariance matrix.

Definition at line 95 of file MatcherByPullsAlgorithm.h.

Referenced by fillInvCov().

dr2_

double MatcherByPullsAlgorithm::dr2_

private

DeltaR of the matching cone.

Definition at line 89 of file MatcherByPullsAlgorithm.h.

Referenced by match().

track_

TrackChoice MatcherByPullsAlgorithm::track_

private

Track to be used in matching.

Definition at line 86 of file MatcherByPullsAlgorithm.h.

Referenced by MatcherByPullsAlgorithm(), and track().

useVertex_

bool MatcherByPullsAlgorithm::useVertex_

private

Use also dxy / dsz in the matching.

Definition at line 98 of file MatcherByPullsAlgorithm.h.

Referenced by fillInvCov().