CDCMCMap Class Reference

Class to organize and present the Monte Carlo hit information. More...

#include <CDCMCMap.h>

Public Member Functions
	CDCMCMap ()=default
	Default constructor, needs to be public for initialization in CDCMCManager.
CDCMCMap &	operator= (const CDCMCMap &)=delete
	Delete the assignment operator in order to avoid accidental copies.
	CDCMCMap (CDCMCMap &)=delete
	For the same reason, also delete copy constructor.
void	clear ()
	Clear all information from the former event.
void	fill ()
	Fill the Monte Carlo information retrieved from the DataStore into the local multimaps.
TrackingUtilities::MayBePtr< const CDCSimHit >	getSimHit (const CDCHit *hit) const
	Seeks the CDCSimHit related to the CDCHit.
TrackingUtilities::MayBePtr< const CDCHit >	getHit (const CDCSimHit *simHit) const
	Seeks the CDCHit related to the CDCSimHit - nullptr if no CDCHit is related.
bool	isBackground (const CDCSimHit *simHit) const
	Indicates if the CDCSimHit is considered background.
bool	isBackground (const CDCHit *hit) const
	Indicates if the CDCSimHit is considered background.
TrackingUtilities::MayBePtr< const MCParticle >	getMCParticle (const CDCHit *hit) const
	Seeks the MCParticle related to the CDCHit.
TrackingUtilities::MayBePtr< const MCParticle >	getMCParticle (const CDCSimHit *simHit) const
	Seeks the MCParticle related to the CDCSimHit.
auto	getSimHits (const MCParticle *mcParticle) const
	Getter for the range MCParticle to CDCSimHits relations which come from the given MCParticle.
auto	getHits (const MCParticle *mcParticle) const
	Getter for the range MCParticle to CDCHits relations which come from the given MCParticle.
bool	isReassignedSecondary (const CDCSimHit *ptrSimHit) const
	Indicates if the CDCSimHit has been reassigned to a primary MCParticle.
bool	isReassignedSecondary (const CDCHit *ptrHit) const
	Indicates if the CDCHit has been reassigned to a primary MCParticle.
const std::set< const CDCHit * > &	getReassignedSecondaryHits () const
	Getter for all reassigned secondary CDCHits.
const std::set< const CDCSimHit * > &	getReassignedSecondarySimHits () const
	Getter for all reassigned secondary CDCSimHits.
const std::multimap< const CDCHit *, const CDCSimHit * > &	getSimHitsByHit () const
	Getter for the CDCHit -> CDCSimHit relations.
const std::multimap< const MCParticle *, const CDCHit * > &	getHitsByMCParticle () const
	Getter for the MCParticle -> CDCHit relations.
const std::multimap< const MCParticle *, const CDCSimHit * > &	getSimHitsByMCParticle () const
	Getter for the MCParticle -> CDCSimHit relations.

Private Member Functions
void	fillSimHitByHitMap ()
	Retrieve the relations array from CDCSimHits to CDCHits and fill it in to the local map which does the inverse mapping.
void	fillMCParticleByHitMap ()
	Retrieve the relations array from MCParticle to CDCHits and fill it in to the local map which does the inverse mapping.
void	fillMCParticleBySimHitMap ()
	Retrieve the relations array from MCParticle to CDCSimHits and fill it in to the local map which does the inverse mapping.
void	validateRelations () const
	Checks if the relations CDCHit -> MCParticle and CDCHit -> CDCSimHit -> MCParticle commute.
void	validateReassignedSecondaries () const
	Checks if each CDCHit is marked as reassigned secondary is related to a reassigned secondary CDCSimHit.

Static Private Member Functions
static bool	indicatesReassignedSecondary (double weight)
	Indicate if the given weight suggests that the corresponding hit to MCParticle relation has been redirected to point to a primary particle instead of the discarded secondary particle.

Private Attributes
std::multimap< const CDCHit *, const CDCSimHit * >	m_simHitsByHit
	Memory for a one to one relation from CDCHit to CDCSimHits.
std::multimap< const MCParticle *, const CDCHit * >	m_hitsByMCParticle
	Memory for a one to n relation from MCParticles to CDCHit.
std::multimap< const MCParticle *, const CDCSimHit * >	m_simHitsByMCParticle
	Memory for a one to n relation from MCParticles to CDCSimHit.
std::set< const CDCHit * >	m_reassignedSecondaryHits
	The set of reassigned secondary CDCHits.
std::set< const CDCSimHit * >	m_reassignedSecondarySimHits
	The set of reassigned secondary CDCSimHits.

Detailed Description

Class to organize and present the Monte Carlo hit information.

Definition at line 28 of file CDCMCMap.h.

Member Function Documentation

clear()

void clear

(

)

Clear all information from the former event.

Definition at line 33 of file CDCMCMap.cc.

{
  B2DEBUG(25, "In CDCMCMap::clear()");
  m_simHitsByHit.clear();
 
  m_hitsByMCParticle.clear();
  m_simHitsByMCParticle.clear();
 
  m_reassignedSecondaryHits.clear();
  m_reassignedSecondarySimHits.clear();
}

fill()

void fill

(

)

Fill the Monte Carlo information retrieved from the DataStore into the local multimaps.

Definition at line 45 of file CDCMCMap.cc.

{
  B2DEBUG(25, "In CDCMCMap::fill()");
  clear();
 
  fillSimHitByHitMap();
  fillMCParticleByHitMap();
  fillMCParticleBySimHitMap();
 
  validateRelations();
  validateReassignedSecondaries();
 
  B2DEBUG(25, "m_simHitsByHit.size(): " << m_simHitsByHit.size());
 
  B2DEBUG(25, "m_hitsByMCParticle.size(): " << m_hitsByMCParticle.size());
  B2DEBUG(25, "m_simHitsByMCParticle.size(): " << m_simHitsByMCParticle.size());
 
  B2DEBUG(25, "m_reassignedSecondaryHits.size(): " << m_reassignedSecondaryHits.size());
  B2DEBUG(25, "m_reassignedSecondarySimHits.size(): " << m_reassignedSecondarySimHits.size());
}

fillMCParticleByHitMap()

void fillMCParticleByHitMap ( )

private

Retrieve the relations array from MCParticle to CDCHits and fill it in to the local map which does the inverse mapping.

Definition at line 104 of file CDCMCMap.cc.

{
  StoreArray<CDCHit> hits;
 
  std::map<const MCParticle*, std::vector<const CDCSimHit*>> primarySimHitsByMCParticle;
 
  for (const CDCHit& hit : hits) {
    const CDCHit* ptrHit = &hit;
    RelationVector<MCParticle> relatedMCParticles = hit.getRelationsFrom<MCParticle>();
 
    const int nRelatedMCParticles = relatedMCParticles.size();
 
    if (nRelatedMCParticles == 0 and not isBackground(ptrHit)) {
      B2WARNING("CDCHit has no related MCParticle but CDCHit indicates that it is no "
                "background in CDCMCMap::fill()");
    }
 
    if (nRelatedMCParticles > 1) {
      B2WARNING("CDCHit as more than one related MCParticle - reorganize the mapping");
    }
 
    // Pickup an iterator for hinted insertion
    auto itInsertHint = m_hitsByMCParticle.end();
    for (int iRelatedMCParticle = 0; iRelatedMCParticle < nRelatedMCParticles; ++iRelatedMCParticle) {
      const MCParticle* ptrMCParticle = relatedMCParticles[iRelatedMCParticle];
      double weight = relatedMCParticles.weight(iRelatedMCParticle);
 
      if (indicatesReassignedSecondary(weight)) {
        m_reassignedSecondaryHits.insert(ptrHit);
      } else {
        const CDCSimHit* ptrSimHit = ptrHit->getRelatedFrom<CDCSimHit>();
        if (ptrMCParticle->isPrimaryParticle() and ptrSimHit) {
          primarySimHitsByMCParticle[ptrMCParticle].push_back(ptrSimHit);
        }
      }
 
      itInsertHint = m_hitsByMCParticle.insert(itInsertHint, {ptrMCParticle, ptrHit});
    }
  }
 
  // Check time ordering of primary hits
  int nSortedIncorretly = 0;
  auto lessFlightTime = [](const CDCSimHit * lhs, const CDCSimHit * rhs) {
    return lhs->getFlightTime() < rhs->getFlightTime();
  };
 
  auto lessArrayIndex = [](const CDCSimHit * lhs, const CDCSimHit * rhs) -> bool {
    return lhs->getArrayIndex() < rhs->getArrayIndex();
  };
 
  for (std::pair<const MCParticle* const, std::vector<const CDCSimHit*>>&
       primarySimHitsForMCParticle : primarySimHitsByMCParticle) {
 
    const MCParticle* ptrMCParticle = primarySimHitsForMCParticle.first;
    std::vector<const CDCSimHit*>& simHits = primarySimHitsForMCParticle.second;
    std::sort(simHits.begin(), simHits.end(), lessArrayIndex);
    auto itSorted = std::is_sorted_until(simHits.begin(), simHits.end(), lessFlightTime);
    if (itSorted != simHits.end()) {
      ++nSortedIncorretly;
      B2DEBUG(25,
              "CDCSimHits for MCParticle " << ptrMCParticle->getArrayIndex()
              << " only sorted correctly up to hit number "
              << std::distance(simHits.begin(), itSorted));
      --itSorted;
      B2DEBUG(25,
              "Between wire " << (*itSorted)->getWireID() << " " << (*itSorted)->getFlightTime()
              << "ns "
              << (*itSorted)->getArrayIndex());
      ++itSorted;
      B2DEBUG(25,
              "and wire " << (*itSorted)->getWireID() << " " << (*itSorted)->getFlightTime()
              << "ns "
              << (*itSorted)->getArrayIndex());
    }
  }
  if (nSortedIncorretly) {
    B2WARNING("(BII-2136) CDCSimHits for "
              << nSortedIncorretly
              << " primary mc particles are not sorted correctly by their time of flight");
  }
}

fillMCParticleBySimHitMap()

void fillMCParticleBySimHitMap ( )

private

Retrieve the relations array from MCParticle to CDCSimHits and fill it in to the local map which does the inverse mapping.

Definition at line 186 of file CDCMCMap.cc.

{
  StoreArray<CDCSimHit> simHits;
 
  for (const CDCSimHit& simHit : simHits) {
    const CDCSimHit* ptrSimHit = &simHit;
    RelationVector<MCParticle> relatedMCParticles = simHit.getRelationsFrom<MCParticle>();
 
    const int nRelatedMCParticles = relatedMCParticles.size();
 
    if (nRelatedMCParticles == 0 and not isBackground(ptrSimHit)) {
      B2WARNING("CDCSimHit has no related MCParticle but CDCSimHit indicates that it is no "
                "background in CDCMCMap::fill()");
    }
 
    if (nRelatedMCParticles > 1) {
      B2WARNING("CDCSimHit as more than one related MCParticle - reorganize the mapping");
    }
 
    // Pickup an iterator for hinted insertion
    auto itInsertHint = m_simHitsByMCParticle.end();
    for (int iRelatedMCParticle = 0; iRelatedMCParticle < nRelatedMCParticles; ++iRelatedMCParticle) {
      const MCParticle* ptrMCParticle = relatedMCParticles[iRelatedMCParticle];
      double weight = relatedMCParticles.weight(iRelatedMCParticle);
 
      if (indicatesReassignedSecondary(weight)) {
        m_reassignedSecondarySimHits.insert(ptrSimHit);
      }
 
      itInsertHint = m_simHitsByMCParticle.insert(itInsertHint, {ptrMCParticle, ptrSimHit});
    }
  }
}

fillSimHitByHitMap()

void fillSimHitByHitMap ( )

private

Retrieve the relations array from CDCSimHits to CDCHits and fill it in to the local map which does the inverse mapping.

Definition at line 66 of file CDCMCMap.cc.

{
  StoreArray<CDCSimHit> simHits;
  StoreArray<CDCHit> hits;
 
  // Pickup an iterator for hinted insertion
  auto itInsertHint = m_simHitsByHit.end();
 
  for (const CDCSimHit& simHit : simHits) {
    const CDCSimHit* ptrSimHit = &simHit;
    RelationVector<CDCHit> relatedHits = simHit.getRelationsTo<CDCHit>();
 
    int nRelatedHits = relatedHits.size();
    if (nRelatedHits > 1) {
      B2WARNING("CDCSimHit as more than one related CDCHit - reorganize the mapping");
    }
 
    for (const CDCHit& hit : relatedHits) {
      const CDCHit* ptrHit = &hit;
 
      if (m_simHitsByHit.count(ptrHit) != 0) {
        B2WARNING("CDCHit as more than one related CDCSimHit - reorganize the mapping");
      }
 
      itInsertHint = m_simHitsByHit.insert(itInsertHint, {ptrHit, ptrSimHit});
    }
  }
 
  // Check if every hit has a corresponding simulated hit
  for (const CDCHit& hit : hits) {
    const CDCHit* ptrHit = &hit;
 
    if (m_simHitsByHit.count(ptrHit) == 0) {
      B2WARNING("CDCHit has no related CDCSimHit in CDCMCMap::fill()");
    }
  }
}

getHit()

MayBePtr< const CDCHit > getHit

(

const CDCSimHit *

simHit

)

const

Seeks the CDCHit related to the CDCSimHit - nullptr if no CDCHit is related.

Definition at line 255 of file CDCMCMap.cc.

{
  return simHit ? simHit->getRelated<CDCHit>() : nullptr;
}

getHits()

auto getHits ( const MCParticle * mcParticle ) const

inline

Getter for the range MCParticle to CDCHits relations which come from the given MCParticle.

Definition at line 104 of file CDCMCMap.h.

      {
        return TrackingUtilities::asRange(m_hitsByMCParticle.equal_range(mcParticle));
      }

getHitsByMCParticle()

const std::multimap< const MCParticle *, const CDCHit * > & getHitsByMCParticle ( ) const

inline

Getter for the MCParticle -> CDCHit relations.

Definition at line 140 of file CDCMCMap.h.

      {
        return m_hitsByMCParticle;
      }

getMCParticle() [1/2]

MayBePtr< const MCParticle > getMCParticle

(

const CDCHit *

hit

)

const

Seeks the MCParticle related to the CDCHit.

Nullptr if no MCParticle is related, this is also the case for background hits.

Definition at line 270 of file CDCMCMap.cc.

{
  return hit ? hit->getRelated<MCParticle>() : nullptr;
}

getMCParticle() [2/2]

MayBePtr< const MCParticle > getMCParticle

(

const CDCSimHit *

simHit

)

const

Seeks the MCParticle related to the CDCSimHit.

Nullptr if no MCParticle is related, this is also the case for background hits.

Definition at line 275 of file CDCMCMap.cc.

{
  return simHit ? simHit->getRelated<MCParticle>() : nullptr;
}

getReassignedSecondaryHits()

const std::set< const CDCHit * > & getReassignedSecondaryHits ( ) const

inline

Getter for all reassigned secondary CDCHits.

Definition at line 122 of file CDCMCMap.h.

      {
        return m_reassignedSecondaryHits;
      }

getReassignedSecondarySimHits()

const std::set< const CDCSimHit * > & getReassignedSecondarySimHits ( ) const

inline

Getter for all reassigned secondary CDCSimHits.

Definition at line 128 of file CDCMCMap.h.

      {
        return m_reassignedSecondarySimHits;
      }

getSimHit()

MayBePtr< const CDCSimHit > getSimHit

(

const CDCHit *

hit

)

const

Seeks the CDCSimHit related to the CDCHit.

Definition at line 250 of file CDCMCMap.cc.

{
  return hit ? hit->getRelated<CDCSimHit>() : nullptr;
}

getSimHits()

auto getSimHits ( const MCParticle * mcParticle ) const

inline

Getter for the range MCParticle to CDCSimHits relations which come from the given MCParticle.

Definition at line 98 of file CDCMCMap.h.

      {
        return TrackingUtilities::asRange(m_simHitsByMCParticle.equal_range(mcParticle));
      }

getSimHitsByHit()

const std::multimap< const CDCHit *, const CDCSimHit * > & getSimHitsByHit ( ) const

inline

Getter for the CDCHit -> CDCSimHit relations.

Definition at line 134 of file CDCMCMap.h.

      {
        return m_simHitsByHit;
      }

getSimHitsByMCParticle()

const std::multimap< const MCParticle *, const CDCSimHit * > & getSimHitsByMCParticle ( ) const

inline

Getter for the MCParticle -> CDCSimHit relations.

Definition at line 146 of file CDCMCMap.h.

      {
        return m_simHitsByMCParticle;
      }

indicatesReassignedSecondary()

static bool indicatesReassignedSecondary ( double weight )

inlinestaticprivate

Indicate if the given weight suggests that the corresponding hit to MCParticle relation has been redirected to point to a primary particle instead of the discarded secondary particle.

Definition at line 52 of file CDCMCMap.h.

      {
        return weight <= 0;
      }

isBackground() [1/2]

bool isBackground

(

const CDCHit *

hit

)

const

Indicates if the CDCSimHit is considered background.

Definition at line 265 of file CDCMCMap.cc.

{
  return isBackground(getSimHit(hit));
}

isBackground() [2/2]

bool isBackground

(

const CDCSimHit *

simHit

)

const

Indicates if the CDCSimHit is considered background.

Definition at line 260 of file CDCMCMap.cc.

{
  return simHit ? simHit->getBackgroundTag() != BackgroundMetaData::bg_none : false;
}

isReassignedSecondary() [1/2]

bool isReassignedSecondary ( const CDCHit * ptrHit ) const

inline

Indicates if the CDCHit has been reassigned to a primary MCParticle.

Definition at line 116 of file CDCMCMap.h.

      {
        return m_reassignedSecondaryHits.count(ptrHit) > 0;
      }

isReassignedSecondary() [2/2]

bool isReassignedSecondary ( const CDCSimHit * ptrSimHit ) const

inline

Indicates if the CDCSimHit has been reassigned to a primary MCParticle.

Definition at line 110 of file CDCMCMap.h.

      {
        return m_reassignedSecondarySimHits.count(ptrSimHit) > 0;
      }

validateReassignedSecondaries()

void validateReassignedSecondaries ( ) const

private

Checks if each CDCHit is marked as reassigned secondary is related to a reassigned secondary CDCSimHit.

Definition at line 239 of file CDCMCMap.cc.

{
  for (const CDCHit* ptrHit : m_reassignedSecondaryHits) {
 
    const CDCSimHit* ptrSimHit = getSimHit(ptrHit);
    if (not isReassignedSecondary(ptrSimHit)) {
      B2WARNING("CDCHit is reassigned secondary but related CDCSimHit is not.");
    }
  }
}

validateRelations()

void validateRelations ( ) const

private

Checks if the relations CDCHit -> MCParticle and CDCHit -> CDCSimHit -> MCParticle commute.

Definition at line 220 of file CDCMCMap.cc.

{
  StoreArray<CDCHit> hits;
 
  for (const CDCHit& hit : hits) {
    const CDCHit* ptrHit = &hit;
 
    const CDCSimHit* ptrSimHit = getSimHit(ptrHit);
    const MCParticle* ptrMCParticle = getMCParticle(ptrHit);
 
    const MCParticle* ptrMCParticleFromSimHit = getMCParticle(ptrSimHit);
 
    if (ptrMCParticle != ptrMCParticleFromSimHit) {
      B2WARNING("MCParticle from CDCHit and MCParticle from related CDCSimHit mismatch in "
                "CDCMCMap::validateRelations()");
    }
  }
}

Member Data Documentation

m_hitsByMCParticle

std::multimap<const MCParticle*, const CDCHit*> m_hitsByMCParticle

private

Memory for a one to n relation from MCParticles to CDCHit.

Definition at line 156 of file CDCMCMap.h.

m_reassignedSecondaryHits

std::set<const CDCHit*> m_reassignedSecondaryHits

private

The set of reassigned secondary CDCHits.

Definition at line 162 of file CDCMCMap.h.

m_reassignedSecondarySimHits

std::set<const CDCSimHit*> m_reassignedSecondarySimHits

private

The set of reassigned secondary CDCSimHits.

Definition at line 165 of file CDCMCMap.h.

m_simHitsByHit

std::multimap<const CDCHit*, const CDCSimHit*> m_simHitsByHit

private

Memory for a one to one relation from CDCHit to CDCSimHits.

Definition at line 153 of file CDCMCMap.h.

m_simHitsByMCParticle

std::multimap<const MCParticle*, const CDCSimHit*> m_simHitsByMCParticle

private

Memory for a one to n relation from MCParticles to CDCSimHit.

Definition at line 159 of file CDCMCMap.h.

---

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

• tracking/trackFindingCDC/mclookup/include/CDCMCMap.h
• tracking/trackFindingCDC/mclookup/src/CDCMCMap.cc