A stack of pre-, helix-extrapolation- , Kalman-extrapolation- and Kalman-update-filters. More...

#include <CDCCKFStateFilter.h>

Inheritance diagram for CDCCKFStateFilter:

Public Types
using	IOTypes
	Types that should be served to apply on invocation.

using	IOVectors
	Vector types that should be served to apply on invocation.

Public Member Functions
	CDCCKFStateFilter ()
	Add all sub findlets.

void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
	Expose the parameters of the sub findlets.

void	setMaximalHitCandidates (size_t maximalHitCandidates)
	Set maximal hit candidates for state filtering.

void	apply (const CDCCKFPath &path, std::vector< CDCCKFState > &nextStates) override
	Apply the findlet and do the state selection.

virtual std::string	getDescription ()
	Brief description of the purpose of the concrete findlet.

virtual void	apply (ToVector< AIOTypes > &... ioVectors)=0
	Main function executing the algorithm.

void	initialize () override
	Receive and dispatch signal before the start of the event processing.

void	beginRun () override
	Receive and dispatch signal for the beginning of a new run.

void	beginEvent () override
	Receive and dispatch signal for the start of a new event.

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
	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
	Type of the base class.

Static Private Member Functions
static void	reconstruct (CDCCKFState &state, const TrackingUtilities::CDCTrajectory3D &trajectory, const double lastArcLength)
	Helper function to reconstruct the arc length and the hit distance of a state according to the trajectory.

Private Attributes
size_t	m_maximalHitCandidates = 4
	Parameter: max number of candidates.

TrackingUtilities::ChooseableFilter< CDCStateFilterFactory >	m_preFilter
	Pre Filter.

TrackingUtilities::ChooseableFilter< CDCStateFilterFactory >	m_basicFilter
	Basic Filter (uses helix extrapolation)

TrackingUtilities::ChooseableFilter< CDCStateFilterFactory >	m_extrapolationFilter
	Extrapolation Filter (after Kalman extrapolation)

TrackingUtilities::ChooseableFilter< CDCStateFilterFactory >	m_finalSelection
	Final Selection Filter (after Kalman update)

std::vector< ProcessingSignalListener * >	m_subordinaryProcessingSignalListeners
	References to subordinary signal processing listener contained in this findlet.

bool	m_initialized
	Flag to keep track whether initialization happened before.

bool	m_terminated
	Flag to keep track whether termination happened before.

std::string	m_initializedAs
	Name of the type during initialisation.

Detailed Description

A stack of pre-, helix-extrapolation- , Kalman-extrapolation- and Kalman-update-filters.

Definition at line 36 of file CDCCKFStateFilter.h.

Member Typedef Documentation

◆ IOTypes

using IOTypes

inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

◆ IOVectors

using IOVectors

inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

◆ Super

using Super

privateinherited

Type of the base class.

Definition at line 26 of file CompositeProcessingSignalListener.h.

◆ ToVector

using ToVector

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

◆ CDCCKFStateFilter()

CDCCKFStateFilter ( )

inline

Add all sub findlets.

Definition at line 39 of file CDCCKFStateFilter.h.

    {
      addProcessingSignalListener(&m_preFilter);
      addProcessingSignalListener(&m_basicFilter);
      addProcessingSignalListener(&m_extrapolationFilter);
      addProcessingSignalListener(&m_finalSelection);
    }

Member Function Documentation

◆ addProcessingSignalListener()

void addProcessingSignalListener ( ProcessingSignalListener * psl )

protectedinherited

Register a processing signal listener to be notified.

Definition at line 53 of file CompositeProcessingSignalListener.cc.

{
  m_subordinaryProcessingSignalListeners.push_back(psl);
}

◆ apply()

void apply	(	const CDCCKFPath &	path,
		std::vector< CDCCKFState > &	nextStates )

inlineoverride

Apply the findlet and do the state selection.

Definition at line 67 of file CDCCKFStateFilter.h.

    {
      const CDCCKFState& lastState = path.back();
      const TrackingUtilities::CDCTrajectory3D& trajectory = lastState.getTrajectory();
 
      // cppcheck-suppress variableScope ; declaration kept at this scope for readability
      TrackingUtilities::Weight weight;
 
      B2DEBUG(29, "On layer: " << (lastState.isSeed() ? -1 : lastState.getWireHit()->getWire().getICLayer()));
 
      for (CDCCKFState& nextState : nextStates) {
        B2DEBUG(29, "Checking layer: " << nextState.getWireHit()->getWire().getICLayer());
 
        weight = m_preFilter({&path, &nextState});
        nextState.setWeight(weight);
        if (std::isnan(weight)) {
          B2DEBUG(29, "Fails PreFilter");
          continue;
        }
 
        // Do a reconstruction based on the helix extrapolation from the last hit
        reconstruct(nextState, trajectory, lastState.getArcLength());
 
        weight = m_basicFilter({&path, &nextState});
        nextState.setWeight(weight);
        if (std::isnan(weight)) {
          B2DEBUG(29, "Fails BasicFilter");
          continue;
        }
 
        // Extrapolate and update
        weight = m_extrapolationFilter({&path, &nextState});
        nextState.setWeight(weight);
        if (std::isnan(weight)) {
          B2DEBUG(29, "Fails ExtrapolationFilter");
          continue;
        }
 
        // Do a final hit selection based on the new state
        const TrackingUtilities::CDCTrajectory3D& thisTrajectory = nextState.getTrajectory();
        reconstruct(nextState, thisTrajectory, nextState.getArcLength());
 
        weight = m_finalSelection({&path, &nextState});
        nextState.setWeight(weight);
        if (std::isnan(weight)) {
          B2DEBUG(29, "Fails FinalFilter");
          continue;
        }
      }
 
      B2DEBUG(29, "Starting with " << nextStates.size() << " possible hits");
 
      TrackingUtilities::erase_remove_if(nextStates,
                                         TrackingUtilities::Composition<TrackingUtilities::IsNaN, TrackingUtilities::GetWeight>());
 
      B2DEBUG(29, "Now have " << nextStates.size());
 
      std::sort(nextStates.begin(), nextStates.end(), TrackingUtilities::GreaterWeight());
 
      TrackingUtilities::only_best_N(nextStates, m_maximalHitCandidates);
    }

◆ beginEvent()

void beginEvent ( )

overrideinherited

Receive and dispatch signal for the start of a new event.

Definition at line 36 of file CompositeProcessingSignalListener.cc.

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

◆ beginRun()

void beginRun ( )

overrideinherited

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

Definition at line 33 of file CompositeProcessingSignalListener.cc.

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

◆ endRun()

void endRun ( )

overrideinherited

Receive and dispatch signal for the end of the run.

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 )

inlineoverridevirtual

Expose the parameters of the sub findlets.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 49 of file CDCCKFStateFilter.h.

    {
      moduleParamList->addParameter(TrackingUtilities::prefixed(prefix, "maximalHitCandidates"),
                                    m_maximalHitCandidates, "Maximal hit candidates to test",
                                    m_maximalHitCandidates);
      m_preFilter.exposeParameters(moduleParamList, TrackingUtilities::prefixed(prefix, "pre"));
      m_basicFilter.exposeParameters(moduleParamList, TrackingUtilities::prefixed(prefix, "basic"));
      m_extrapolationFilter.exposeParameters(moduleParamList, TrackingUtilities::prefixed(prefix, "extrapolation"));
      m_finalSelection.exposeParameters(moduleParamList, TrackingUtilities::prefixed(prefix, "final"));
    }

◆ getDescription()

virtual std::string getDescription ( )

inlinevirtualinherited

Brief description of the purpose of the concrete findlet.

Definition at line 60 of file Findlet.h.

      {
        return "(no description)";
      }

◆ getNProcessingSignalListener()

int getNProcessingSignalListener ( )

protectedinherited

Get the number of currently registered listeners.

Definition at line 56 of file CompositeProcessingSignalListener.cc.

{
  return m_subordinaryProcessingSignalListeners.size();
}

◆ initialize()

void initialize ( )

overrideinherited

Receive and dispatch signal before the start of the event processing.

Definition at line 30 of file CompositeProcessingSignalListener.cc.

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

◆ reconstruct()

static void reconstruct	(	CDCCKFState &	state,
		const TrackingUtilities::CDCTrajectory3D &	trajectory,
		const double	lastArcLength )

inlinestaticprivate

Helper function to reconstruct the arc length and the hit distance of a state according to the trajectory.

Definition at line 142 of file CDCCKFStateFilter.h.

    {
      // TODO: actually we do not need to do any trajectory creation here. We could save some computing time!
      const TrackingUtilities::CDCTrajectory2D& trajectory2D = trajectory.getTrajectory2D();
      const TrackingUtilities::CDCTrajectorySZ& trajectorySZ = trajectory.getTrajectorySZ();
 
      const TrackingUtilities::CDCWireHit* wireHit = state.getWireHit();
 
      ROOT::Math::XYVector recoPos2D;
      if (wireHit->isAxial()) {
        recoPos2D = wireHit->reconstruct2D(trajectory2D);
      } else {
        const CDC::CDCWire& wire = wireHit->getWire();
        const ROOT::Math::XYVector& posOnXYPlane = wireHit->reconstruct2D(trajectory2D);
 
        const double arcLength = trajectory2D.calcArcLength2D(posOnXYPlane);
        const double z = trajectorySZ.mapSToZ(arcLength);
 
        const ROOT::Math::XYVector& wirePos2DAtZ = wire.getWirePos2DAtZ(z);
 
        const ROOT::Math::XYVector& recoPosOnTrajectory = trajectory2D.getClosest(wirePos2DAtZ);
        const double driftLength = wireHit->getRefDriftLength();
        ROOT::Math::XYVector disp2D = recoPosOnTrajectory - wirePos2DAtZ;
        if (disp2D.R() != 0.0) {
          disp2D *= (driftLength / disp2D.R());
        }
        recoPos2D = wirePos2DAtZ + disp2D;
      }
 
      const double arcLength = trajectory2D.calcArcLength2D(recoPos2D);
      const double z = trajectorySZ.mapSToZ(arcLength);
      const double distanceToHit = trajectory2D.getDist2D(recoPos2D);
 
      state.setArcLength(lastArcLength + arcLength);
      state.setHitDistance(distanceToHit);
      state.setReconstructedZ(z);
    }

◆ setMaximalHitCandidates()

void setMaximalHitCandidates ( size_t maximalHitCandidates )

inline

Set maximal hit candidates for state filtering.

Parameters

maximalHitCandidates Maximum number of hit candidates to test

Definition at line 64 of file CDCCKFStateFilter.h.

64{ m_maximalHitCandidates = maximalHitCandidates; }

◆ terminate()

void terminate ( )

overrideinherited

Receive and dispatch Signal for termination of the event processing.

Definition at line 42 of file CompositeProcessingSignalListener.cc.

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

Member Data Documentation

◆ m_basicFilter

TrackingUtilities::ChooseableFilter<CDCStateFilterFactory> m_basicFilter

private

Basic Filter (uses helix extrapolation)

Definition at line 135 of file CDCCKFStateFilter.h.

◆ m_extrapolationFilter

TrackingUtilities::ChooseableFilter<CDCStateFilterFactory> m_extrapolationFilter

private

Extrapolation Filter (after Kalman extrapolation)

Definition at line 137 of file CDCCKFStateFilter.h.

◆ m_finalSelection

TrackingUtilities::ChooseableFilter<CDCStateFilterFactory> m_finalSelection

private

Final Selection Filter (after Kalman update)

Definition at line 139 of file CDCCKFStateFilter.h.

◆ m_initialized

bool m_initialized

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_maximalHitCandidates

size_t m_maximalHitCandidates = 4

private

Parameter: max number of candidates.

Definition at line 131 of file CDCCKFStateFilter.h.

◆ m_preFilter

TrackingUtilities::ChooseableFilter<CDCStateFilterFactory> m_preFilter

private

Pre Filter.

Definition at line 133 of file CDCCKFStateFilter.h.

◆ m_subordinaryProcessingSignalListeners

std::vector<ProcessingSignalListener*> m_subordinaryProcessingSignalListeners

privateinherited

References to subordinary signal processing listener contained in this findlet.

Definition at line 60 of file CompositeProcessingSignalListener.h.

◆ m_terminated

bool m_terminated

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 file:

tracking/ckf/cdc/findlets/include/CDCCKFStateFilter.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Types

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IOTypes

◆ IOVectors

◆ Super

◆ ToVector

Constructor & Destructor Documentation

◆ CDCCKFStateFilter()

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription()

◆ getNProcessingSignalListener()

◆ initialize()

◆ reconstruct()

◆ setMaximalHitCandidates()

◆ terminate()

Member Data Documentation

◆ m_basicFilter

◆ m_extrapolationFilter

◆ m_finalSelection

◆ m_initialized

◆ m_initializedAs

◆ m_maximalHitCandidates

◆ m_preFilter

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated