Class filtering the neighborhood of facets with monte carlo information. More...

#include <MCFacetRelationFilter.h>

Inheritance diagram for MCFacetRelationFilter:

[legend]

Collaboration diagram for MCFacetRelationFilter:

[legend]

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

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

Public Member Functions
	MCFacetRelationFilter (bool allowReverse=false)
	Constructor also setting the switch if the reversed version of a facet (in comparision to MC truth) shall be accepted.

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 CDCFacet &fromFacet, const CDCFacet &toFacet) 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 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 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...

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< BaseFacetRelationFilter >
	Type of the super class.

Private Attributes
MCFacetFilter	m_mcFacetFilter
	Monte Carlo cell filter to reject neighborhoods have 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 facets with monte carlo information.

Definition at line 35 of file MCFacetRelationFilter.h.

Member Function Documentation

◆ operator()() [1/5]

Weight operator()	(	const CDCFacet &	fromFacet,
		const CDCFacet &	toFacet
	)

final

Main filter method returning the weight of the neighborhood relation.

Return NAN if relation shall be rejected.

Definition at line 41 of file MCFacetRelationFilter.cc.

 {
   // the last wire of the neighbor should not be the same as the start wire of the facet
   if (fromFacet.getStartWireHit().isOnWire(toFacet.getEndWire())) return NAN;
  
   // Despite of that two facets are neighbors if both are true facets
   // That also implies the correct tof alignment of the hits not common to both facets
   Weight fromFacetWeight = m_mcFacetFilter(fromFacet);
   Weight toFacetWeight = m_mcFacetFilter(toFacet);
  
   if ((fromFacetWeight > 0) and (toFacetWeight > 0)) {
     return 2;
   }
  
   if (getAllowReverse() and (fromFacetWeight < 0) and (toFacetWeight < 0)) {
     return -2;
   }
  
   return NAN;
 }

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

Reimplemented in MVA< BaseFacetRelationFilter >, and OnVarSet< BaseFacetRelationFilter >.

◆ 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/facetRelation/include/MCFacetRelationFilter.h
tracking/trackFindingCDC/filters/facetRelation/src/MCFacetRelationFilter.cc

Public Types

Public Member Functions

Protected Member Functions

Private Types