Create CKF states, based on the current path. Perform some basic selection at this stage (based on phi, max. jump of layers) More...

#include <CDCCKFStateCreator.h>

Inheritance diagram for CDCCKFStateCreator:

Classes
struct	CDCCKFWireHitCache
	Store basic wire info for faster access. More...

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

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

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

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

Public Member Functions
void	setMaximalLayerJump (int maximalLayerJump)
	Set maximal layer jump for state creation.

void	setMaximalLayerJumpBackwardSeed (int maximalLayerJumpBackwardSeed)
	Set maximal layer jump for backward seed tracks.

void	setMaximalDeltaPhi (double maximalDeltaPhi)
	Set maximal delta phi for state creation.

void	setHitFindingDirection (const std::string &hitFindingDirection)
	Set hit finding direction.

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

void	beginEvent () override
	Clear the wireHit cache.

void	apply (std::vector< CDCCKFState > &nextStates, const CDCCKFPath &path, const std::vector< const TrackingUtilities::CDCWireHit * > &wireHits) override
	Main method of the findlet. Select + create states (output parameter nextStates) suitable for the input path, based on input wireHits.

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

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	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.

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 = TrackingUtilities::Findlet<CDCCKFState, const CDCCKFState, const TrackingUtilities::CDCWireHit* const>
	Parent class.

Private Attributes
int	m_maximalLayerJump = 2
	Maximum allowed step over layers.

int	m_maximalLayerJump_backwardSeed = 3
	Maximum allowed step over layers (if outside->in CKF) for first step after seed (e.g. ECLShower)

double	m_maximalDeltaPhi = TMath::Pi() / 8
	Maximal distance in phi between the path last hit/seed and the candidate hit.

std::string	m_param_writeOutDirectionAsString = "forward"
	Parameter for the direction in which the tracks are built.

TrackingUtilities::EForwardBackward	m_param_writeOutDirection = TrackingUtilities::EForwardBackward::c_Unknown
	Direction parameter converted from the string parameters.

bool	doForward = true
	Direction parameter converted to boolean for convenience.

std::vector< CDCCKFWireHitCache >	m_wireHitCache = {}
	Cache to store frequently used information.

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

Create CKF states, based on the current path. Perform some basic selection at this stage (based on phi, max. jump of layers)

Definition at line 35 of file CDCCKFStateCreator.h.

Member Typedef Documentation

◆ IOTypes [1/2]

using IOTypes

inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

◆ IOTypes [2/2]

using IOTypes

inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

◆ IOVectors [1/2]

using IOVectors

inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

◆ IOVectors [2/2]

using IOVectors

inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

◆ Super

using Super = TrackingUtilities::Findlet<CDCCKFState, const CDCCKFState, const TrackingUtilities::CDCWireHit* const>

private

Parent class.

Definition at line 40 of file CDCCKFStateCreator.h.

◆ ToVector [1/2]

using ToVector

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

◆ ToVector [2/2]

using ToVector

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 53 of file CompositeProcessingSignalListener.cc.

{
  m_subordinaryProcessingSignalListeners.push_back(psl);
}

◆ apply()

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

inlineoverride

Main method of the findlet. Select + create states (output parameter nextStates) suitable for the input path, based on input wireHits.

Definition at line 115 of file CDCCKFStateCreator.h.

    {
      // TODO: as we do not need any information on the current state (track state) of the path, we could in principle
      // TODO: precalculate everything in here
 
      // Create cache over wirehits, if empty:
      if (m_wireHitCache.empty()) {
        const size_t nHits = wireHits.size();
        m_wireHitCache.reserve(nHits);
        for (auto  hitPtr : wireHits) {
          // to speed things up, don't consider background/taken hits at all (and not just in the loop below).
          // I can't just remove them from the list, otherwise the relation to the wireHits is broken
          // so set the layer index to a high number.
          if (hitPtr->getAutomatonCell().hasBackgroundFlag() || hitPtr->getAutomatonCell().hasTakenFlag()) {
            m_wireHitCache.push_back(CDCCKFWireHitCache{99999, 0.});
          } else {
            m_wireHitCache.push_back(CDCCKFWireHitCache{hitPtr->getWire().getICLayer(), hitPtr->getRefPos2D().Phi()});
          }
        }
      }
 
      // Cache last-on-the-path state info too:
      const auto& lastState = path.back();
      double lastPhi = 0;
      double lastICLayer = -1;
      if (lastState.isSeed()) {
        if (doForward) {
          lastICLayer = 0;
        } else {
          const auto& wireTopology = CDC::CDCWireTopology::getInstance();
          const auto& wires = wireTopology.getWires();
          const float maxForwardZ = wires.back().getForwardZ();     // 157.615
          const float maxBackwardZ = wires.back().getBackwardZ();   // -72.0916
 
          const ROOT::Math::XYZVector seedPos(lastState.getSeed()->getPositionSeed());
          const float seedPosZ = seedPos.z();
 
          if (seedPosZ < maxForwardZ && seedPosZ > maxBackwardZ) {
            lastICLayer = 56;
          } else {
            // do straight extrapolation of seed momentum to CDC outer walls
            ROOT::Math::XYZVector seedMomZOne(lastState.getSeed()->getMomentumSeed());
            seedMomZOne = seedMomZOne / seedMomZOne.z();
            // const float maxZ = seedPosZ > 0 ? maxForwardZ : maxBackwardZ;
            // const ROOT::Math::XYZVector extrapolatedPos = seedPos - seedMom / seedMom.R() * (seedPosZ - maxZ);
 
            // find closest iCLayer
            float minDist = 99999;
            for (const auto& wire : wires) {
              const float maxZ = seedPosZ > 0 ? wire.getForwardZ() : wire.getBackwardZ();
              const ROOT::Math::XYZVector extrapolatedPos = seedPos - seedMomZOne * (seedPosZ - maxZ);
 
              const auto distance = wire.getDistance(extrapolatedPos);
              if (distance < minDist) {
                minDist = distance;
                lastICLayer = wire.getICLayer();
              }
            }
            B2DEBUG(29, lastICLayer << " (d=" << minDist << ")");
          }
        }
      } else {
        lastPhi = lastState.getWireHit()->getRefPos2D().Phi();
        lastICLayer = lastState.getWireHit()->getWire().getICLayer();
      }
 
      // Get sorted vector of wireHits on the path for faster search
      std::vector<const TrackingUtilities::CDCWireHit*> wireHitsOnPath;
      for (auto const& state : path) {
        if (! state.isSeed()) {
          wireHitsOnPath.push_back(state.getWireHit());
        }
      }
      std::sort(wireHitsOnPath.begin(), wireHitsOnPath.end());
 
      size_t nHits = wireHits.size();
      for (size_t i = 0; i < nHits; i++) {
        // adjust direction of loop (minimal speed gain)
        int idx = doForward ? i : nHits - i - 1;
 
        const auto iCLayer =  m_wireHitCache[idx].icLayer; // wireHit->getWire().getICLayer();
        if (m_param_writeOutDirection == TrackingUtilities::EForwardBackward::c_Backward && lastState.isSeed()) {
          if (std::abs(lastICLayer - iCLayer) > m_maximalLayerJump_backwardSeed) {
            continue;
          }
        } else if (std::abs(lastICLayer - iCLayer) > m_maximalLayerJump) {
          continue;
        }
 
        if (! lastState.isSeed()) {
          double deltaPhi = TrackingUtilities::AngleUtil::normalised(lastPhi - m_wireHitCache[idx].phi);
          if (fabs(deltaPhi)  > m_maximalDeltaPhi)  {
            continue;
          }
        }
 
        const TrackingUtilities::CDCWireHit* wireHit = wireHits[idx];
 
        if (std::binary_search(wireHitsOnPath.begin(), wireHitsOnPath.end(), wireHit)) {
          continue;
        }
 
        nextStates.emplace_back(wireHit);
      }
    }

◆ beginEvent()

void beginEvent ( )

inlineoverridevirtual

Clear the wireHit cache.

Reimplemented from ProcessingSignalListener.

Definition at line 97 of file CDCCKFStateCreator.h.

    {
      Super::beginEvent();
      m_wireHitCache.clear();
 
      // Determine direction of track building
      m_param_writeOutDirection = fromString(m_param_writeOutDirectionAsString);
 
      if (m_param_writeOutDirection == TrackingUtilities::EForwardBackward::c_Forward) {
        doForward = true;
      } else if (m_param_writeOutDirection == TrackingUtilities::EForwardBackward::c_Backward) {
        doForward = false;
      } else {
        B2FATAL("CDCCKFStateCreator: No valid direction specified. Please use forward/backward.");
      }
    }

◆ 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 84 of file CDCCKFStateCreator.h.

    {
      moduleParamList->addParameter(TrackingUtilities::prefixed(prefix, "maximalLayerJump"),
                                    m_maximalLayerJump, "Maximal jump over N layers", m_maximalLayerJump);
      moduleParamList->addParameter(TrackingUtilities::prefixed(prefix, "maximalLayerJumpBackwardSeed"),
                                    m_maximalLayerJump_backwardSeed, "Maximal jump over N layers", m_maximalLayerJump_backwardSeed);
      moduleParamList->addParameter(TrackingUtilities::prefixed(prefix, "maximalDeltaPhi"),
                                    m_maximalDeltaPhi, "Maximal distance in phi between wires for Z=0 plane", m_maximalDeltaPhi);
      moduleParamList->addParameter(TrackingUtilities::prefixed(prefix, "hitFindingDirection"),
                                    m_param_writeOutDirectionAsString, "Start from innermost/outermost CDC layers", m_param_writeOutDirectionAsString);
    }

◆ getDescription() [1/2]

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)";
      }

◆ getDescription() [2/2]

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();
  }
}

◆ setHitFindingDirection()

void setHitFindingDirection ( const std::string & hitFindingDirection )

inline

Set hit finding direction.

Parameters

hitFindingDirection Start from innermost/outermost CDC layers

Definition at line 78 of file CDCCKFStateCreator.h.

    {
      m_param_writeOutDirectionAsString = hitFindingDirection;
    }

◆ setMaximalDeltaPhi()

void setMaximalDeltaPhi ( double maximalDeltaPhi )

inline

Set maximal delta phi for state creation.

Parameters

maximalDeltaPhi Maximum distance in phi between wires for Z=0 plane

Definition at line 72 of file CDCCKFStateCreator.h.

72{ m_maximalDeltaPhi = maximalDeltaPhi; }

◆ setMaximalLayerJump()

void setMaximalLayerJump ( int maximalLayerJump )

inline

Set maximal layer jump for state creation.

Parameters

maximalLayerJump Maximum number of layers to jump

Definition at line 57 of file CDCCKFStateCreator.h.

57{ m_maximalLayerJump = maximalLayerJump; }

◆ setMaximalLayerJumpBackwardSeed()

void setMaximalLayerJumpBackwardSeed ( int maximalLayerJumpBackwardSeed )

inline

Set maximal layer jump for backward seed tracks.

Parameters

maximalLayerJumpBackwardSeed Maximum number of layers to jump for backward seeds

Definition at line 63 of file CDCCKFStateCreator.h.

    {
      m_maximalLayerJump_backwardSeed = maximalLayerJumpBackwardSeed;
    }

◆ 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

◆ doForward

bool doForward = true

private

Direction parameter converted to boolean for convenience.

Definition at line 234 of file CDCCKFStateCreator.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_maximalDeltaPhi

double m_maximalDeltaPhi = TMath::Pi() / 8

private

Maximal distance in phi between the path last hit/seed and the candidate hit.

Definition at line 228 of file CDCCKFStateCreator.h.

◆ m_maximalLayerJump

int m_maximalLayerJump = 2

private

Maximum allowed step over layers.

Definition at line 224 of file CDCCKFStateCreator.h.

◆ m_maximalLayerJump_backwardSeed

int m_maximalLayerJump_backwardSeed = 3

private

Maximum allowed step over layers (if outside->in CKF) for first step after seed (e.g. ECLShower)

Definition at line 226 of file CDCCKFStateCreator.h.

◆ m_param_writeOutDirection

TrackingUtilities::EForwardBackward m_param_writeOutDirection = TrackingUtilities::EForwardBackward::c_Unknown

private

Direction parameter converted from the string parameters.

Definition at line 232 of file CDCCKFStateCreator.h.

◆ m_param_writeOutDirectionAsString

std::string m_param_writeOutDirectionAsString = "forward"

private

Parameter for the direction in which the tracks are built.

Definition at line 230 of file CDCCKFStateCreator.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.

◆ m_wireHitCache

std::vector<CDCCKFWireHitCache> m_wireHitCache = {}

private

Cache to store frequently used information.

Definition at line 237 of file CDCCKFStateCreator.h.

237{};

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

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

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IOTypes [1/2]

◆ IOTypes [2/2]

◆ IOVectors [1/2]

◆ IOVectors [2/2]

◆ Super

◆ ToVector [1/2]

◆ ToVector [2/2]

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription() [1/2]

◆ getDescription() [2/2]

◆ getNProcessingSignalListener()

◆ initialize()

◆ setHitFindingDirection()

◆ setMaximalDeltaPhi()

◆ setMaximalLayerJump()

◆ setMaximalLayerJumpBackwardSeed()

◆ terminate()

Member Data Documentation

◆ doForward

◆ m_initialized

◆ m_initializedAs

◆ m_maximalDeltaPhi

◆ m_maximalLayerJump

◆ m_maximalLayerJump_backwardSeed

◆ m_param_writeOutDirection

◆ m_param_writeOutDirectionAsString

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated

◆ m_wireHitCache