WireHitMCMultiLoopBlocker Class Reference

Marks all hits that are not on the first loop of the track as background. More...

#include <WireHitMCMultiLoopBlocker.h>

Inheritance diagram for WireHitMCMultiLoopBlocker:

Public Types
using	IOTypes = std::tuple< AIOTypes... >
	Types that should be served to apply on invocation.
using	IOVectors = std::tuple< std::vector< AIOTypes >... >
	Vector types that should be served to apply on invocation.

Public Member Functions
std::string	getDescription () final
	Short description of the findlet.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
	Expose the parameters to a module.
void	initialize () final
	Signals the start of the event processing.
void	beginEvent () final
	Prepare the Monte Carlo information at the start of the event.
void	apply (std::vector< CDCWireHit > &wireHits) final
	Main algorithm marking the hit of higher loops as background.
virtual void	apply (ToVector< AIOTypes > &... ioVectors)=0
	Main function executing the algorithm.
void	beginRun () override
	Receive and dispatch signal for the beginning of a new run.
void	endRun () override
	Receive and dispatch signal for the end of the run.
void	terminate () override
	Receive and dispatch Signal for termination of the event processing.

Protected Types
using	ToVector = typename ToVectorImpl< T >::Type
	Short hand for ToRangeImpl.

Protected Member Functions
void	addProcessingSignalListener (ProcessingSignalListener *psl)
	Register a processing signal listener to be notified.
int	getNProcessingSignalListener ()
	Get the number of currently registered listeners.

Private Types
using	Super = Findlet< CDCWireHit & >
	Type of the base class.

Private Attributes
double	m_param_useNLoops = INFINITY
	Parameter : Maximal fraction of loops of the mc particles trajectory needs to the hit to unblock it.
std::vector< ProcessingSignalListener * >	m_subordinaryProcessingSignalListeners
	References to subordinary signal processing listener contained in this findlet.
bool	m_initialized = false
	Flag to keep track whether initialization happened before.
bool	m_terminated = false
	Flag to keep track whether termination happened before.
std::string	m_initializedAs
	Name of the type during initialisation.

Detailed Description

Marks all hits that are not on the first loop of the track as background.

By marking them as background hits are excluded from the track finding procedures Application of this findlet somewhat reduces the complexity of the track finding since only hits within a limited time need to be tracked. It is however useful to validated fitting procedures and to bias multivariate to favor the first loops and do not apply a penalty for uncovered higher order loops

Definition at line 34 of file WireHitMCMultiLoopBlocker.h.

Member Typedef Documentation

IOTypes

using IOTypes = std::tuple<AIOTypes...>

inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

IOVectors

using IOVectors = std::tuple< std::vector<AIOTypes>... >

inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

Super

using Super = Findlet<CDCWireHit&>

private

Type of the base class.

Definition at line 38 of file WireHitMCMultiLoopBlocker.h.

ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Member Function Documentation

addProcessingSignalListener()

void addProcessingSignalListener ( ProcessingSignalListener *  psl )

protectedinherited

Register a processing signal listener to be notified.

Definition at line 55 of file CompositeProcessingSignalListener.cc.

{
  m_subordinaryProcessingSignalListeners.push_back(psl);
}

apply()

void apply ( std::vector< CDCWireHit > &  wireHits )

final

Main algorithm marking the hit of higher loops as background.

Definition at line 60 of file WireHitMCMultiLoopBlocker.cc.

{
  if (not std::isfinite(m_param_useNLoops)) return;
 
  const CDCMCHitLookUp& mcHitLookUp = CDCMCHitLookUp::getInstance();
  double nLoops = m_param_useNLoops;
  auto isWithinMCLoops = [&mcHitLookUp, nLoops](const CDCWireHit & wireHit) {
 
    // Reject hits with no associated CDCSimHit.
    const CDCSimHit* simHit = mcHitLookUp.getClosestPrimarySimHit(wireHit.getHit());
    if (not simHit) return false;
 
    const double tof = simHit->getFlightTime();
 
    // Accept hits with no associated MCParticle (e.g. beam background.)
    const MCParticle* mcParticle = simHit->getRelated<MCParticle>();
    if (not mcParticle) return true;
 
    const double speed = mcParticle->get4Vector().Beta() * Const::speedOfLight;
 
    const ROOT::Math::XYZVector mom3D = mcParticle->getMomentum();
    const float absMom2D = mom3D.Rho();
    const float absMom3D = mom3D.R();
 
    const Vector3D pos3D(0.0, 0.0, 0.0);
    const double bendRadius = CDCBFieldUtil::absMom2DToBendRadius(absMom2D, pos3D);
    const double bendCircumfence =  2 * M_PI * bendRadius;
    const double loopLength = bendCircumfence * absMom3D / absMom2D;
    const double loopTOF =  loopLength / speed;
 
    if (tof > loopTOF * nLoops) {
      return false;
    } else {
      return true;
    }
  };
 
  for (CDCWireHit& wireHit : wireHits) {
    if (not isWithinMCLoops(wireHit)) {
      wireHit->setBackgroundFlag();
      wireHit->setTakenFlag();
    }
  }
}

beginEvent()

void beginEvent ( )

finalvirtual

Prepare the Monte Carlo information at the start of the event.

Reimplemented from ProcessingSignalListener.

Definition at line 52 of file WireHitMCMultiLoopBlocker.cc.

{
  Super::beginEvent();
  if (std::isfinite(m_param_useNLoops)) {
    CDCMCManager::getInstance().fill();
  }
}

beginRun()

void beginRun ( )

overridevirtualinherited

Receive and dispatch signal for the beginning of a new run.

Reimplemented from ProcessingSignalListener.

Reimplemented in LayerRelationFilter< AFilter >, FourHitFilter, QualityIndicatorFilter, ThreeHitFilter, TwoHitVirtualIPFilter, TwoHitVirtualIPQIFilter, RecoTrackStorer, ROIFinder, SpacePointLoaderAndPreparer, and TrackCandidateResultRefiner.

Definition at line 23 of file CompositeProcessingSignalListener.cc.

{
  Super::beginRun();
  for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
    psl->beginRun();
  }
}

endRun()

void endRun ( )

overridevirtualinherited

Receive and dispatch signal for the end of the run.

Reimplemented from ProcessingSignalListener.

Definition at line 39 of file CompositeProcessingSignalListener.cc.

{
  for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
    psl->endRun();
  }
  Super::endRun();
}

exposeParameters()

void exposeParameters ( ModuleParamList *  moduleParamList, const std::string &  prefix  )

finalvirtual

Expose the parameters to a module.

Reimplemented from Findlet< CDCWireHit & >.

Definition at line 35 of file WireHitMCMultiLoopBlocker.cc.

{
  moduleParamList->addParameter(prefixed(prefix, "UseNLoops"),
                                m_param_useNLoops,
                                "Maximal number of loops accepted",
                                m_param_useNLoops);
}

getDescription()

std::string getDescription ( )

finalvirtual

Short description of the findlet.

Reimplemented from Findlet< CDCWireHit & >.

Definition at line 29 of file WireHitMCMultiLoopBlocker.cc.

{
  return "Marks all hits that were not reached after the specified number of loops as background "
         "based on MC information.";
}

getNProcessingSignalListener()

int getNProcessingSignalListener ( )

protectedinherited

Get the number of currently registered listeners.

Definition at line 60 of file CompositeProcessingSignalListener.cc.

{
  return m_subordinaryProcessingSignalListeners.size();
}

initialize()

void initialize ( )

finalvirtual

Signals the start of the event processing.

Reimplemented from ProcessingSignalListener.

Definition at line 44 of file WireHitMCMultiLoopBlocker.cc.

{
  Super::initialize();
  if (std::isfinite(m_param_useNLoops)) {
    CDCMCManager::getInstance().requireTruthInformation();
  }
}

terminate()

void terminate ( )

overridevirtualinherited

Receive and dispatch Signal for termination of the event processing.

Reimplemented from ProcessingSignalListener.

Reimplemented in StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::HyperHough >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::QuadraticLegendre >, and StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::Z0TanLambdaLegendre >.

Definition at line 47 of file CompositeProcessingSignalListener.cc.

{
  for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
    psl->terminate();
  }
  Super::terminate();
}

Member Data Documentation

m_initialized

bool m_initialized = false

privateinherited

Flag to keep track whether initialization happened before.

Definition at line 52 of file ProcessingSignalListener.h.

m_initializedAs

std::string m_initializedAs

privateinherited

Name of the type during initialisation.

Definition at line 58 of file ProcessingSignalListener.h.

m_param_useNLoops

double m_param_useNLoops = INFINITY

private

Parameter : Maximal fraction of loops of the mc particles trajectory needs to the hit to unblock it.

Definition at line 58 of file WireHitMCMultiLoopBlocker.h.

m_subordinaryProcessingSignalListeners

std::vector<ProcessingSignalListener*> m_subordinaryProcessingSignalListeners

privateinherited

References to subordinary signal processing listener contained in this findlet.

Definition at line 52 of file CompositeProcessingSignalListener.h.

m_terminated

bool m_terminated = false

privateinherited

Flag to keep track whether termination happened before.

Definition at line 55 of file ProcessingSignalListener.h.

---

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

• tracking/trackFindingCDC/findlets/minimal/include/WireHitMCMultiLoopBlocker.h
• tracking/trackFindingCDC/findlets/minimal/src/WireHitMCMultiLoopBlocker.cc