Belle II Software  release-08-01-10
MCFacetRelationFilter Class Reference

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

#include <MCFacetRelationFilter.h>

Inheritance diagram for MCFacetRelationFilter:
Collaboration diagram for MCFacetRelationFilter:

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

 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 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...
 
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 25 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 39 of file MCFacetRelationFilter.cc.

41 {
42  // the last wire of the neighbor should not be the same as the start wire of the facet
43  if (fromFacet.getStartWireHit().isOnWire(toFacet.getEndWire())) return NAN;
44 
45  // Despite of that two facets are neighbors if both are true facets
46  // That also implies the correct tof alignment of the hits not common to both facets
47  Weight fromFacetWeight = m_mcFacetFilter(fromFacet);
48  Weight toFacetWeight = m_mcFacetFilter(toFacet);
49 
50  if ((fromFacetWeight > 0) and (toFacetWeight > 0)) {
51  return 2;
52  }
53 
54  if (getAllowReverse() and (fromFacetWeight < 0) and (toFacetWeight < 0)) {
55  return -2;
56  }
57 
58  return NAN;
59 }
const CDCWire & getEndWire() const
Getter for the wire the third oriented wire hit is based on.
const CDCWireHit & getStartWireHit() const
Getter for the hit wire of the first oriented wire hit.
bool isOnWire(const CDCWire &wire) const
Checks if the wire hit is based on the given wire.
Definition: CDCWireHit.h:242
MCFacetFilter m_mcFacetFilter
Monte Carlo cell filter to reject neighborhoods have false cells.
bool getAllowReverse() const
Getter for the allow reverse parameter.

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

◆ operator()() [4/5]

Weight operator() ( const Object obj)
inherited

Function to evaluate the object.

Base implementation accepts all objects, except nullptr.

Parameters
objThe 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: