Base class for filtering the neighborhood of facets. More...

#include <BaseFacetRelationFilter.h>

Inheritance diagram for BaseFacetRelationFilter:

[legend]

Collaboration diagram for BaseFacetRelationFilter:

[legend]

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

using	Interface = Filter< AObject >
	Mark this class as the basic interface.

Public Member Functions
	BaseFacetRelationFilter ()
	Default constructor.

	~BaseFacetRelationFilter ()
	Default destructor.

std::vector< const CDCFacet * >	getPossibleTos (const CDCFacet from, const std::vector< const CDCFacet > &facets) const final
	Returns the selection of facets covering the range of possible neighboring facets of the given facet out of the sorted range given by the two other argumets.

virtual std::vector< const CDCFacet * >	getPossibleTos (const CDCFacet from, const std::vector< const CDCFacet > &objects) const
	Selects the objects possibly related to the given one from the given pool of objects.

virtual Weight	operator() (const const CDCFacet &from, const const CDCFacet &to)
	Main filter method returning the weight of the neighborhood relation. More...

Weight	operator() (const Relation< const CDCFacet > &relation) override
	Main filter method overriding the filter interface method. More...

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

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

virtual void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix)
	Expose the set of parameters of the filter to the module parameter list. More...

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

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

Private Attributes
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 happend before.

bool	m_terminated = false
	Flag to keep track whether termination happend before.

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

Detailed Description

Base class for filtering the neighborhood of facets.

Definition at line 26 of file BaseFacetRelationFilter.h.

Member Function Documentation

◆ exposeParameters()

void exposeParameters	(	ModuleParamList *	moduleParamList,
		const std::string &	prefix
	)

virtualinherited

Expose the set of parameters of the filter to the module parameter list.

Note that not all filters have yet exposed their parameters in this way.

This method is deprecated as the exposeParams below uses a less compile heavy equivalent.

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

◆ operator()() [1/4]

Weight operator()	(	const AObject &	from,
		const AObject &	to
	)

virtualinherited

Main filter method returning the weight of the neighborhood relation.

Return always returns NAN to reject all segment neighbors.

Definition at line 44 of file RelationFilter.icc.h.

◆ operator()() [2/4]

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.

Reimplemented in AllSVDStateFilter, SimpleSVDStateFilter, ResidualSVDStateFilter, AllPXDStateFilter, SimplePXDStateFilter, TwoHitVirtualIPQIFilter, TwoHitVirtualIPFilter, ThreeHitFilter, QualityIndicatorFilter, FourHitFilter, FiveHitFilter, RoughCDCStateFilter, RoughCDCfromEclStateFilter, MCTruthEclSeedFilter, MCTruthCDCStateFilter, ExtrapolateAndUpdateCDCStateFilter, DistanceCDCStateFilter, MCTruthCDCPathPairFilter, HitDistanceBasedCDCPathPairFilter, DuplicateCDCPathPairFilter, DistanceBasedCDCPathPairFilter, Chi2BasedCDCPathPairFilter, ArcLengthBasedCDCPathPairFilter, ArcLengthBasedCDCfromEclPathPairFilter, SizeCDCPathFilter, and SeedChargeCDCPathFilter.

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

◆ operator()() [3/4]

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 58 of file Filter.icc.h.

◆ operator()() [4/4]

Weight operator() ( const Relation< AObject > & relation )

overrideinherited

Main filter method overriding the filter interface method.

Checks the validity of the pointers in the relation and unpacks the relation to the method implementing the rejection.

Definition at line 51 of file RelationFilter.icc.h.

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

tracking/trackFindingCDC/filters/facetRelation/include/BaseFacetRelationFilter.h
tracking/trackFindingCDC/filters/facetRelation/src/BaseFacetRelationFilter.cc

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Function Documentation

◆ exposeParameters()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]