Class filtering the neighborhood of axial stereo segment pairs with monte carlo information. More...

#include <MCSegmentPairRelationFilter.h>

Inheritance diagram for MCSegmentPairRelationFilter:

[legend]

Collaboration diagram for MCSegmentPairRelationFilter:

[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
	MCSegmentPairRelationFilter (bool allowReverse=true)
	Constructor setting to default reversal symmetry.

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 CDCSegmentPair &fromSegmentPair, const CDCSegmentPair &toSegmentPair) final
	Main filter method returning the weight of the neighborhood relation. More...

void	setAllowReverse (bool allowReverse) final
	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 CDCSegmentPair * >	getPossibleTos (const CDCSegmentPair from, const std::vector< const CDCSegmentPair > &segmentPairs) const final
	Returns the segment pairs form the range that continue on the to site of the given segment pair.

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

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

Weight	operator() (const Relation< const CDCSegmentPair > &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< BaseSegmentPairRelationFilter >
	Type of the super class.

Private Attributes
MCSegmentPairFilter	m_mcSegmentPairFilter
	Instance of the Monte Carlo axial stereo segment 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 axial stereo segment pairs with monte carlo information.

Definition at line 23 of file MCSegmentPairRelationFilter.h.

Member Function Documentation

◆ operator()() [1/5]

Weight operator()	(	const CDCSegmentPair &	fromSegmentPair,
		const CDCSegmentPair &	toSegmentPair
	)

final

Main filter method returning the weight of the neighborhood relation.

Return NAN if relation shall be rejected.

Definition at line 39 of file MCSegmentPairRelationFilter.cc.

 {
   Weight mcFromPairWeight = m_mcSegmentPairFilter(fromSegmentPair);
   Weight mcToPairWeight = m_mcSegmentPairFilter(toSegmentPair);
  
   ESign fromFBInfo = sign(mcFromPairWeight);
   ESign toFBInfo = sign(mcToPairWeight);
  
   if (isValid(fromFBInfo) and isValid(toFBInfo) and fromFBInfo == toFBInfo) {
     ESign commonFBInfo = fromFBInfo;
  
     size_t fromOverlapSize = fromSegmentPair.getToSegment()->size();
     size_t fromSize = fromOverlapSize + fromSegmentPair.getFromSegment()->size();
     Weight fromWeight = fromSegmentPair.getAutomatonCell().getCellWeight();
  
     size_t toOverlapSize = toSegmentPair.getFromSegment()->size();
     size_t toSize = toOverlapSize + toSegmentPair.getToSegment()->size();
     Weight toWeight = toSegmentPair.getAutomatonCell().getCellWeight();
     double overlapWeight =
       (fromWeight * fromOverlapSize / fromSize + toWeight * toOverlapSize / toSize) / 2.0;
  
     if (commonFBInfo < 0 and Super::getAllowReverse()) {
       return -std::fabs(overlapWeight);
     } else if (commonFBInfo > 0) {
       return std::fabs(overlapWeight);
     } else {
       return NAN;
     }
   } else {
     return NAN;
   }
 }

◆ operator()() [2/5]

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

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()() [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 58 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 51 of file RelationFilter.icc.h.

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

tracking/trackFindingCDC/filters/segmentPairRelation/include/MCSegmentPairRelationFilter.h
tracking/trackFindingCDC/filters/segmentPairRelation/src/MCSegmentPairRelationFilter.cc

Public Types

Public Member Functions

Protected Member Functions

Private Types