Belle II Software  release-08-01-10
Public Types | Public Member Functions | Protected Member Functions | Private Types | Private Attributes | List of all members
MCSegmentTripleRelationFilter Class Reference

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

#include <MCSegmentTripleRelationFilter.h>

Inheritance diagram for MCSegmentTripleRelationFilter:
Inheritance graph
[legend]
Collaboration diagram for MCSegmentTripleRelationFilter:
Collaboration graph
[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

 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 std::vector< const CDCSegmentTriple * > getPossibleTos (const CDCSegmentTriple *from, const std::vector< const CDCSegmentTriple * > &objects) const
 Selects the objects possibly related to the given one from the given pool of objects.
 
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 23 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 38 of file MCSegmentTripleRelationFilter.cc.

40 {
41  if (fromTriple.getEndSegment() != toTriple.getStartSegment()) return NAN;
42 
43  Weight mcFromTripleWeight = m_mcSegmentTripleFilter(fromTriple);
44  Weight mcToTripleWeight = m_mcSegmentTripleFilter(toTriple);
45 
46  ESign fromFBInfo = sign(mcFromTripleWeight);
47  ESign toFBInfo = sign(mcToTripleWeight);
48 
49  if (not isValid(fromFBInfo) or not isValid(toFBInfo) or fromFBInfo != toFBInfo) return NAN;
50 
51  ESign commonFBInfo = fromFBInfo;
52 
53  Weight overlapWeight = toTriple.getStartSegment()->size();
54  return commonFBInfo > 0 ? overlapWeight : -overlapWeight;
55 }
Belle2::TrackFindingCDC::CDCSegmentTriple::getStartSegment
const CDCAxialSegment2D * getStartSegment() const
Getter for the start axial segment.
Definition: CDCSegmentTriple.h:101
Belle2::TrackFindingCDC::CDCSegmentTriple::getEndSegment
const CDCAxialSegment2D * getEndSegment() const
Getter for the end axial segment.
Definition: CDCSegmentTriple.h:125
Belle2::TrackFindingCDC::MCSegmentTripleRelationFilter::m_mcSegmentTripleFilter
MCSegmentTripleFilter m_mcSegmentTripleFilter
Instance of the Monte Carlo segment triple filter for rejection of false cells.
Definition: MCSegmentTripleRelationFilter.h:56
Belle2::TrackFindingCDC::ESignUtil::ESign
ESign
Enumeration for the distinct sign values of floating point variables.
Definition: ESign.h:27
Belle2::TrackFindingCDC::NForwardBackward::isValid
bool isValid(EForwardBackward eForwardBackward)
Check whether the given enum instance is one of the valid values.
Definition: EForwardBackward.h:45

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