Belle II Software  release-05-02-19
AllFacetRelationFilter Class Reference

Filter accepting all facet relations with a default weight. More...

#include <AllFacetRelationFilter.h>

Inheritance diagram for AllFacetRelationFilter:
Collaboration diagram for AllFacetRelationFilter:

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

Weight operator() (const CDCFacet &fromFacet, const CDCFacet &toFacet) final
 Main filter method returning the weight of the neighborhood relation. More...
 
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...
 
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 = ProcessingSignalListener
 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

Filter accepting all facet relations with a default weight.

Definition at line 30 of file AllFacetRelationFilter.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< BaseFacetRelationFilter >, Chi2FacetRelationFilter, SimpleFacetRelationFilter, MCSymmetric< BaseFacetRelationFilter >, and MCFacetRelationFilter.

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

◆ operator()() [1/5]

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

Main filter method returning the weight of the neighborhood relation.

Return -2 for all valid combinations to accepting all facets, but compensating for overlap.

Definition at line 17 of file AllFacetRelationFilter.cc.

18 {
19  // The last wire of the neighbor should not be the same as the start wire of the facet
20  // The default weight must be -2 because the overlap of the facets is two points
21  // so the amount of two facets is 4 points hence the cellular automat
22  // must calculate 3 + (-2) + 3 = 4 as cellstate
23  // this can of course be adjusted for a more realistic information measure
24  // ( together with the facet creator filter)
25  return fromFacet.getStartRLWireHit().isOnWire(toFacet.getEndWire()) ? NAN : -2;
26 }

◆ operator()() [2/5]

virtual Weight operator() ( const const CDCFacet from,
const const CDCFacet 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
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 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
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 60 of file Filter.icc.h.

◆ operator()() [5/5]

Weight operator() ( const Relation< const CDCFacet > &  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: