CDCSimHitLookUp Class Reference

Singletone class to gather local information about the hits. More...

#include <CDCSimHitLookUp.h>

Public Member Functions
	CDCSimHitLookUp (CDCSimHitLookUp &)=delete
	Singleton: Delete copy constructor and assignment operator.
CDCSimHitLookUp &	operator= (const CDCSimHitLookUp &)=delete
	Operator =.
	CDCSimHitLookUp ()=default
	Default constructor - for cppcheck.
void	clear ()
	Clear all information from the last event.
void	fill (const CDCMCMap *ptrMCMap)
	Gather the information about the right left passage using the CDCMCMap.
const CDCSimHit *	getClosestPrimarySimHit (const CDCHit *ptrHit) const
	Look up and return the closest primary simulated hit for the given CDCHit - if no suitable hit can be found return the secondary.
ROOT::Math::XYZVector	getDirectionOfFlight (const CDCHit *ptrHit)
	Calculate the local direction of flight. If the hit is secondary take the direction of flight from a close by primary - null vector if it cannot be assumed this way.
TrackingUtilities::ERightLeft	getRLInfo (const CDCHit *ptrHit) const
	Look up the Monte Carlo right left passage information for the given hit.
ROOT::Math::XYZVector	getRecoPos3D (const CDCHit *ptrHit) const
	Look up the position of the primary ionisation from related simulated hit.
double	getDriftLength (const CDCHit *ptrHit) const
	Look up the drift length from the primary ionisation to the wire from related simulated hit.
ROOT::Math::XYZVector	getClosestPrimaryRecoPos3D (const CDCHit *ptrHit) const
	Look up the position of the primary ionisation from the closest primary simulated hit.
double	getClosestPrimaryDriftLength (const CDCHit *ptrHit) const
	Look up the drift length from the primary ionisation to the wire from related simulated hit.
const TrackingUtilities::CDCWireHit *	getWireHit (const CDCHit *ptrHit, const std::vector< TrackingUtilities::CDCWireHit > &wireHits) const
	Retrieve the wire hit the given CDCHit form the given wire hits.
TrackingUtilities::CDCRLWireHit	getRLWireHit (const CDCHit *ptrHit, const std::vector< TrackingUtilities::CDCWireHit > &wireHits) const
	Retrieve the wire hit including right left passage information for the given CDCHit form the given wire hits.
TrackingUtilities::CDCRecoHit3D	getRecoHit3D (const CDCHit *ptrHit, const std::vector< TrackingUtilities::CDCWireHit > &wireHits) const
	Construct an CDCRecoHit3D from the (potential secondary) CDCSimHit information related to the CDCHit.
TrackingUtilities::CDCRecoHit3D	getClosestPrimaryRecoHit3D (const CDCHit *ptrHit, const std::vector< TrackingUtilities::CDCWireHit > &wireHits) const
	Construct an CDCRecoHit3D from the closest primary CDCSimHit information related to the CDCHit.
TrackingUtilities::CDCRecoHit2D	getRecoHit2D (const CDCHit *ptrHit, const std::vector< TrackingUtilities::CDCWireHit > &wireHits) const
	Construct an TrackingUtilities::CDCRecoHit2D from the (potential secondary) CDCSimHit information related to the CDCHit.
TrackingUtilities::CDCRecoHit2D	getClosestPrimaryRecoHit2D (const CDCHit *ptrHit, const std::vector< TrackingUtilities::CDCWireHit > &wireHits) const
	Construct an TrackingUtilities::CDCRecoHit2D from the closest primary CDCSimHit information related to the CDCHit.

Static Public Member Functions
static const CDCSimHitLookUp &	getInstance ()
	Getter for the singletone instance.

Private Member Functions
void	fillPrimarySimHits ()
	Constructs the relation from reassigned secondary to a close by primary hit from the same MCParticle.
TrackingUtilities::MayBePtr< const CDCSimHit >	getClosestPrimarySimHit (const CDCSimHit *ptrSimHit) const
	Helper function to find the closest primary hit for the given CDCSimHit from the same MCParticle - nullptr if no suitable hit can be found.
void	fillRLInfo ()
	Construct the look up relation for the right left passage information as used in track finding.

Private Attributes
const CDCMCMap *	m_ptrMCMap
	Reference to the CDCMCMap to be used in this event.
std::map< const CDCHit *, TrackingUtilities::MayBePtr< const CDCSimHit > >	m_primarySimHits
	Memory for the look up relation of close primary CDCSimHits.
std::map< const CDCHit *, TrackingUtilities::ERightLeft >	m_rightLeftInfos
	Memory for the look up relation of the right left passage information as defined in tracking.

Detailed Description

Singletone class to gather local information about the hits.

Because of the reassignment of secondary hits and the different definition of the right left passage in the CDCSimHit compared to the definition used in tracking finding, we provide this class to collect an manage localised information about each hit such as the local direction of travel and said left right passage information.

Definition at line 44 of file CDCSimHitLookUp.h.

Member Function Documentation

clear()

void clear

(

)

Clear all information from the last event.

Definition at line 38 of file CDCSimHitLookUp.cc.

{
  m_ptrMCMap = nullptr;
 
  m_primarySimHits.clear();
  m_rightLeftInfos.clear();
}

fill()

void fill

(

const CDCMCMap *

ptrMCMap

)

Gather the information about the right left passage using the CDCMCMap.

Definition at line 46 of file CDCSimHitLookUp.cc.

{
  B2DEBUG(25, "In CDCSimHitLookUp::fill()");
  clear();
  m_ptrMCMap = ptrMCMap;
 
  fillPrimarySimHits();
  fillRLInfo();
 
  B2DEBUG(25, "m_primarySimHits.size(): " << m_primarySimHits.size());
  B2DEBUG(25, "m_rightLeftInfos.size(): " << m_rightLeftInfos.size());
}

fillPrimarySimHits()

void fillPrimarySimHits ( )

private

Constructs the relation from reassigned secondary to a close by primary hit from the same MCParticle.

Definition at line 59 of file CDCSimHitLookUp.cc.

{
  if (not m_ptrMCMap) {
    B2WARNING("CDCMCMap not set. Cannot setup primary sim hit map");
    return;
  }
 
  const CDCMCMap& mcMap = *m_ptrMCMap;
  int nMissingPrimarySimHits = 0;
  for (const auto& relation : mcMap.getSimHitsByHit()) {
 
    const CDCHit* ptrHit = std::get<const CDCHit* const>(relation);
    const CDCSimHit* ptrSimHit = std::get<const CDCSimHit*>(relation);
 
    if (not ptrSimHit) {
      B2ERROR("CDCHit has no related CDCSimHit in CDCSimHitLookUp::fill()");
      continue;
    }
 
    if (mcMap.isReassignedSecondary(ptrSimHit)) {
      MayBePtr<const CDCSimHit> primarySimHit = getClosestPrimarySimHit(ptrSimHit);
      if (not primarySimHit) {
        ++nMissingPrimarySimHits;
      }
      m_primarySimHits[ptrHit] = primarySimHit;
    }
  }
  if (nMissingPrimarySimHits != 0) {
    B2WARNING("NO primary hit found for " << nMissingPrimarySimHits << " reassigned secondaries");
  }
}

fillRLInfo()

void fillRLInfo ( )

private

Construct the look up relation for the right left passage information as used in track finding.

Definition at line 210 of file CDCSimHitLookUp.cc.

{
 
  if (not m_ptrMCMap) {
    B2WARNING("CDCMCMap not set. Cannot setup right left passage information map");
    return;
  }
  const CDCMCMap& mcMap = *m_ptrMCMap;
 
  for (const auto& relation : mcMap.getSimHitsByHit()) {
 
    const CDCHit* ptrHit = std::get<const CDCHit* const>(relation);
    const CDCSimHit* ptrSimHit = std::get<const CDCSimHit*>(relation);
 
    if (not ptrSimHit) continue;
    const CDCSimHit& simHit = *ptrSimHit;
 
    ROOT::Math::XYZVector directionOfFlight = getDirectionOfFlight(ptrHit);
    if (VectorUtil::isNull(directionOfFlight)) continue;
 
    // find out if the wire is right or left of the track ( view in flight direction )
    ROOT::Math::XYZVector trackPosToWire{simHit.getPosWire() - simHit.getPosTrack()};
    ERightLeft rlInfo = VectorUtil::isRightOrLeftOf(VectorUtil::getXYVector(trackPosToWire),
                                                    VectorUtil::getXYVector(directionOfFlight));
    m_rightLeftInfos[ptrHit] = rlInfo;
  }
}

getClosestPrimaryDriftLength()

double getClosestPrimaryDriftLength

(

const CDCHit *

ptrHit

)

const

Look up the drift length from the primary ionisation to the wire from related simulated hit.

If no primary sim hit is available use the information from the secondary hit

Definition at line 292 of file CDCSimHitLookUp.cc.

{
  const CDCSimHit* ptrPrimarySimHit = getClosestPrimarySimHit(ptrHit);
  if (ptrPrimarySimHit) {
    const CDCSimHit& primarySimHit = *ptrPrimarySimHit;
    return primarySimHit.getDriftLength();
  } else {
    return getDriftLength(ptrHit);
  }
}

getClosestPrimaryRecoHit2D()

CDCRecoHit2D getClosestPrimaryRecoHit2D	(	const CDCHit *	ptrHit,
		const std::vector< TrackingUtilities::CDCWireHit > &	wireHits ) const

Construct an TrackingUtilities::CDCRecoHit2D from the closest primary CDCSimHit information related to the CDCHit.

Definition at line 354 of file CDCSimHitLookUp.cc.

{
  return getClosestPrimaryRecoHit3D(ptrHit, wireHits).getRecoHit2D();
}

getClosestPrimaryRecoHit3D()

CDCRecoHit3D getClosestPrimaryRecoHit3D	(	const CDCHit *	ptrHit,
		const std::vector< TrackingUtilities::CDCWireHit > &	wireHits ) const

Construct an CDCRecoHit3D from the closest primary CDCSimHit information related to the CDCHit.

Definition at line 337 of file CDCSimHitLookUp.cc.

{
  CDCRLWireHit rlWireHit = getRLWireHit(ptrHit, wireHits);
  double driftLength = getClosestPrimaryDriftLength(ptrHit);
  rlWireHit.setRefDriftLength(driftLength);
  ROOT::Math::XYZVector recoPos3D = getClosestPrimaryRecoPos3D(ptrHit);
  return CDCRecoHit3D(rlWireHit, recoPos3D);
}

getClosestPrimaryRecoPos3D()

ROOT::Math::XYZVector getClosestPrimaryRecoPos3D

(

const CDCHit *

ptrHit

)

const

Look up the position of the primary ionisation from the closest primary simulated hit.

If no primary sim hit is available use the information from the secondary hit

Definition at line 282 of file CDCSimHitLookUp.cc.

{
  const CDCSimHit* ptrPrimarySimHit = getClosestPrimarySimHit(ptrHit);
  if (ptrPrimarySimHit) {
    const CDCSimHit& primarySimHit = *ptrPrimarySimHit;
    return ROOT::Math::XYZVector{primarySimHit.getPosTrack()};
  } else {
    return getRecoPos3D(ptrHit);
  }
}

getClosestPrimarySimHit() [1/2]

const CDCSimHit * getClosestPrimarySimHit

(

const CDCHit *

ptrHit

)

const

Look up and return the closest primary simulated hit for the given CDCHit - if no suitable hit can be found return the secondary.

Definition at line 159 of file CDCSimHitLookUp.cc.

{
  if (not m_ptrMCMap) {
    B2WARNING("CDCMCMap not set in look up of closest primary sim hit.");
    return nullptr;
  }
  const CDCMCMap& mcMap = *m_ptrMCMap;
 
  if (mcMap.isReassignedSecondary(ptrHit)) {
    auto itFoundPrimarySimHit = m_primarySimHits.find(ptrHit);
    if (itFoundPrimarySimHit != m_primarySimHits.end()) {
      const CDCSimHit* simHit = itFoundPrimarySimHit->second;
      if (simHit) return simHit;
    }
  }
  // Return the normal (potentially secondary) CDCSimHit of no primary is available
  return mcMap.getSimHit(ptrHit);
}

getClosestPrimarySimHit() [2/2]

MayBePtr< const CDCSimHit > getClosestPrimarySimHit ( const CDCSimHit * ptrSimHit ) const

private

Helper function to find the closest primary hit for the given CDCSimHit from the same MCParticle - nullptr if no suitable hit can be found.

Definition at line 91 of file CDCSimHitLookUp.cc.

{
  if (not ptrSimHit) {
    return nullptr;
  }
  const CDCSimHit& simHit = *ptrSimHit;
 
  if (not m_ptrMCMap) {
    B2WARNING("CDCMCMap not set. Cannot find primary sim hit");
    return nullptr;
  }
 
  const CDCMCMap& mcMap = *m_ptrMCMap;
 
  // Check if the CDCSimHit was reassigned from a secondary particle to its primary particle.
  if (not mcMap.isReassignedSecondary(ptrSimHit)) {
    return ptrSimHit;
  } else {
 
    // Try to find the hit on the same wire from the primary particle.
    const MCParticle* ptrMCParticle = mcMap.getMCParticle(ptrSimHit);
    if (not ptrMCParticle) {
      return nullptr;
    }
 
    WireID wireID = simHit.getWireID();
    std::vector<const CDCSimHit*> primarySimHitsOnSameOrNeighborWire;
    const CDCWireTopology& wireTopology = CDCWireTopology::getInstance();
 
    for (const auto& simHitByMCParticleRelation : mcMap.getSimHits(ptrMCParticle)) {
 
      const CDCSimHit* ptrPrimarySimHit = std::get<const CDCSimHit*>(simHitByMCParticleRelation);
      if (mcMap.isReassignedSecondary(ptrPrimarySimHit) or not ptrPrimarySimHit) continue;
 
      const CDCSimHit& primarySimHit = *ptrPrimarySimHit;
 
      if (wireTopology.arePrimaryNeighbors(primarySimHit.getWireID(), wireID) or
          primarySimHit.getWireID() == wireID) {
 
        // Found a hit on the same wire from the primary particle.
        primarySimHitsOnSameOrNeighborWire.push_back(ptrPrimarySimHit);
      }
    }
 
    // Now from the neighboring primary CDCSimHits pick to one with the smallest distance to the
    // secondary CDCSimHit.
    auto compareDistanceBetweenSimHits =
      [&simHit](const CDCSimHit * primarySimHit,
    const CDCSimHit * otherPrimarySimHit) -> bool {
      ROOT::Math::XYZVector primaryHitPos(primarySimHit->getPosTrack());
      ROOT::Math::XYZVector otherPrimaryHitPos(otherPrimarySimHit->getPosTrack());
      ROOT::Math::XYZVector secondaryHitPos(simHit.getPosTrack());
      return VectorUtil::Distance(primaryHitPos, secondaryHitPos) < VectorUtil::Distance(otherPrimaryHitPos, secondaryHitPos);
    };
 
    auto itClosestPrimarySimHit = std::min_element(primarySimHitsOnSameOrNeighborWire.begin(),
                                                   primarySimHitsOnSameOrNeighborWire.end(),
                                                   compareDistanceBetweenSimHits);
 
    if (itClosestPrimarySimHit != primarySimHitsOnSameOrNeighborWire.end()) {
      // Found primary simulated hit for secondary hit.
      return *itClosestPrimarySimHit;
    } else {
      return nullptr;
    }
  }
}

getDirectionOfFlight()

ROOT::Math::XYZVector getDirectionOfFlight

(

const CDCHit *

ptrHit

)

Calculate the local direction of flight. If the hit is secondary take the direction of flight from a close by primary - null vector if it cannot be assumed this way.

Definition at line 178 of file CDCSimHitLookUp.cc.

{
  if (not ptrHit) return ROOT::Math::XYZVector();
 
  if (not m_ptrMCMap) {
    B2WARNING("CDCMCMap not set. Cannot find direction of flight");
    return ROOT::Math::XYZVector();
  }
 
  const CDCMCMap& mcMap = *m_ptrMCMap;
 
  const CDCSimHit* ptrSimHit = mcMap.getSimHit(ptrHit);
 
  if (not ptrSimHit) return ROOT::Math::XYZVector();
 
  const CDCSimHit* ptrPrimarySimHit =
    mcMap.isReassignedSecondary(ptrHit) ? getClosestPrimarySimHit(ptrHit) : ptrSimHit;
 
  if (not ptrPrimarySimHit) {
    // if no primary simhit is close to the secondary hit we can only take the secondary
    ptrPrimarySimHit = ptrSimHit;
 
    // or invent something better at some point...
  }
 
  const CDCSimHit& primarySimHit = *ptrPrimarySimHit;
 
  // Take the momentum of the primary hit
  ROOT::Math::XYZVector directionOfFlight{primarySimHit.getMomentum()};
  return directionOfFlight;
}

getDriftLength()

double getDriftLength

(

const CDCHit *

ptrHit

)

const

Look up the drift length from the primary ionisation to the wire from related simulated hit.

Definition at line 263 of file CDCSimHitLookUp.cc.

{
  if (not m_ptrMCMap) {
    B2WARNING("CDCMCMap not set. Cannot find reconstructed position");
    return NAN;
  }
 
  const CDCMCMap& mcMap = *m_ptrMCMap;
  const CDCSimHit* ptrSimHit = mcMap.getSimHit(ptrHit);
 
  if (not ptrSimHit) {
    B2WARNING("No CDCSimHit related to CDCHit");
    return NAN;
  }
 
  const CDCSimHit& simHit = *ptrSimHit;
  return simHit.getDriftLength();
}

getInstance()

const CDCSimHitLookUp & getInstance ( )

static

Getter for the singletone instance.

Definition at line 33 of file CDCSimHitLookUp.cc.

{
  return CDCMCManager::getSimHitLookUp();
}

getRecoHit2D()

CDCRecoHit2D getRecoHit2D	(	const CDCHit *	ptrHit,
		const std::vector< TrackingUtilities::CDCWireHit > &	wireHits ) const

Construct an TrackingUtilities::CDCRecoHit2D from the (potential secondary) CDCSimHit information related to the CDCHit.

Definition at line 347 of file CDCSimHitLookUp.cc.

{
  return getRecoHit3D(ptrHit, wireHits).getRecoHit2D();
}

getRecoHit3D()

CDCRecoHit3D getRecoHit3D	(	const CDCHit *	ptrHit,
		const std::vector< TrackingUtilities::CDCWireHit > &	wireHits ) const

Construct an CDCRecoHit3D from the (potential secondary) CDCSimHit information related to the CDCHit.

Definition at line 326 of file CDCSimHitLookUp.cc.

{
  CDCRLWireHit rlWireHit = getRLWireHit(ptrHit, wireHits);
  double driftLength = getDriftLength(ptrHit);
  rlWireHit.setRefDriftLength(driftLength);
  ROOT::Math::XYZVector recoPos3D = getRecoPos3D(ptrHit);
  return CDCRecoHit3D(rlWireHit, recoPos3D);
}

getRecoPos3D()

ROOT::Math::XYZVector getRecoPos3D

(

const CDCHit *

ptrHit

)

const

Look up the position of the primary ionisation from related simulated hit.

Definition at line 244 of file CDCSimHitLookUp.cc.

{
  if (not m_ptrMCMap) {
    B2WARNING("CDCMCMap not set. Cannot find reconstructed position");
    return ROOT::Math::XYZVector();
  }
 
  const CDCMCMap& mcMap = *m_ptrMCMap;
  const CDCSimHit* ptrSimHit = mcMap.getSimHit(ptrHit);
 
  if (not ptrSimHit) {
    B2WARNING("No CDCSimHit related to CDCHit");
    return ROOT::Math::XYZVector();
  }
 
  const CDCSimHit& simHit = *ptrSimHit;
  return ROOT::Math::XYZVector{simHit.getPosTrack()};
}

getRLInfo()

ERightLeft getRLInfo

(

const CDCHit *

ptrHit

)

const

Look up the Monte Carlo right left passage information for the given hit.

Definition at line 238 of file CDCSimHitLookUp.cc.

{
  auto itFoundHit = m_rightLeftInfos.find(ptrHit);
  return itFoundHit == m_rightLeftInfos.end() ? ERightLeft::c_Invalid : itFoundHit->second;
}

getRLWireHit()

CDCRLWireHit getRLWireHit	(	const CDCHit *	ptrHit,
		const std::vector< TrackingUtilities::CDCWireHit > &	wireHits ) const

Retrieve the wire hit including right left passage information for the given CDCHit form the given wire hits.

Definition at line 316 of file CDCSimHitLookUp.cc.

{
  ERightLeft rlInfo = getRLInfo(ptrHit);
  double driftLength = getDriftLength(ptrHit);
  const CDCWireHit* wireHit = getWireHit(ptrHit, wireHits);
  B2ASSERT("Could not find CDCWireHit for the requested hit", wireHit);
  return CDCRLWireHit(wireHit, rlInfo, driftLength, CDCWireHit::c_simpleDriftLengthVariance);
}

getWireHit()

const CDCWireHit * getWireHit	(	const CDCHit *	ptrHit,
		const std::vector< TrackingUtilities::CDCWireHit > &	wireHits ) const

Retrieve the wire hit the given CDCHit form the given wire hits.

Definition at line 303 of file CDCSimHitLookUp.cc.

{
  if (not ptrHit) return nullptr;
  ConstVectorRange<CDCWireHit> wireHit{std::equal_range(wireHits.begin(), wireHits.end(), *ptrHit)};
 
  if (wireHit.empty()) {
    return nullptr;
  } else {
    return &(wireHit.front());
  }
}

Member Data Documentation

m_primarySimHits

std::map<const CDCHit*, TrackingUtilities::MayBePtr<const CDCSimHit> > m_primarySimHits

private

Memory for the look up relation of close primary CDCSimHits.

Definition at line 131 of file CDCSimHitLookUp.h.

m_ptrMCMap

const CDCMCMap* m_ptrMCMap

private

Reference to the CDCMCMap to be used in this event.

Definition at line 128 of file CDCSimHitLookUp.h.

m_rightLeftInfos

std::map<const CDCHit*, TrackingUtilities::ERightLeft> m_rightLeftInfos

private

Memory for the look up relation of the right left passage information as defined in tracking.

Definition at line 134 of file CDCSimHitLookUp.h.

---

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

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