RelationApplier Class Reference

Relate the SVD and CDC tracks in the given relations also in the store array. More...

#include <RelationApplier.h>

Inheritance diagram for RelationApplier:

Public Types
using	Super = TrackFindingCDC::Findlet<const TrackFindingCDC::WeightedRelation<const RecoTrack, const RecoTrack>>
	The parent findlet.
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	initialize () final
	Receive and dispatch signal before the start of the event processing.
void	apply (const std::vector< TrackFindingCDC::WeightedRelation< const RecoTrack, const RecoTrack > > &relationsCDCToSVD) final
	Copy the relations to the store array.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
	Expose parameters.
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	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.
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 Attributes
std::string	m_param_writeOutDirectionAsString = "both"
	Parameter for the distance given to the framework (can not handle EForwardBackward directly)
TrackFindingCDC::EForwardBackward	m_param_writeOutDirection = TrackFindingCDC::EForwardBackward::c_Unknown
	Direction parameter converted from the string parameters.
std::string	m_param_fromRelationsStoreArrayName = "CDCRecoTracks"
	Create relations from this store array.
std::string	m_param_toRelationsStoreArrayName = "SVDRecoTracks"
	Create relations to this store array.
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

Relate the SVD and CDC tracks in the given relations also in the store array.

Definition at line 23 of file RelationApplier.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 = TrackFindingCDC::Findlet<const TrackFindingCDC::WeightedRelation<const RecoTrack, const RecoTrack>>

The parent findlet.

Definition at line 26 of file RelationApplier.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 ( const std::vector< TrackFindingCDC::WeightedRelation< const RecoTrack, const RecoTrack > > & relationsCDCToSVD )

final

Copy the relations to the store array.

Definition at line 34 of file RelationApplier.cc.

{
  for (const TrackFindingCDC::WeightedRelation<const RecoTrack, const RecoTrack>& relation : relationsCDCToSVD) {
    const RecoTrack* cdcTrack = relation.getFrom();
    const RecoTrack* svdTrack = relation.getTo();
    cdcTrack->addRelationTo(svdTrack, m_param_writeOutDirection);
  }
}

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 )

finalvirtual

Expose parameters.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 44 of file RelationApplier.cc.

{
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "writeOutDirection"),
                                m_param_writeOutDirectionAsString,
                                "Write out the relations with the direction of the VXD part as weight");
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "fromRelationStoreArrayName"), m_param_fromRelationsStoreArrayName,
                                "Create relations from this store array.");
 
  moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "toRelationStoreArrayName"), m_param_toRelationsStoreArrayName,
                                "Create relations to this store array.");
}

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

finalvirtual

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

Reimplemented from CompositeProcessingSignalListener.

Definition at line 19 of file RelationApplier.cc.

{
  Super::initialize();
 
  StoreArray<RecoTrack> relationFromTracks(m_param_fromRelationsStoreArrayName);
  relationFromTracks.isRequired();
 
  StoreArray<RecoTrack> relationToTracks(m_param_toRelationsStoreArrayName);
  relationToTracks.isRequired();
 
  relationFromTracks.registerRelationTo(relationToTracks);
 
  m_param_writeOutDirection = fromString(m_param_writeOutDirectionAsString);
}

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_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_param_fromRelationsStoreArrayName

std::string m_param_fromRelationsStoreArrayName = "CDCRecoTracks"

private

Create relations from this store array.

Definition at line 43 of file RelationApplier.h.

m_param_toRelationsStoreArrayName

std::string m_param_toRelationsStoreArrayName = "SVDRecoTracks"

private

Create relations to this store array.

Definition at line 45 of file RelationApplier.h.

m_param_writeOutDirection

TrackFindingCDC::EForwardBackward m_param_writeOutDirection = TrackFindingCDC::EForwardBackward::c_Unknown

private

Direction parameter converted from the string parameters.

Definition at line 41 of file RelationApplier.h.

m_param_writeOutDirectionAsString

std::string m_param_writeOutDirectionAsString = "both"

private

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

Definition at line 39 of file RelationApplier.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 files:

• tracking/ckf/svd/findlets/include/RelationApplier.h
• tracking/ckf/svd/findlets/src/RelationApplier.cc