BaseSegmentRelationFilter Class Reference

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

#include <BaseSegmentRelationFilter.h>

Inheritance diagram for BaseSegmentRelationFilter:

Collaboration diagram for BaseSegmentRelationFilter:

Public Types
using	Object = Relation< const CDCSegment2D >
	Type of the object to be analysed.
using	Interface = Filter< Relation< const CDCSegment2D > >
	Mark this class as the basic interface.

Public Member Functions
	BaseSegmentRelationFilter ()
	Default constructor.
virtual	~BaseSegmentRelationFilter ()
	Default destructor.
std::vector< const CDCSegment2D * >	getPossibleTos (const CDCSegment2D *from, const std::vector< const CDCSegment2D * > &segments) const final
	Returns all equivalent segment in the range.
Weight	operator() (const Relation< const CDCSegment2D > &relation) override
	Main filter method overriding the filter interface method. More...
virtual Weight	operator() (const const CDCSegment2D &from, const const CDCSegment2D &to)
	Main filter method returning the weight of the neighborhood relation. 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 = RelationFilter< const CDCSegment2D >
	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 segments.

Definition at line 40 of file BaseSegmentRelationFilter.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.

Reimplemented in MVA< BaseSegmentRelationFilter >, MCSymmetric< BaseSegmentRelationFilter >, and MCSegmentRelationFilter.

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

operator()() [1/4]

virtual Weight operator() ( const const CDCSegment2D &  from, const const CDCSegment2D &  to  )

virtualinherited

Main filter method returning the weight of the neighborhood relation.

Return always returns NAN to reject all segment neighbors.

operator()() [2/4]

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< BaseSegmentRelationFilter >, and OnVarSet< BaseSegmentRelationFilter >.

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

operator()() [4/4]

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

override

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 BaseSegmentRelationFilter.cc.

{
  const CDCSegment2D* from = relation.getFrom();
  const CDCSegment2D* to = relation.getTo();
  if (from == to) return NAN; // Prevent relation to same.
  if ((from == nullptr) or (to == nullptr)) return NAN;
 
  // Make an overlap check to prevent aliases and reverse segments to be linked
  std::vector<const CDCWireHit*> fromWireHits;
  fromWireHits.reserve(from->size());
  for (const CDCRecoHit2D& recoHit2D : *from) {
    // cppcheck-suppress useStlAlgorithm
    fromWireHits.push_back(&recoHit2D.getWireHit());
  }
  std::sort(fromWireHits.begin(), fromWireHits.end());
  int nOverlap = 0;
  for (const CDCRecoHit2D& recoHit2D : *to) {
    if (std::binary_search(fromWireHits.begin(), fromWireHits.end(), &recoHit2D.getWireHit())) {
      ++nOverlap;
    }
  }
 
  if (1.0 * nOverlap / from->size() > 0.8) {
    return NAN;
  }
 
  return this->operator()(*from, *to);
}

---

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

• tracking/trackFindingCDC/filters/segmentRelation/include/BaseSegmentRelationFilter.h
• tracking/trackFindingCDC/filters/segmentRelation/src/BaseSegmentRelationFilter.cc