CandMatcherBase< C1, C2 > Class Template Reference

#include <CandMatcher.h>

Inheritance diagram for CandMatcherBase< C1, C2 >:

Public Types
typedef reco::helper::CandMapTrait< C1, C2 >::type	map_type
	map type More...
typedef std::vector< const map_type * >	map_vector
	map vector More...
typedef reco::helper::CandRefTrait< C2 >::ref_type	ref_type
	ref type More...
typedef map_type::key_type	reference_type
	concrete candidate reference type More...
typedef reco::helper::CandRefTrait< C2 >::refProd_type	refProd_type
	refProd type More...
typedef reference_type::value_type	value_type
	concrete candidate reference type More...

Public Member Functions
	CandMatcherBase (const map_type &map)
	constructor More...
	CandMatcherBase (const map_vector &maps)
	constructor More...
ref_type	operator() (const reco::Candidate &) const
	get match from transient reference More...
virtual	~CandMatcherBase ()
	destructor More...

Protected Member Functions
virtual bool	compositePreselect (const reco::Candidate &c, const reco::Candidate &m) const =0
	composite candidate preselection More...
virtual std::vector< const reco::Candidate * >	getDaughters (const reco::Candidate *) const =0
	get ultimate daughter (can skip status = 3 in MC) More...
void	initMaps ()
	init maps More...
const std::vector< const map_type * > &	maps () const

Private Types
typedef std::map< const reco::Candidate *, reference_type >	CandRefMap
	pointer map type More...
typedef std::map< const reco::Candidate *, ref_type >	MatchedRefMap
	pointer map type More...

Private Member Functions
void	init ()
	init at constructor More...

Private Attributes
CandRefMap	candRefs_
	pointer map of candidates (e.g.: reco) More...
std::vector< const map_type * >	maps_
	pointers to stored maps More...
refProd_type	matched_
	reference to matched collectino More...
std::vector< std::set< size_t > >	matchedMothers_
	mother + n.daughters indices from matched More...
MatchedRefMap	matchedRefs_
	pointer map of matched candidates (e.g.: MC truth) More...

Detailed Description

template<typename C1, typename C2 = C1>
class CandMatcherBase< C1, C2 >

Definition at line 16 of file CandMatcher.h.

Member Typedef Documentation

CandRefMap

template<typename C1, typename C2 = C1>

typedef std::map<const reco::Candidate *, reference_type> CandMatcherBase< C1, C2 >::CandRefMap

private

pointer map type

Definition at line 55 of file CandMatcher.h.

map_type

template<typename C1, typename C2 = C1>

typedef reco::helper::CandMapTrait<C1, C2>::type CandMatcherBase< C1, C2 >::map_type

map type

Definition at line 19 of file CandMatcher.h.

map_vector

template<typename C1, typename C2 = C1>

typedef std::vector<const map_type *> CandMatcherBase< C1, C2 >::map_vector

map vector

Definition at line 25 of file CandMatcher.h.

MatchedRefMap

template<typename C1, typename C2 = C1>

typedef std::map<const reco::Candidate *, ref_type> CandMatcherBase< C1, C2 >::MatchedRefMap

private

pointer map type

Definition at line 57 of file CandMatcher.h.

ref_type

template<typename C1, typename C2 = C1>

typedef reco::helper::CandRefTrait<C2>::ref_type CandMatcherBase< C1, C2 >::ref_type

ref type

Definition at line 21 of file CandMatcher.h.

reference_type

template<typename C1, typename C2 = C1>

typedef map_type::key_type CandMatcherBase< C1, C2 >::reference_type

concrete candidate reference type

Definition at line 27 of file CandMatcher.h.

refProd_type

template<typename C1, typename C2 = C1>

typedef reco::helper::CandRefTrait<C2>::refProd_type CandMatcherBase< C1, C2 >::refProd_type

refProd type

Definition at line 23 of file CandMatcher.h.

value_type

template<typename C1, typename C2 = C1>

typedef reference_type::value_type CandMatcherBase< C1, C2 >::value_type

concrete candidate reference type

Definition at line 29 of file CandMatcher.h.

Constructor & Destructor Documentation

CandMatcherBase() [1/2]

template<typename C1, typename C2 = C1>

CandMatcherBase< C1, C2 >::CandMatcherBase ( const map_vector &  maps )

explicit

constructor

CandMatcherBase() [2/2]

template<typename C1, typename C2 = C1>

CandMatcherBase< C1, C2 >::CandMatcherBase ( const map_type &  map )

explicit

constructor

~CandMatcherBase()

template<typename C1 , typename C2 >

CandMatcherBase< C1, C2 >::~CandMatcherBase ( )

virtual

destructor

Definition at line 146 of file CandMatcher.h.

                                          {
}

Member Function Documentation

compositePreselect()

template<typename C1, typename C2 = C1>

virtual bool CandMatcherBase< C1, C2 >::compositePreselect ( const reco::Candidate &  c, const reco::Candidate &  m  ) const

protectedpure virtual

composite candidate preselection

Implemented in CandMatcher< C1, C2 >.

getDaughters()

template<typename C1, typename C2 = C1>

virtual std::vector<const reco::Candidate *> CandMatcherBase< C1, C2 >::getDaughters ( const reco::Candidate *  ) const

protectedpure virtual

get ultimate daughter (can skip status = 3 in MC)

Implemented in CandMatcher< C1, C2 >.

init()

template<typename C1 , typename C2 >

void CandMatcherBase< C1, C2 >::init ( void  )

private

init at constructor

Definition at line 89 of file CandMatcher.h.

                                   {
  matched_ = maps_.front()->refProd().val;
  for( typename map_vector::const_iterator m = maps_.begin() + 1; 
       m != maps_.end(); ++ m ) {
    if( (*m)->refProd().val != matched_ )
      throw edm::Exception( edm::errors::InvalidReference )
    << "Multiple match maps specified matching different MC truth collections.\n"
    << "Please, specify maps all matching to the same MC truth collection.\n"
    << "In most of the cases you may want to match to genParticleCandidate.";
  }
}

References edm::errors::InvalidReference, and visualization-live-secondInstance_cfg::m.

initMaps()

template<typename C1 , typename C2 >

void CandMatcherBase< C1, C2 >::initMaps ( )

protected

init maps

Definition at line 114 of file CandMatcher.h.

                                       {
  using namespace reco;
  using namespace std;
  for( typename map_vector::const_iterator m = maps_.begin(); 
       m != maps_.end(); ++ m ) {
    typename CandMatcherBase<C1, C2>::map_type::ref_type::key_type cands = (*m)->refProd().key;
    for( size_t i = 0; i < cands->size(); ++ i ) {
      candRefs_[ & (*cands)[ i ] ] = reference_type( cands, i );
    } 
    const C2 & matched = * matched_;
    size_t matchedSize = matched.size();
    for( size_t i = 0; i < matchedSize; ++ i )
      matchedRefs_[ & matched[ i ] ] = ref_type( matched_, i );
    matchedMothers_.resize( matchedSize );
    for( size_t i = 0; i < matchedSize; ++ i ) {
      const Candidate & c = matched[ i ];
      for( Candidate::const_iterator d = c.begin(); d != c.end(); ++ d ) {
    vector<const Candidate *> daus = getDaughters( & * d );
    for( size_t j = 0; j < daus.size(); ++ j ) {
      const Candidate * daughter = daus[ j ];
      typename MatchedRefMap::const_iterator f = matchedRefs_.find( daughter );
      if ( f == matchedRefs_.end() ) continue;
      size_t k = f->second.key();
      assert( k < matchedMothers_.size() );
      matchedMothers_[ k ].insert( i );
    }
      }
    }
  }
}

References cms::cuda::assert(), HltBtagPostValidation_cff::c, HLT_2018_cff::cands, ztail::d, f, getDaughters(), mps_fire::i, dqmiolumiharvest::j, dqmdumpme::k, visualization-live-secondInstance_cfg::m, and muonTagProbeFilters_cff::matched.

Referenced by CandMatcher< C1, C2 >::CandMatcher().

maps()

template<typename C1, typename C2 = C1>

const std::vector<const map_type *>& CandMatcherBase< C1, C2 >::maps ( ) const

inlineprotected

Definition at line 48 of file CandMatcher.h.

{ return maps_; }

References CandMatcherBase< C1, C2 >::maps_.

operator()()

template<typename C1 , typename C2 >

CandMatcherBase< C1, C2 >::ref_type CandMatcherBase< C1, C2 >::operator()

(

const reco::Candidate &

c

)

const

get match from transient reference

Definition at line 150 of file CandMatcher.h.

                                                                                                            {
  using namespace reco;
  using namespace std;
  if ( c.hasMasterClone() )
    return (*this)( * c.masterClone() );
  unsigned int nDau = c.numberOfDaughters();
  const C2 & matched = * matched_;
  if ( nDau > 0 ) {
    // check for composite candidate c
    // navigate to daughters and find parent matches
    set<size_t> momsIntersection, momDaughters, tmp;
    for( Candidate::const_iterator d = c.begin(); d != c.end(); ++ d ) {
      // check here generically if status == 3, then descend down to one more level
      ref_type m = (*this)( * d );
      // if a daughter does not match, return a null ref.
      if ( m.isNull() ) return ref_type();
      // get matched mother indices (fetched previously)
      const set<size_t> & allMomDaughters = matchedMothers_[ m.key() ];
      momDaughters.clear();
      for( set<size_t>::const_iterator k = allMomDaughters.begin(); 
       k != allMomDaughters.end(); ++ k ) {
    size_t m = * k;
    if( compositePreselect( c, matched[ m ] ) )
      momDaughters.insert( m );
      }
      // if no mother was found return null reference
      if ( momDaughters.size() == 0 ) return ref_type();
      // the first time, momsIntersection is set to momDaughters
      if ( momsIntersection.size() == 0 ) momsIntersection = momDaughters;
      else {
    tmp.clear();
    set_intersection( momsIntersection.begin(), momsIntersection.end(),
              momDaughters.begin(), momDaughters.end(),
             inserter( tmp, tmp.begin() ) );
    swap( momsIntersection, tmp );
      }
      if ( momsIntersection.size() == 0 ) return ref_type();
    }
    // if multiple mothers are found, return a null reference
    if ( momsIntersection.size() > 1 ) return ref_type();
    // return a reference to the unique mother
    return ref_type( matched_, * momsIntersection.begin() );
  } else {
    // check for non-composite (leaf) candidate 
    // if one of the maps contains the candidate c
    for( typename std::vector<const map_type *>::const_iterator m = maps_.begin(); 
     m != maps_.end(); ++ m ) {
      typename CandRefMap::const_iterator f = candRefs_.find( & c );
      if ( f != candRefs_.end() ) {
    reference_type ref = f->second;
    typename map_type::const_iterator f = (*m)->find( ref );
    if ( f != (*m)->end() ) {
      return f->val;
    }
      }
    }
    return ref_type();
  }
}

References HltBtagPostValidation_cff::c, ztail::d, f, dqmdumpme::k, visualization-live-secondInstance_cfg::m, muonTagProbeFilters_cff::matched, reco::swap(), and createJobs::tmp.

Member Data Documentation

candRefs_

template<typename C1, typename C2 = C1>

CandRefMap CandMatcherBase< C1, C2 >::candRefs_

private

pointer map of candidates (e.g.: reco)

Definition at line 59 of file CandMatcher.h.

maps_

template<typename C1, typename C2 = C1>

std::vector<const map_type *> CandMatcherBase< C1, C2 >::maps_

private

pointers to stored maps

Definition at line 51 of file CandMatcher.h.

Referenced by CandMatcherBase< C1, C2 >::maps().

matched_

template<typename C1, typename C2 = C1>

refProd_type CandMatcherBase< C1, C2 >::matched_

private

reference to matched collectino

Definition at line 53 of file CandMatcher.h.

matchedMothers_

template<typename C1, typename C2 = C1>

std::vector<std::set<size_t> > CandMatcherBase< C1, C2 >::matchedMothers_

private

mother + n.daughters indices from matched

Definition at line 63 of file CandMatcher.h.

matchedRefs_

template<typename C1, typename C2 = C1>

MatchedRefMap CandMatcherBase< C1, C2 >::matchedRefs_

private

pointer map of matched candidates (e.g.: MC truth)

Definition at line 61 of file CandMatcher.h.