TrigInDetTrackTruth Class Reference

#include <TrigInDetTrackTruth.h>

Collaboration diagram for TrigInDetTrackTruth:

Public Member Functions
	TrigInDetTrackTruth ()
	Constructors: POOL needs default constructor. More...
	TrigInDetTrackTruth (const HepMcParticleLink &p_tru_part, TrigIDHitStats hits)
	initialized constructor: easier way to construct an instance if there is just one true particle associated with a track More...
virtual	~TrigInDetTrackTruth ()
int	addMatch (HepMcParticleLink p_tru_part, TrigIDHitStats hits)
	accessor to fill object: returns index of new entry in vectors More...
int	index (HepMcParticleLink &) const
	method to find if a given HepMcParticleLink already exists in "map" and, if so, what is its index; if not found returns -1; relies on HepMcParticleLink overloaded == method (i.e. More...
const HepMcParticleLink *	bestMatch () const
	returns best match according to the number of hits More...
const HepMcParticleLink *	bestSiMatch () const
	returns best match according to the number of hits More...
const HepMcParticleLink *	bestTRTMatch () const
	returns best match according to the number of hits More...
const HepMcParticleLink *	truthMatch (unsigned int i) const
	returns matching true particle number i More...
unsigned int	nrMatches () const
	returns number of matching particles More...
unsigned int	nrCommonHits (unsigned int i) const
	returns number of common hits from true particle i and TrigInDetTrack More...
unsigned int	nrCommonSiHits (unsigned int i) const
	returns number of common hits from true particle i and TrigInDetTrack More...
unsigned int	nrCommonTRTHits (unsigned int i) const
	returns number of common hits from true particle i and TrigInDetTrack More...
unsigned int	nrCommonHitsBestSi () const
	returns total number of common hits from best match true particle and TrigInDetTrack More...
unsigned int	nrCommonHitsBestTRT () const
	returns total number of common hits from best match true particle and TrigInDetTrack More...
int	updateFamilyTree ()
	accessor to fill family tree: for each HepMcParticleLink in the internal vector of HepMC::GenParticles, this method searches for its mother in the same vector. More...
const std::vector< std::pair< unsigned int, unsigned int > > &	getFamilyTree () const
	returns copy of family tree "map" More...
bool	motherInChain (unsigned int) const
	given index of a GenParticle which matches the track returns true if its mother also matches the track and false if not More...
int	motherIndexInChain (unsigned int) const
	given index of a GenParticle which matches the track returns index of its mother, if it also matches the track, or -1 if not More...
bool	daughtersInChain (unsigned int) const
	given index of a GenParticle which matches the track returns true if it has stable a daughter which also matches the track and false if not More...
std::vector< unsigned int >	daughterIndicesInChain (unsigned int) const
	given index of a GenParticle which matches the track returns vector with indices of its daughters, if they also matches the track, or an empty vector if not More...

Private Attributes
int	m_best_match_hits
int	m_best_Si_match_hits
int	m_best_TRT_match_hits
std::vector< HepMcParticleLink >	m_true_part_vec
std::vector< TrigIDHitStats >	m_nr_common_hits
std::vector< std::pair< unsigned int, unsigned int > >	m_family_tree

Friends
class	TrigInDetTrackTruthCnv_p1
class	TrigInDetTrackTruthCnv_p1_test

Detailed Description

Definition at line 36 of file TrigInDetTrackTruth.h.

Constructor & Destructor Documentation

TrigInDetTrackTruth() [1/2]

TrigInDetTrackTruth::TrigInDetTrackTruth ( )

inline

Constructors: POOL needs default constructor.

Definition at line 56 of file TrigInDetTrackTruth.h.

                                 { };

TrigInDetTrackTruth() [2/2]

TrigInDetTrackTruth::TrigInDetTrackTruth ( const HepMcParticleLink &  p_tru_part, TrigIDHitStats  hits  )

inline

initialized constructor: easier way to construct an instance if there is just one true particle associated with a track

Definition at line 62 of file TrigInDetTrackTruth.h.

                                 { };
  
  // accessors: to add links to GenParticles to object and get 
  // index if already filled; addMatch returns index of new entry  
  int addMatch(HepMcParticleLink p_tru_part, TrigIDHitStats hits);
  int index(HepMcParticleLink&) const;
  
  // to get quantities
  const HepMcParticleLink* bestMatch() const;  
  const HepMcParticleLink* bestSiMatch() const;  
  const HepMcParticleLink* bestTRTMatch() const;  
  const HepMcParticleLink* truthMatch(unsigned int i) const;
  unsigned int nrMatches()                  const;

~TrigInDetTrackTruth()

virtual TrigInDetTrackTruth::~TrigInDetTrackTruth ( )

inlinevirtual

Definition at line 77 of file TrigInDetTrackTruth.h.

Member Function Documentation

addMatch()

int TrigInDetTrackTruth::addMatch	(	HepMcParticleLink	p_tru_part,
		TrigIDHitStats	hits
	)

accessor to fill object: returns index of new entry in vectors

Definition at line 34 of file TrigInDetTrackTruth.cxx.

{
  std::string thisName("TrigInDetTrackTruth::addMatch");
  MsgStream log(Athena::getMessageSvc(), thisName);
 
  log << MSG::DEBUG<< "Inserting HepMcParticleLink and TrigIDHitStats to TrigInDetTrackTruth map" << endmsg;
 
  int indx = index(p_tru_part);
  if ( indx >= 0 ) {
    // HepMcParticleLink already exists: replace in vectors
    log << MSG::DEBUG<< "HepMcParticleLink already in map: replacing" 
    << endmsg;
    m_true_part_vec[indx]  = p_tru_part; 
    m_nr_common_hits[indx] = hits;
  } else {
    // push back into vectors to use HepMcParticleLink as key
    m_true_part_vec.push_back(p_tru_part); 
    m_nr_common_hits.push_back( hits );
    indx = m_true_part_vec.size() - 1;
  }
 
  // to know the best match in total nr.hits 
  if ( m_best_match_hits == -1 || 
       (unsigned int)hits.total() > nrCommonHits(m_best_match_hits) )
    m_best_match_hits = m_true_part_vec.size() - 1;
 
  if ( m_best_Si_match_hits == -1 || 
       (unsigned int)(hits.pixhits() + hits.scthits())> nrCommonSiHits(m_best_Si_match_hits) )
    m_best_Si_match_hits = m_true_part_vec.size() - 1;
 
  if ( m_best_TRT_match_hits == -1 || 
       (unsigned int)hits.trthits() > nrCommonTRTHits(m_best_TRT_match_hits) )
    m_best_TRT_match_hits = m_true_part_vec.size() - 1;
 
  return indx;
}

bestMatch()

const HepMcParticleLink * TrigInDetTrackTruth::bestMatch

(

)

const

returns best match according to the number of hits

Definition at line 184 of file TrigInDetTrackTruth.cxx.

{
  return &(m_true_part_vec[m_best_match_hits]);
}

bestSiMatch()

const HepMcParticleLink * TrigInDetTrackTruth::bestSiMatch

(

)

const

returns best match according to the number of hits

Definition at line 190 of file TrigInDetTrackTruth.cxx.

{
  return &(m_true_part_vec[m_best_Si_match_hits]);
}

bestTRTMatch()

const HepMcParticleLink * TrigInDetTrackTruth::bestTRTMatch

(

)

const

returns best match according to the number of hits

Definition at line 196 of file TrigInDetTrackTruth.cxx.

{
  return &(m_true_part_vec[m_best_TRT_match_hits]);
}

daughterIndicesInChain()

std::vector< unsigned int > TrigInDetTrackTruth::daughterIndicesInChain

(

unsigned int

mother

)

const

given index of a GenParticle which matches the track returns vector with indices of its daughters, if they also matches the track, or an empty vector if not

Definition at line 277 of file TrigInDetTrackTruth.cxx.

                                                                                             {
 
  std::vector<unsigned int> v_indx;
  v_indx.clear();
  if ( m_family_tree.empty() ) return v_indx;
 
  std::vector< std::pair<unsigned int, unsigned int> >::const_iterator it,it_end = m_family_tree.end();
  unsigned int i=0;
  for (it = m_family_tree.begin(); it != it_end; ++it) {
    if (mother == (*it).first) {
      v_indx.push_back(i);
    }
    ++i;
  }
  return v_indx;
}

daughtersInChain()

bool TrigInDetTrackTruth::daughtersInChain

(

unsigned int

mother

)

const

given index of a GenParticle which matches the track returns true if it has stable a daughter which also matches the track and false if not

Definition at line 296 of file TrigInDetTrackTruth.cxx.

                                                                    {  
  std::vector<unsigned int> v_indx = daughterIndicesInChain(mother);
  return ( !(v_indx.empty()) );
}

getFamilyTree()

const std::vector< std::pair< unsigned int, unsigned int > > & TrigInDetTrackTruth::getFamilyTree

(

)

const

returns copy of family tree "map"

Definition at line 250 of file TrigInDetTrackTruth.cxx.

{
  return m_family_tree;
}

index()

int TrigInDetTrackTruth::index

(

HepMcParticleLink &

hep_link

)

const

method to find if a given HepMcParticleLink already exists in "map" and, if so, what is its index; if not found returns -1; relies on HepMcParticleLink overloaded == method (i.e.

compares only barcode)

Definition at line 74 of file TrigInDetTrackTruth.cxx.

                                                                {
 
  std::vector<HepMcParticleLink>::const_iterator it1, end=m_true_part_vec.end();
  int indx = 0;
  for (it1=m_true_part_vec.begin(); it1 != end; ++it1) {
    if (hep_link == (*it1)) {
      // HepMcParticleLink found in vector: return index
      return indx;
    }
    ++indx;
  }
  // HepMcParticleLink not found: return default -1
  return -1;
}

motherInChain()

bool TrigInDetTrackTruth::motherInChain

(

unsigned int

daughter

)

const

given index of a GenParticle which matches the track returns true if its mother also matches the track and false if not

Definition at line 271 of file TrigInDetTrackTruth.cxx.

                                                                   {
  return ( motherIndexInChain(daughter) >=0 );
}

motherIndexInChain()

int TrigInDetTrackTruth::motherIndexInChain

(

unsigned int

daughter

)

const

given index of a GenParticle which matches the track returns index of
its mother, if it also matches the track, or -1 if not

Definition at line 257 of file TrigInDetTrackTruth.cxx.

                                                                       {
 
  if ( m_family_tree.empty() ) return -1;
 
  std::vector< std::pair<unsigned int, unsigned int> >::const_iterator it,it_end = m_family_tree.end();
 
  for (it = m_family_tree.begin(); it != it_end; ++it) {
    if (daughter == (*it).second) return (int)(*it).first; 
  }
  return -1;
}

nrCommonHits()

unsigned int TrigInDetTrackTruth::nrCommonHits

(

unsigned int

i

)

const

returns number of common hits from true particle i and TrigInDetTrack

Definition at line 210 of file TrigInDetTrackTruth.cxx.

{
  if (i < m_true_part_vec.size()) return m_nr_common_hits[i].total();
  else return 0;
}

nrCommonHitsBestSi()

unsigned int TrigInDetTrackTruth::nrCommonHitsBestSi

(

)

const

returns total number of common hits from best match true particle and TrigInDetTrack

Definition at line 231 of file TrigInDetTrackTruth.cxx.

{
  return (m_nr_common_hits[m_best_Si_match_hits].scthits() + m_nr_common_hits[m_best_Si_match_hits].pixhits());
}

nrCommonHitsBestTRT()

unsigned int TrigInDetTrackTruth::nrCommonHitsBestTRT

(

)

const

returns total number of common hits from best match true particle and TrigInDetTrack

Definition at line 237 of file TrigInDetTrackTruth.cxx.

{
  return m_nr_common_hits[m_best_TRT_match_hits].trthits();
}

nrCommonSiHits()

unsigned int TrigInDetTrackTruth::nrCommonSiHits

(

unsigned int

i

)

const

returns number of common hits from true particle i and TrigInDetTrack

Definition at line 217 of file TrigInDetTrackTruth.cxx.

{
  if (i < m_true_part_vec.size()) return (m_nr_common_hits[i].pixhits() + m_nr_common_hits[i].scthits());
  else return 0;
}

nrCommonTRTHits()

unsigned int TrigInDetTrackTruth::nrCommonTRTHits

(

unsigned int

i

)

const

returns number of common hits from true particle i and TrigInDetTrack

Definition at line 224 of file TrigInDetTrackTruth.cxx.

{
  if (i < m_true_part_vec.size()) return m_nr_common_hits[i].trthits();
  else return 0;
}

nrMatches()

unsigned int TrigInDetTrackTruth::nrMatches

(

)

const

returns number of matching particles

Definition at line 244 of file TrigInDetTrackTruth.cxx.

{
  return m_true_part_vec.size();
}

truthMatch()

const HepMcParticleLink * TrigInDetTrackTruth::truthMatch

(

unsigned int

i

)

const

returns matching true particle number i

Definition at line 202 of file TrigInDetTrackTruth.cxx.

{
  if (i < m_true_part_vec.size()) return &(m_true_part_vec[i]);
  else return NULL;
}

updateFamilyTree()

int TrigInDetTrackTruth::updateFamilyTree

(

)

accessor to fill family tree: for each HepMcParticleLink in the internal vector of HepMC::GenParticles, this method searches for its mother in the same vector.

If the mother is in the vector, the method adds the relation as a a mother-daughter pair to the family tree vector note: this method can be used as many times as necessary as long as the association object is not constant

Definition at line 95 of file TrigInDetTrackTruth.cxx.

{
 
  std::string thisName("TrigInDetTrackTruth::updateFamilyTree");
  MsgStream log(Athena::getMessageSvc(), thisName);
 
  log << MSG::DEBUG<< "In TrigInDetTrackTruth::updateFamilyTree()" << endmsg;
 
  int nr_mothers_found=0;
  int child=-1; 
  std::vector<HepMcParticleLink>::iterator it1, end=m_true_part_vec.end();
 
  for (it1=m_true_part_vec.begin(); it1 != end; ++it1) 
    {
      child++;
      /* get production vertex GenParticle pointed to by this link */
      log << MSG::DEBUG<< "Looking for mother of matching particle nr "<<child<<endmsg;
 
      // first get GenParticle pointer
      if ( !it1->isValid() ) continue; 
   
      auto p_child = (*it1).cptr();
      log << MSG::DEBUG << "GenParticle " << child << " (" << p_child << "); PDG id=" 
      << p_child->pdg_id() << "; status=" << p_child->status() 
      << "; pT=" << p_child->momentum().perp() 
      << "; searches mother..." 
      << endmsg;
      
      // then get production vertex (check against null)
      auto p_child_vtx = p_child->production_vertex();
      if ( !p_child_vtx) 
    {
      log << MSG::DEBUG<<"GenVertex pointer null: jump to next particle"<<endmsg;
      continue;
    }
      log << MSG::DEBUG<< "GenParticle "<< child << " comes from vertex with pointer "
      << p_child_vtx << endmsg;
      
      /* find mother: there should be only one for final state particles 
     (particles which can leave energy deposits in detectors)        */
 
     // check a mother was found
      if ( p_child_vtx->particles_in_size()==0)
    {
      log << MSG::DEBUG<< "Mother not found: go to next particle" <<endmsg;
      continue;
    }  
#ifdef HEPMC3
     auto p_mum = p_child_vtx->particles_in().begin();
#else
      HepMC::GenVertex::particles_in_const_iterator p_mum = p_child_vtx->particles_in_const_begin();
#endif
      log << MSG::DEBUG<< "Mother GenParticle (" << *p_mum << ") found; PDG id=" 
      << (*p_mum)->pdg_id() << "; status=" << (*p_mum)->status()
      << "; pT=" << (*p_mum)->momentum().perp() 
      << "; does it match track?" 
      << endmsg;
      // mother is (*p_mum); still have to see if it is a match to this track
      std::vector<HepMcParticleLink>::iterator it2=m_true_part_vec.begin();
      
      bool mum_found=false;
      for (unsigned int mum=0; it2 != end; ++it2, ++mum) 
    {
      log << MSG::DEBUG << "* Trying daughter index=" << child 
          << " and mother index=" << mum << endmsg;
          auto p2 = *it2;
          if ( *p_mum == p2 )
        { // mother also matches track
          m_family_tree.push_back( std::pair<unsigned int, unsigned int>(mum,child) );
          mum_found=true;
          nr_mothers_found++;
          
          log << MSG::DEBUG << "* Mother also matches track! " 
          << nr_mothers_found 
          << " mother-daughter relations found so far" << endmsg;
          log << MSG::DEBUG << "Daughter "<< child <<" (PDG id="  
          << p_child->pdg_id() << "; pT=" << p_child->momentum().perp() 
          << ") comes from mother " << mum << " (PDG id=" 
          << (*p_mum)->status() << "; pT=" << p_child->momentum().perp() 
          << ")" << endmsg;
        }
    }
      if (!mum_found) log << MSG::DEBUG << "* Mother doesn't match track"
                  << endmsg; 
    }
  return nr_mothers_found;
}

Friends And Related Function Documentation

TrigInDetTrackTruthCnv_p1

friend class TrigInDetTrackTruthCnv_p1

friend

Definition at line 105 of file TrigInDetTrackTruth.h.

TrigInDetTrackTruthCnv_p1_test

friend class TrigInDetTrackTruthCnv_p1_test

friend

Definition at line 106 of file TrigInDetTrackTruth.h.

Member Data Documentation

m_best_match_hits

int TrigInDetTrackTruth::m_best_match_hits

private

Definition at line 109 of file TrigInDetTrackTruth.h.

m_best_Si_match_hits

int TrigInDetTrackTruth::m_best_Si_match_hits

private

Definition at line 110 of file TrigInDetTrackTruth.h.

m_best_TRT_match_hits

int TrigInDetTrackTruth::m_best_TRT_match_hits

private

Definition at line 111 of file TrigInDetTrackTruth.h.

m_family_tree

std::vector< std::pair<unsigned int, unsigned int> > TrigInDetTrackTruth::m_family_tree

private

Definition at line 118 of file TrigInDetTrackTruth.h.

m_nr_common_hits

std::vector<TrigIDHitStats> TrigInDetTrackTruth::m_nr_common_hits

private

Definition at line 115 of file TrigInDetTrackTruth.h.

m_true_part_vec

std::vector<HepMcParticleLink> TrigInDetTrackTruth::m_true_part_vec

private

Definition at line 114 of file TrigInDetTrackTruth.h.

---

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

• TrigInDetTrackTruth.h
• TrigInDetTrackTruth.cxx