Class filtering the neighborhood of segment triples with monte carlo information. More...

#include <MCSegmentTripleRelationFilter.h>

Inheritance diagram for MCSegmentTripleRelationFilter:

[legend]

Collaboration diagram for MCSegmentTripleRelationFilter:

[legend]

Public Types
using	Object = Relation< const CDCSegmentTriple >
	Type of the object to be analysed.

using	Interface = Filter< Relation< const CDCSegmentTriple > >
	Mark this class as the basic interface.

Public Member Functions
	MCSegmentTripleRelationFilter (bool allowReverse=true)
	Constructor.

void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
	Expose the parameters to a module.

void	initialize () final
	Initialize the before event processing.

Weight	operator() (const CDCSegmentTriple &fromTriple, const CDCSegmentTriple &toTriple) final
	Main filter method returning the weight of the neighborhood relation. More...

void	setAllowReverse (bool allowReverse) override
	Setter for the allow reverse parameter.

void	beginEvent () override
	Signal the beginning of a new event.

bool	needsTruthInformation () final
	Indicates that the filter requires Monte Carlo information.

bool	getAllowReverse () const
	Getter for the allow reverse parameter.

std::vector< const CDCSegmentTriple * >	getPossibleTos (const CDCSegmentTriple from, const std::vector< const CDCSegmentTriple > &segmentTriples) const final
	Returns the segment triples form the range that continue on the to site of the given segment triple.

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

Weight	operator() (const Relation< const CDCSegmentTriple > &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...

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 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 = MCSymmetric< BaseSegmentTripleRelationFilter >
	Type of the super class.

Private Attributes
MCSegmentTripleFilter	m_mcSegmentTripleFilter
	Instance of the Monte Carlo segment triple filter for rejection of false cells.

bool	m_param_allowReverse
	Switch to indicate if the reversed version of the object shall also be accepted (default is true).

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

Class filtering the neighborhood of segment triples with monte carlo information.

Definition at line 33 of file MCSegmentTripleRelationFilter.h.

Member Function Documentation

◆ operator()() [1/5]

Weight operator()	(	const CDCSegmentTriple &	fromTriple,
		const CDCSegmentTriple &	toTriple
	)

final

Main filter method returning the weight of the neighborhood relation.

Return NAN if relation shall be rejected.

Definition at line 40 of file MCSegmentTripleRelationFilter.cc.

 {
   if (fromTriple.getEndSegment() != toTriple.getStartSegment()) return NAN;
  
   Weight mcFromTripleWeight = m_mcSegmentTripleFilter(fromTriple);
   Weight mcToTripleWeight = m_mcSegmentTripleFilter(toTriple);
  
   ESign fromFBInfo = sign(mcFromTripleWeight);
   ESign toFBInfo = sign(mcToTripleWeight);
  
   if (not isValid(fromFBInfo) or not isValid(toFBInfo) or fromFBInfo != toFBInfo) return NAN;
  
   ESign commonFBInfo = fromFBInfo;
  
   Weight overlapWeight = toTriple.getStartSegment()->size();
   return commonFBInfo > 0 ? overlapWeight  : -overlapWeight;
 }

◆ operator()() [2/5]

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

◆ operator()() [3/5]

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()() [4/5]

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

◆ operator()() [5/5]

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 52 of file RelationFilter.icc.h.

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

tracking/trackFindingCDC/filters/segmentTripleRelation/include/MCSegmentTripleRelationFilter.h
tracking/trackFindingCDC/filters/segmentTripleRelation/src/MCSegmentTripleRelationFilter.cc

Public Types

Public Member Functions

Protected Member Functions

Private Types