Filter for relations between CKF SVD states based on SectorMaps. More...

#include <SectorMapBasedSVDPairFilter.h>

Inheritance diagram for SectorMapBasedSVDPairFilter:

[legend]

Collaboration diagram for SectorMapBasedSVDPairFilter:

[legend]

Public Types
using	Object
	Type of the object to be analysed.

using	Object
	Type of the object to be analysed.

using	Interface
	Mark this class as the basic interface.

using	Interface
	Mark this class as the basic interface.

Public Member Functions
	SectorMapBasedSVDPairFilter ()=default
	default constructor to silence cppcheck warnings

void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
	Expose the parameters of the filter.

TrackFindingCDC::Weight	operator() (const std::pair< const CKFToSVDState , const CKFToSVDState > &relation) override
	Give a final weight to the possibilities by asking the filter.

void	beginRun () final
	Initialize the sector map.

virtual bool	needsTruthInformation ()
	Indicates if the filter requires Monte Carlo information.

virtual bool	needsTruthInformation ()
	Indicates if the filter requires Monte Carlo information.

virtual Weight	operator() (const Object &obj)
	Function to evaluate the object.

Weight	operator() (const Object *obj)
	Function to evaluate the object.

virtual std::vector< float >	operator() (const std::vector< Object * > &objs)
	Function to evaluate a vector of objects Base implementation applies the function to each object.

virtual Weight	operator() (const Object &obj)
	Function to evaluate the object.

Weight	operator() (const Object *obj)
	Function to evaluate the object.

virtual std::vector< float >	operator() (const std::vector< Object * > &objs)
	Function to evaluate a vector of objects Base implementation applies the function to each object.

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

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 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 = BaseSVDPairFilter
	The parent class.

using	SectorMapFilter = VXDTFFilters<SpacePoint>
	The VXDTF filter.

using	FilterContainer = FiltersContainer<SpacePoint>
	The filter container.

Private Attributes
FilterContainer &	m_filtersContainer = FiltersContainer<SpacePoint>::getInstance()
	The filter container to use.

SectorMapFilter *	m_vxdtfFilters = nullptr
	The sector map filter, will be set in begin run.

std::string	m_param_sectorMapName = "SVDOnlyDefault"
	Name of the sector map to use.

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

Filter for relations between CKF SVD states based on SectorMaps.

Definition at line 23 of file SectorMapBasedSVDPairFilter.h.

Member Typedef Documentation

◆ FilterContainer

using FilterContainer = FiltersContainer<SpacePoint>

private

The filter container.

Definition at line 30 of file SectorMapBasedSVDPairFilter.h.

◆ Interface [1/2]

using Interface

inherited

Mark this class as the basic interface.

Definition at line 38 of file Filter.dcl.h.

◆ Interface [2/2]

using Interface

inherited

Mark this class as the basic interface.

Definition at line 38 of file Filter.dcl.h.

◆ Object [1/2]

using Object

inherited

Type of the object to be analysed.

Definition at line 35 of file Filter.dcl.h.

◆ Object [2/2]

using Object

inherited

Type of the object to be analysed.

Definition at line 35 of file Filter.dcl.h.

◆ SectorMapFilter

using SectorMapFilter = VXDTFFilters<SpacePoint>

private

The VXDTF filter.

Definition at line 28 of file SectorMapBasedSVDPairFilter.h.

◆ Super

using Super = BaseSVDPairFilter

private

The parent class.

Definition at line 25 of file SectorMapBasedSVDPairFilter.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);
}

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

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

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

◆ needsTruthInformation()

bool needsTruthInformation ( )

virtualinherited

Indicates if the filter requires Monte Carlo information.

Definition at line 48 of file Filter.icc.h.

    {
      return false;
    }

◆ operator()() [1/6]

virtual Weight operator() ( const Object & obj )

virtualinherited

Function to evaluate the object.

Base implementation accepts all objects.

Parameters

obj	The object to be accepted or rejected.

Returns: A finite float value if the object is accepted. NAN if the object is rejected.

◆ operator()() [2/6]

Weight operator() ( const Object & obj )

virtualinherited

Function to evaluate the object.

Base implementation accepts all objects.

Parameters

obj	The object to be accepted or rejected.

Returns: A finite float value if the object is accepted. NAN if the object is rejected.

Definition at line 59 of file Filter.icc.h.

    {
      return 1;
    }

◆ operator()() [3/6]

Weight operator() ( const Object * obj )

inherited

Function to evaluate the object.

Base implementation accepts all objects, except nullptr.

Parameters

obj	The object to be accepted or rejected.

Returns: A finit float value if the object is accepted. NAN if the object is rejected. Nullptr is always rejected.

◆ operator()() [4/6]

Weight operator() ( const Object * obj )

inherited

Function to evaluate the object.

Base implementation accepts all objects, except nullptr.

Parameters

obj	The object to be accepted or rejected.

Returns: A finit float value if the object is accepted. NAN if the object is rejected. Nullptr is always rejected.

Definition at line 69 of file Filter.icc.h.

    {
      return obj ? operator()(*obj) : NAN;
    }

◆ operator()() [5/6]

virtual std::vector< float > operator() ( const std::vector< Object * > & objs )

virtualinherited

Function to evaluate a vector of objects Base implementation applies the function to each object.

Can be optimized for MVA filters

Parameters

objs	A vector of pointers to objects

Returns: A vector of float or NAN values. See above

◆ operator()() [6/6]

std::vector< float > operator() ( const std::vector< Object * > & objs )

virtualinherited

Function to evaluate a vector of objects Base implementation applies the function to each object.

Can be optimized for MVA filters

Parameters

objs	A vector of pointers to objects

Returns: A vector of float or NAN values. See above

Definition at line 77 of file Filter.icc.h.

    {
      std::vector<float> out;
      for (const auto& obj : objs) {
        out.push_back(operator()(obj));
      }
      return out;
    }

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

FilterContainer& m_filtersContainer = FiltersContainer<SpacePoint>::getInstance()

private

The filter container to use.

Definition at line 47 of file SectorMapBasedSVDPairFilter.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_param_sectorMapName

std::string m_param_sectorMapName = "SVDOnlyDefault"

private

Name of the sector map to use.

Definition at line 51 of file SectorMapBasedSVDPairFilter.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_vxdtfFilters

SectorMapFilter* m_vxdtfFilters = nullptr

private

The sector map filter, will be set in begin run.

Definition at line 49 of file SectorMapBasedSVDPairFilter.h.

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

tracking/ckf/svd/filters/relations/include/SectorMapBasedSVDPairFilter.h
tracking/ckf/svd/filters/relations/src/SectorMapBasedSVDPairFilter.cc

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ FilterContainer

◆ Interface [1/2]

◆ Interface [2/2]

◆ Object [1/2]

◆ Object [2/2]

◆ SectorMapFilter

◆ Super

Member Function Documentation

◆ addProcessingSignalListener()

◆ beginEvent()

◆ endRun()

◆ getNProcessingSignalListener()

◆ initialize()

◆ needsTruthInformation()

◆ operator()() [1/6]

◆ operator()() [2/6]

◆ operator()() [3/6]

◆ operator()() [4/6]

◆ operator()() [5/6]

◆ operator()() [6/6]

◆ terminate()

Member Data Documentation

◆ m_filtersContainer

◆ m_initialized

◆ m_initializedAs

◆ m_param_sectorMapName

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated

◆ m_vxdtfFilters