Findlet for loading the seeds from the data store. More...

#include <TrackLoader.h>

Inheritance diagram for TrackLoader:

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
	TrackLoader ()
	Add the subfindlets.

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

void	initialize () override
	Create the store arrays.

void	apply (std::vector< RecoTrack * > &seeds) override
	Load in the reco tracks and the hits.

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	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 = 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 = TrackFindingCDC::Findlet< RecoTrack * >
	Parent class.

Private Attributes
TrackFitterAndDeleter	m_trackFitter
	Findlet for fitting the tracks.

std::string	m_param_relationRecoTrackStoreArrayName = "RecoTracks"
	StoreArray name of the output Track Store Array.

std::string	m_param_inputRecoTrackStoreArrayName = "RecoTracks"
	StoreArray name of the input Track Store Array.

double	m_param_minimalPtRequirement = 0.0
	Minimal pt requirement.

std::string	m_param_relationCheckForDirectionAsString = "invalid"
	Parameter for the distance given to the framework (can not handle EForwardBackward directly)

TrackFindingCDC::EForwardBackward	m_param_relationCheckForDirection = TrackFindingCDC::EForwardBackward::c_Unknown
	Direction parameter converted from the string parameters.

StoreArray< RecoTrack >	m_inputRecoTracks
	Output Reco Tracks Store Array.

bool	m_noCDChits = false
	Ignore tracks with CDC hits attached.

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

Findlet for loading the seeds from the data store.

Also, the tracks are fitted and only the fittable tracks are passed on.

If a direction != "invalid" is given, the relations of the tracks to the given store array are checked. If there is a relation with the weight equal to the given direction (meaning there is already a partner for this direction), the track is not passed on.

Definition at line 36 of file TrackLoader.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 = TrackFindingCDC::Findlet<RecoTrack*>

private

Parent class.

Definition at line 38 of file TrackLoader.h.

◆ ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

◆ TrackLoader()

TrackLoader ( )

Add the subfindlets.

Definition at line 19 of file TrackLoader.cc.

                         : Super()
{
  this->addProcessingSignalListener(&m_trackFitter);
}

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< RecoTrack * > & seeds )

override

Load in the reco tracks and the hits.

Definition at line 68 of file TrackLoader.cc.

{
  seeds.reserve(seeds.size() + m_inputRecoTracks.getEntries());
 
  for (auto& item : m_inputRecoTracks) {
 
    if (m_noCDChits) {
      if (item.hasCDCHits()) continue;
    }
 
    if (m_param_relationCheckForDirection != TrackFindingCDC::EForwardBackward::c_Invalid) {
      const auto& relatedTracksWithWeight = item.template getRelationsWith<RecoTrack>(m_param_relationRecoTrackStoreArrayName);
      bool hasAlreadyRelation = false;
      for (unsigned int index = 0; index < relatedTracksWithWeight.size(); ++index) {
        const RecoTrack* relatedTrack = relatedTracksWithWeight[index];
        const float weight = relatedTracksWithWeight.weight(index);
        if (relatedTrack and weight == static_cast<float>(m_param_relationCheckForDirection)) {
          hasAlreadyRelation = true;
          break;
        }
      }
 
      if (not hasAlreadyRelation) {
        seeds.push_back(&item);
      } else {
        B2DEBUG(29, "Do not use this track, because it has already a valid relation");
      }
    } else {
      seeds.push_back(&item);
    }
  }
 
  const auto hasLowPt = [this](const auto & track) {
    return track->getMomentumSeed().Rho() < m_param_minimalPtRequirement;
  };
  TrackFindingCDC::erase_remove_if(seeds, hasLowPt);
 
  m_trackFitter.apply(seeds);
}

◆ beginEvent()

void beginEvent ( )

overridevirtualinherited

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

Reimplemented from ProcessingSignalListener.

Definition at line 31 of file CompositeProcessingSignalListener.cc.

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

◆ 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
	)

overridevirtual

Expose the parameters of the sub findlets.

Reimplemented from Findlet< RecoTrack * >.

Definition at line 24 of file TrackLoader.cc.

{
  m_trackFitter.exposeParameters(moduleParamList, prefix);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "inputRecoTrackStoreArrayName"),
                                m_param_inputRecoTrackStoreArrayName,
                                "StoreArray name of the input Track Store Array.");
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "relatedRecoTrackStoreArrayName"),
                                m_param_relationRecoTrackStoreArrayName,
                                "Check for relations to this store array name and only use the unrelated ones or "
                                "relations with different direction",
                                m_param_relationRecoTrackStoreArrayName);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "minimalPtRequirement"),
                                m_param_minimalPtRequirement,
                                "Minimal Pt requirement for the input tracks",
                                m_param_minimalPtRequirement);
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "relationCheckForDirection"),
                                m_param_relationCheckForDirectionAsString,
                                "Check for this direction when checking for related tracks.");
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "ignoreTracksWithCDChits"),
                                m_noCDChits, "Do not consider tracks containing CDC hits.", false);
 
}

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

{
  return m_subordinaryProcessingSignalListeners.size();
}

◆ initialize()

void initialize ( )

overridevirtual

Create the store arrays.

Reimplemented from ProcessingSignalListener.

Definition at line 52 of file TrackLoader.cc.

{
  Super::initialize();
 
  m_inputRecoTracks.isRequired(m_param_inputRecoTrackStoreArrayName);
 
  m_param_relationCheckForDirection = fromString(m_param_relationCheckForDirectionAsString);
 
  if (m_param_relationCheckForDirection != TrackFindingCDC::EForwardBackward::c_Invalid) {
    StoreArray<RecoTrack> relatedRecoTracks;
    if (not relatedRecoTracks.isOptional(m_param_relationRecoTrackStoreArrayName)) {
      m_param_relationCheckForDirection = TrackFindingCDC::EForwardBackward::c_Invalid;
    }
  }
}

◆ 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_inputRecoTracks

StoreArray<RecoTrack> m_inputRecoTracks

private

Output Reco Tracks Store Array.

Definition at line 73 of file TrackLoader.h.

◆ m_noCDChits

bool m_noCDChits = false

private

Ignore tracks with CDC hits attached.

Definition at line 75 of file TrackLoader.h.

◆ m_param_inputRecoTrackStoreArrayName

std::string m_param_inputRecoTrackStoreArrayName = "RecoTracks"

private

StoreArray name of the input Track Store Array.

Definition at line 62 of file TrackLoader.h.

◆ m_param_minimalPtRequirement

double m_param_minimalPtRequirement = 0.0

private

Minimal pt requirement.

Definition at line 64 of file TrackLoader.h.

◆ m_param_relationCheckForDirection

TrackFindingCDC::EForwardBackward m_param_relationCheckForDirection = TrackFindingCDC::EForwardBackward::c_Unknown

private

Direction parameter converted from the string parameters.

Definition at line 68 of file TrackLoader.h.

◆ m_param_relationCheckForDirectionAsString

std::string m_param_relationCheckForDirectionAsString = "invalid"

private

Parameter for the distance given to the framework (can not handle EForwardBackward directly)

Definition at line 66 of file TrackLoader.h.

◆ m_param_relationRecoTrackStoreArrayName

std::string m_param_relationRecoTrackStoreArrayName = "RecoTracks"

private

StoreArray name of the output Track Store Array.

Definition at line 60 of file TrackLoader.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.

◆ m_trackFitter

TrackFitterAndDeleter m_trackFitter

private

Findlet for fitting the tracks.

Definition at line 56 of file TrackLoader.h.

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

tracking/ckf/general/findlets/include/TrackLoader.h
tracking/ckf/general/findlets/src/TrackLoader.cc

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IOTypes

◆ IOVectors

◆ Super

◆ ToVector

Constructor & Destructor Documentation

◆ TrackLoader()

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription()

◆ getNProcessingSignalListener()

◆ initialize()

◆ terminate()

Member Data Documentation

◆ m_initialized

◆ m_initializedAs

◆ m_inputRecoTracks

◆ m_noCDChits

◆ m_param_inputRecoTrackStoreArrayName

◆ m_param_minimalPtRequirement

◆ m_param_relationCheckForDirection

◆ m_param_relationCheckForDirectionAsString

◆ m_param_relationRecoTrackStoreArrayName

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated

◆ m_trackFitter