WholeWireHitRelationFilter Class Reference

Class mapping the neighborhood of wires to the neighborhood of wire hits. More...

#include <WholeWireHitRelationFilter.h>

Inheritance diagram for WholeWireHitRelationFilter:

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
	WholeWireHitRelationFilter (int neighborhoodDegree=2)
	Constructor form the default neighborhood degree.
	~WholeWireHitRelationFilter ()
	Default destructor.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
	Expose the parameters to a module.
std::vector< CDCWireHit * >	getPossibleTos (CDCWireHit *from, const std::vector< CDCWireHit * > &wireHits) const final
	Returns a vector containing the neighboring wire hits of the given wire hit out of the sorted range given by the two iterator other arguments.
virtual std::vector< CDCWireHit * >	getPossibleTos (CDCWireHit *from, const std::vector< CDCWireHit * > &objects) const
	Selects the objects possibly related to the given one from the given pool of objects.
virtual Weight	operator() (const CDCWireHit &from, const CDCWireHit &to)
	Main filter method returning the weight of the neighborhood relation.
virtual std::vector< float >	operator() (const std::vector< Relation< CDCWireHit > * > &objs) override
	Filter over a vector of relations.
Weight	operator() (const Relation< CDCWireHit > &relation) override
	Main filter method overriding the filter interface method.
virtual Weight	operator() (const Object &obj)
	Function to evaluate the object.
Weight	operator() (const Object *obj)
	Function to evaluate the object.
virtual std::vector< float >	operator() (const std::vector< Object * > &objs)
	Function to evaluate a vector of objects Base implementation applies the function to each object.
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
int	m_param_degree = 2
	Degree of the neighbor extend.
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 happened before.
bool	m_terminated = false
	Flag to keep track whether termination happened before.
std::string	m_initializedAs
	Name of the type during initialisation.

Detailed Description

Class mapping the neighborhood of wires to the neighborhood of wire hits.

Definition at line 26 of file WholeWireHitRelationFilter.h.

Member Typedef Documentation

Interface

using Interface = Filter<AObject>

inherited

Mark this class as the basic interface.

Definition at line 38 of file Filter.dcl.h.

Object

using Object = AObject

inherited

Type of the object to be analysed.

Definition at line 35 of file Filter.dcl.h.

Super

using Super = ProcessingSignalListener

privateinherited

Type of the base class.

Definition at line 25 of file CompositeProcessingSignalListener.h.

Constructor & Destructor Documentation

WholeWireHitRelationFilter()

WholeWireHitRelationFilter ( int  neighborhoodDegree = 2 )

explicit

Constructor form the default neighborhood degree.

Definition at line 31 of file WholeWireHitRelationFilter.cc.

  : m_param_degree(neighborhoodDegree)
{
}

Member Function Documentation

addProcessingSignalListener()

void addProcessingSignalListener ( ProcessingSignalListener *  psl )

protectedinherited

Register a processing signal listener to be notified.

Definition at line 55 of file CompositeProcessingSignalListener.cc.

{
  m_subordinaryProcessingSignalListeners.push_back(psl);
}

beginEvent()

void beginEvent ( )

overridevirtualinherited

Receive and dispatch signal for the start of a new event.

Reimplemented from ProcessingSignalListener.

Reimplemented in SpacePointTagger< Belle2::CKFToPXDResult, Belle2::PXDCluster >, SpacePointTagger< Belle2::CKFToSVDResult, Belle2::SVDCluster >, BaseEventTimeExtractor< RecoTrack * >, BaseEventTimeExtractor< TrackFindingCDC::CDCWireHit & >, SharingHitsMatcher< Belle2::TrackFindingCDC::CDCTrack, Belle2::TrackFindingCDC::CDCSegment2D >, MCSymmetric< BaseAxialSegmentPairFilter >, MCSymmetric< BaseFacetFilter >, MCSymmetric< BaseFacetRelationFilter >, MCSymmetric< BaseSegmentPairFilter >, MCSymmetric< BaseSegmentPairRelationFilter >, MCSymmetric< BaseSegmentRelationFilter >, MCSymmetric< BaseSegmentTripleFilter >, MCSymmetric< BaseSegmentTripleRelationFilter >, MCSymmetric< BaseTrackRelationFilter >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCFacet >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCWireHit, true >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegment2D >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCTrack >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentPair >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentTriple >, RecoTrackStorer, ROIFinder, and SVDHoughTracking.

Definition at line 31 of file CompositeProcessingSignalListener.cc.

{
  Super::beginEvent();
  for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
    psl->beginEvent();
  }
}

beginRun()

void beginRun ( )

overridevirtualinherited

Receive and dispatch signal for the beginning of a new run.

Reimplemented from ProcessingSignalListener.

Reimplemented in LayerRelationFilter< AFilter >, FourHitFilter, QualityIndicatorFilter, ThreeHitFilter, TwoHitVirtualIPFilter, TwoHitVirtualIPQIFilter, RecoTrackStorer, ROIFinder, SpacePointLoaderAndPreparer, and TrackCandidateResultRefiner.

Definition at line 23 of file CompositeProcessingSignalListener.cc.

{
  Super::beginRun();
  for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
    psl->beginRun();
  }
}

endRun()

void endRun ( )

overridevirtualinherited

Receive and dispatch signal for the end of the run.

Reimplemented from ProcessingSignalListener.

Definition at line 39 of file CompositeProcessingSignalListener.cc.

{
  for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
    psl->endRun();
  }
  Super::endRun();
}

exposeParameters()

void exposeParameters ( ModuleParamList *  moduleParamList, const std::string &  prefix  )

finalvirtual

Expose the parameters to a module.

Reimplemented from Filter< AObject >.

Definition at line 38 of file WholeWireHitRelationFilter.cc.

{
  moduleParamList
  ->addParameter(prefixed(prefix, "degree"),
                 m_param_degree,
                 "Neighbor degree which are included. 1 for primary, 2 for secondary, 3 ...",
                 m_param_degree);
}

getNProcessingSignalListener()

int getNProcessingSignalListener ( )

protectedinherited

Get the number of currently registered listeners.

Definition at line 60 of file CompositeProcessingSignalListener.cc.

{
  return m_subordinaryProcessingSignalListeners.size();
}

getPossibleTos() [1/2]

std::vector< CDCWireHit * > getPossibleTos ( CDCWireHit *  from, const std::vector< CDCWireHit * > &  objects  ) const

virtualinherited

Selects the objects possibly related to the given one from the given pool of objects.

Definition at line 39 of file RelationFilter.icc.h.

    {
      return objects;
    }

getPossibleTos() [2/2]

std::vector< CDCWireHit * > getPossibleTos ( CDCWireHit *  from, const std::vector< CDCWireHit * > &  wireHits  ) const

final

Returns a vector containing the neighboring wire hits of the given wire hit out of the sorted range given by the two iterator other arguments.

Definition at line 48 of file WholeWireHitRelationFilter.cc.

{
  assert(std::is_sorted(wireHits.begin(), wireHits.end(), LessOf<Deref>()) &&
         "Expected wire hits to be sorted");
 
  const int nWireNeighbors = 8 + 10 * (m_param_degree - 1);
  std::vector<const CDCWire*> m_wireNeighbors;
  m_wireNeighbors.reserve(nWireNeighbors);
 
  std::vector<CDCWireHit*> m_wireHitNeighbors;
  m_wireHitNeighbors.reserve(2 * nWireNeighbors);
 
  const CDCWireTopology& wireTopology = CDCWireTopology::getInstance();
  const CDCWire& wire = from->getWire();
 
  const CDCWire* ccwSixthSecondWireNeighbor = wireTopology.getSecondNeighborSixOClock(wire);
  const CDCWire* ccwInWireNeighbor = wireTopology.getNeighborCCWInwards(wire);
  const CDCWire* ccwWireNeighbor = wireTopology.getNeighborCCW(wire);
  const CDCWire* ccwOutWireNeighbor = wireTopology.getNeighborCCWOutwards(wire);
  const CDCWire* ccwTwelvethSecondWireNeighbor = wireTopology.getSecondNeighborTwelveOClock(wire);
 
  const CDCWire* cwSixthSecondWireNeighbor = ccwSixthSecondWireNeighbor;
  const CDCWire* cwInWireNeighbor = wireTopology.getNeighborCWInwards(wire);
  const CDCWire* cwWireNeighbor = wireTopology.getNeighborCW(wire);
  const CDCWire* cwOutWireNeighbor = wireTopology.getNeighborCWOutwards(wire);
  const CDCWire* cwTwelvethSecondWireNeighbor = ccwTwelvethSecondWireNeighbor;
 
  // Insert the neighbors such that they are most likely sorted.
 
  // Degree 1 neighborhood - only add the six o'clock and the twelve o'clock neighbor once
  if (m_param_degree > 1 and ccwSixthSecondWireNeighbor)
    m_wireNeighbors.push_back(ccwSixthSecondWireNeighbor);
 
  if (cwInWireNeighbor) m_wireNeighbors.push_back(cwInWireNeighbor);
  if (ccwInWireNeighbor) m_wireNeighbors.push_back(ccwInWireNeighbor);
 
  if (cwWireNeighbor) m_wireNeighbors.push_back(cwWireNeighbor);
  if (ccwWireNeighbor) m_wireNeighbors.push_back(ccwWireNeighbor);
 
  if (cwOutWireNeighbor) m_wireNeighbors.push_back(cwOutWireNeighbor);
  if (ccwOutWireNeighbor) m_wireNeighbors.push_back(ccwOutWireNeighbor);
 
  if (m_param_degree > 1 and ccwTwelvethSecondWireNeighbor)
    m_wireNeighbors.push_back(ccwTwelvethSecondWireNeighbor);
 
  for (int degree = 1; degree < m_param_degree; ++degree) {
    if (cwSixthSecondWireNeighbor) {
      cwSixthSecondWireNeighbor = cwSixthSecondWireNeighbor->getNeighborCW();
      m_wireNeighbors.push_back(cwSixthSecondWireNeighbor);
    }
    if (ccwSixthSecondWireNeighbor) {
      ccwSixthSecondWireNeighbor = ccwSixthSecondWireNeighbor->getNeighborCCW();
      m_wireNeighbors.push_back(ccwSixthSecondWireNeighbor);
    }
 
    if (cwInWireNeighbor) {
      cwInWireNeighbor = cwInWireNeighbor->getNeighborCW();
      m_wireNeighbors.push_back(cwInWireNeighbor);
    }
    if (ccwInWireNeighbor) {
      ccwInWireNeighbor = ccwInWireNeighbor->getNeighborCCW();
      m_wireNeighbors.push_back(ccwInWireNeighbor);
    }
 
    if (cwWireNeighbor) {
      cwWireNeighbor = cwWireNeighbor->getNeighborCW();
      m_wireNeighbors.push_back(cwWireNeighbor);
    }
    if (ccwWireNeighbor) {
      ccwWireNeighbor = ccwWireNeighbor->getNeighborCCW();
      m_wireNeighbors.push_back(ccwWireNeighbor);
    }
 
    if (cwOutWireNeighbor) {
      cwOutWireNeighbor = cwOutWireNeighbor->getNeighborCW();
      m_wireNeighbors.push_back(cwOutWireNeighbor);
    }
    if (ccwOutWireNeighbor) {
      ccwOutWireNeighbor = ccwOutWireNeighbor->getNeighborCCW();
      m_wireNeighbors.push_back(ccwOutWireNeighbor);
    }
 
    if (cwTwelvethSecondWireNeighbor) {
      cwTwelvethSecondWireNeighbor = cwTwelvethSecondWireNeighbor->getNeighborCW();
      m_wireNeighbors.push_back(cwTwelvethSecondWireNeighbor);
    }
    if (ccwTwelvethSecondWireNeighbor) {
      ccwTwelvethSecondWireNeighbor = ccwTwelvethSecondWireNeighbor->getNeighborCCW();
      m_wireNeighbors.push_back(ccwTwelvethSecondWireNeighbor);
    }
  }
 
  std::sort(std::begin(m_wireNeighbors), std::end(m_wireNeighbors));
 
  for (const CDCWire* neighborWire : m_wireNeighbors) {
    ConstVectorRange<CDCWireHit*> neighborWireHits{
      std::equal_range(wireHits.begin(), wireHits.end(), neighborWire, LessOf<Deref>())};
 
    m_wireHitNeighbors.insert(m_wireHitNeighbors.end(),
                              neighborWireHits.begin(),
                              neighborWireHits.end());
  }
 
  return m_wireHitNeighbors;
}

initialize()

void initialize ( )

overridevirtualinherited

Receive and dispatch signal before the start of the event processing.

Reimplemented from ProcessingSignalListener.

Reimplemented in UnionVarSet< AObject >, UnionVarSet< Object >, VariadicUnionVarSet< AVarSets >, ResultStorer< Belle2::CKFToPXDResult >, ResultStorer< Belle2::CKFToSVDResult >, BaseEventTimeExtractor< RecoTrack * >, BaseEventTimeExtractor< TrackFindingCDC::CDCWireHit & >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::HyperHough >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::QuadraticLegendre >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::Z0TanLambdaLegendre >, OnVarSet< Filter< ATruthVarSet::Object > >, OnVarSet< Filter< AVarSet::Object > >, OnVarSet< BaseFacetFilter >, OnVarSet< BaseFacetRelationFilter >, OnVarSet< BaseAxialSegmentPairFilter >, OnVarSet< BaseSegmentRelationFilter >, OnVarSet< BaseTrackRelationFilter >, OnVarSet< BaseSegmentPairRelationFilter >, MCSymmetric< BaseAxialSegmentPairFilter >, MCSymmetric< BaseFacetFilter >, MCSymmetric< BaseFacetRelationFilter >, MCSymmetric< BaseSegmentPairFilter >, MCSymmetric< BaseSegmentPairRelationFilter >, MCSymmetric< BaseSegmentRelationFilter >, MCSymmetric< BaseSegmentTripleFilter >, MCSymmetric< BaseSegmentTripleRelationFilter >, MCSymmetric< BaseTrackRelationFilter >, StoreArrayLoader< const Belle2::SpacePoint >, StoreArrayLoader< DataStoreInputTypeRefType >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCFacet >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCWireHit, true >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegment2D >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCTrack >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentPair >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentTriple >, RelationVarSet< ABaseVarSet >, QualityIndicatorFilter, TwoHitVirtualIPQIFilter, MultiHoughSpaceFastInterceptFinder, RawTrackCandCleaner< AHit >, RawTrackCandCleaner< Belle2::vxdHoughTracking::VXDHoughState >, RecoTrackStorer, ROIFinder, SingleHoughSpaceFastInterceptFinder, SpacePointLoaderAndPreparer, TrackCandidateOverlapResolver, and TrackCandidateResultRefiner.

Definition at line 15 of file CompositeProcessingSignalListener.cc.

{
  Super::initialize();
  for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
    psl->initialize();
  }
}

needsTruthInformation()

bool needsTruthInformation

virtualinherited

Indicates if the filter requires Monte Carlo information.

Reimplemented in MCSymmetric< BaseAxialSegmentPairFilter >, MCSymmetric< BaseFacetFilter >, MCSymmetric< BaseFacetRelationFilter >, MCSymmetric< BaseSegmentPairFilter >, MCSymmetric< BaseSegmentPairRelationFilter >, MCSymmetric< BaseSegmentRelationFilter >, MCSymmetric< BaseSegmentTripleFilter >, MCSymmetric< BaseSegmentTripleRelationFilter >, MCSymmetric< BaseTrackRelationFilter >, OnVarSet< Filter< ATruthVarSet::Object > >, OnVarSet< Filter< AVarSet::Object > >, OnVarSet< BaseFacetFilter >, OnVarSet< BaseFacetRelationFilter >, OnVarSet< BaseAxialSegmentPairFilter >, OnVarSet< BaseSegmentRelationFilter >, OnVarSet< BaseTrackRelationFilter >, and OnVarSet< BaseSegmentPairRelationFilter >.

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

    {
      return false;
    }

operator()() [1/6]

Weight operator() ( const CDCWireHit &  from, const CDCWireHit &  to  )

virtualinherited

Main filter method returning the weight of the neighborhood relation.

Return always returns NAN to reject all segment neighbors.

Definition at line 46 of file RelationFilter.icc.h.

    {
      return 1;
    }

operator()() [2/6]

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 SeedChargeCDCPathFilter, SizeCDCPathFilter, ArcLengthBasedCDCfromEclPathPairFilter, ArcLengthBasedCDCPathPairFilter, Chi2BasedCDCPathPairFilter, DistanceBasedCDCPathPairFilter, DuplicateCDCPathPairFilter, HitDistanceBasedCDCPathPairFilter, MCTruthCDCPathPairFilter, DistanceCDCStateFilter, ExtrapolateAndUpdateCDCStateFilter, MCTruthCDCStateFilter, MCTruthEclSeedFilter, RoughCDCfromEclStateFilter, RoughCDCStateFilter, FiveHitFilter, FourHitFilter, QualityIndicatorFilter, ThreeHitFilter, TwoHitVirtualIPFilter, TwoHitVirtualIPQIFilter, SimplePXDStateFilter, AllPXDStateFilter, ResidualSVDStateFilter, SimpleSVDStateFilter, AllSVDStateFilter, and RelationFilter< AObject >.

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

    {
      return 1;
    }

operator()() [3/6]

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

    {
      return obj ? operator()(*obj) : NAN;
    }

operator()() [4/6]

Weight operator() ( const Relation< CDCWireHit > &  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 69 of file RelationFilter.icc.h.

    {
      const AObject* from = relation.getFrom();
      const AObject* to = relation.getTo();
 
      if (from == to) return NAN; // Prevent relation to same.
      if ((from == nullptr) or (to == nullptr)) return NAN;
      return operator()(*from, *to);
    }

operator()() [5/6]

std::vector< float > operator() ( const std::vector< Object * > &  objs )

virtualinherited

Function to evaluate a vector of objects Base implementation applies the function to each object.

Can be optimized for MVA filters

Parameters

objs	A vector of pointers to objects

Returns

A vector of float or NAN values. See above

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

    {
      std::vector<float> out;
      for (const auto& obj : objs) {
        out.push_back(operator()(obj));
      }
      return out;
    }

operator()() [6/6]

virtual std::vector< float > operator() ( const std::vector< Relation< CDCWireHit > * > &  objs )

inlineoverridevirtualinherited

Filter over a vector of relations.

We need to override it since derived relation classes do not implement a call with a pointer to a relation.

Definition at line 51 of file RelationFilter.dcl.h.

      {
        std::vector<float> out(objs.size());
        for (size_t iObj = 0; iObj < objs.size(); iObj += 1) {
          if (objs[iObj]) {
            out[iObj] = operator()(*objs[iObj]);
          } else {
            out[iObj] = NAN;
          }
        }
        return out;
      }

terminate()

void terminate ( )

overridevirtualinherited

Receive and dispatch Signal for termination of the event processing.

Reimplemented from ProcessingSignalListener.

Reimplemented in StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::HyperHough >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::QuadraticLegendre >, and StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::Z0TanLambdaLegendre >.

Definition at line 47 of file CompositeProcessingSignalListener.cc.

{
  for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
    psl->terminate();
  }
  Super::terminate();
}

Member Data Documentation

m_initialized

bool m_initialized = false

privateinherited

Flag to keep track whether initialization happened before.

Definition at line 52 of file ProcessingSignalListener.h.

m_initializedAs

std::string m_initializedAs

privateinherited

Name of the type during initialisation.

Definition at line 58 of file ProcessingSignalListener.h.

m_param_degree

int m_param_degree = 2

private

Degree of the neighbor extend.

Definition at line 47 of file WholeWireHitRelationFilter.h.

m_subordinaryProcessingSignalListeners

std::vector<ProcessingSignalListener*> m_subordinaryProcessingSignalListeners

privateinherited

References to subordinary signal processing listener contained in this findlet.

Definition at line 52 of file CompositeProcessingSignalListener.h.

m_terminated

bool m_terminated = false

privateinherited

Flag to keep track whether termination happened before.

Definition at line 55 of file ProcessingSignalListener.h.

---

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

• tracking/trackFindingCDC/filters/wireHitRelation/include/WholeWireHitRelationFilter.h
• tracking/trackFindingCDC/filters/wireHitRelation/src/WholeWireHitRelationFilter.cc