LayerRelationFilter< AFilter > Class Template Reference

Relation filter the creation of relations. More...

#include <LayerRelationFilter.dcl.h>

Inheritance diagram for LayerRelationFilter< AFilter >:

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
	LayerRelationFilter ()
	Add the filter as listener.
	~LayerRelationFilter ()
	Default destructor.
std::vector< VXDHoughState * >	getPossibleTos (VXDHoughState *from, const std::vector< VXDHoughState * > &states) const final
	Return all states the given state is possible related to.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
	Expose the parameters of the filter.
TrackFindingCDC::Weight	operator() (const VXDHoughState &from, const VXDHoughState &to) final
	Get the weight of the relation between from and to.
void	beginRun () final
	Initialize the maximal ladder cache.
virtual std::vector< VXDHoughState * >	getPossibleTos (VXDHoughState *from, const std::vector< VXDHoughState * > &objects) const
	Selects the objects possibly related to the given one from the given pool of objects.
virtual Weight	operator() (const VXDHoughState &from, const VXDHoughState &to)
	Main filter method returning the weight of the neighborhood relation.
virtual std::vector< float >	operator() (const std::vector< Relation< VXDHoughState > * > &objs) override
	Filter over a vector of relations.
Weight	operator() (const Relation< VXDHoughState > &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	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 = TrackFindingCDC::RelationFilter< VXDHoughState >
	The parent class.

Private Attributes
int	m_hitJumping = 1
	Parameter: Make it possible to jump over N layers.
AFilter	m_filter
	Filter for rejecting the states.
std::array< ushort, 7 >	m_maximalLadderCache
	Cached number of ladders per layer.
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

template<class AFilter>
class Belle2::vxdHoughTracking::LayerRelationFilter< AFilter >

Relation filter the creation of relations.

Definition at line 24 of file LayerRelationFilter.dcl.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 = TrackFindingCDC::RelationFilter<VXDHoughState>

private

The parent class.

Definition at line 26 of file LayerRelationFilter.dcl.h.

Constructor & Destructor Documentation

LayerRelationFilter()

LayerRelationFilter

Add the filter as listener.

Definition at line 25 of file LayerRelationFilter.icc.h.

                                                      : Super()
    {
      Super::addProcessingSignalListener(&m_filter);
    }

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

finalvirtual

Initialize the maximal ladder cache.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 40 of file LayerRelationFilter.icc.h.

    {
      Super::beginRun();
 
      // Fill maximum number cache
      auto& geoCache = VXD::GeoCache::getInstance();
      const auto& layers = geoCache.getLayers(VXD::SensorInfoBase::SensorType::SVD);
      for (const auto& layerVXDID : layers) {
        m_maximalLadderCache[layerVXDID.getLayerNumber()] = geoCache.getLadders(layerVXDID).size();
      }
    }

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 of the filter.

Reimplemented from Filter< AObject >.

Definition at line 31 of file LayerRelationFilter.icc.h.

    {
      moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "hitJumping"), m_hitJumping,
                                    "Make it possible to jump over N layers.", m_hitJumping);
 
      m_filter.exposeParameters(moduleParamList, prefix);
    }

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< VXDHoughState * > getPossibleTos ( VXDHoughState *  from, const std::vector< VXDHoughState * > &  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< VXDHoughState * > getPossibleTos ( VXDHoughState *  from, const std::vector< VXDHoughState * > &  states  ) const

final

Return all states the given state is possible related to.

Definition at line 57 of file LayerRelationFilter.icc.h.

    {
      std::vector<VXDHoughState*> possibleNextHits;
      possibleNextHits.reserve(hits.size());
 
      const VXDHoughState::DataCache& currentVXDHoughState = currentHit->getDataCache();
      const unsigned int currentLayer = currentVXDHoughState.layer;
      const unsigned int nextPossibleLayer = std::max(static_cast<int>(currentLayer) - 1 - m_hitJumping, 0);
 
      for (VXDHoughState* nextHit : hits) {
        if (currentHit == nextHit) {
          continue;
        }
 
        const VXDHoughState::DataCache& nextVXDHoughState = nextHit->getDataCache();
        const unsigned int nextLayer = nextVXDHoughState.layer;
 
        if (std::max(currentLayer, nextPossibleLayer) >= nextLayer and nextLayer >= std::min(currentLayer, nextPossibleLayer)) {
 
          if (currentLayer == nextLayer) {
            // next layer is an overlap one, so lets return all hits from the same layer, that are on a
            // ladder which is below the last added hit.
            const unsigned int fromLadderNumber = currentVXDHoughState.ladder;
            const unsigned int maximumLadderNumber = m_maximalLadderCache.at(currentLayer);
 
            // the reason for this strange formula is the numbering scheme in the VXD.
            // we first substract 1 from the ladder number to have a ladder counting from 0 to N - 1,
            // then we add (PXD)/subtract(SVD) one to get to the next (overlapping) ladder and do a % N to also cope for the
            // highest number. Then we add 1 again, to go from the counting from 0 .. N-1 to 1 .. N.
            // The + maximumLadderNumber in between makes sure, we are not ending with negative numbers
            const int direction = -1;
            const unsigned int overlappingLadder =
              ((fromLadderNumber + maximumLadderNumber - 1) + direction) % maximumLadderNumber + 1;
 
            if (nextVXDHoughState.ladder != overlappingLadder) {
              continue;
            }
 
            // Next we make sure to not have any cycles in our graph: we do this by defining only the halves of the
            // sensor as overlapping. So if the first hit is coming from sensor 1 and the second from sensor 2,
            // they are only related if the one from sensor 1 is on the half, that is pointing towards sensor 2
            // and the one on sensor 2 is on the half that is pointing towards sensor 1.
            //
            //                       X                         X                         X
            //               ----|----                    ----|----                    ----|----
            //  This is fine:         X        This not:                X   This not:          X
            //                      ----|----                    ----|----                    ----|----
            if (currentVXDHoughState.localNormalizedu > 0.2) {
              continue;
            }
 
            if (nextVXDHoughState.localNormalizedu <= 0.8) {
              continue;
            }
          }
 
          possibleNextHits.push_back(nextHit);
        }
      }
 
      return possibleNextHits;
    }

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

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()() [2/7]

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()() [3/7]

Weight operator() ( const Relation< VXDHoughState > &  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()() [4/7]

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()() [5/7]

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

inlineoverridevirtualinherited

Filter over a vector of relations.

We need to override it since derrived 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;
      }

operator()() [6/7]

Weight operator() ( const VXDHoughState &  from, const VXDHoughState &  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()() [7/7]

TrackFindingCDC::Weight operator() ( const VXDHoughState &  from, const VXDHoughState &  to  )

final

Get the weight of the relation between from and to.

Definition at line 121 of file LayerRelationFilter.icc.h.

    {
      return m_filter(std::make_pair(&from, &to));
    }

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_filter

AFilter m_filter

private

Filter for rejecting the states.

Definition at line 53 of file LayerRelationFilter.dcl.h.

m_hitJumping

int m_hitJumping = 1

private

Parameter: Make it possible to jump over N layers.

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

m_initialized

bool m_initialized = false

privateinherited

Flag to keep track whether initialization happend 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_maximalLadderCache

std::array<ushort, 7> m_maximalLadderCache

private

Cached number of ladders per layer.

Definition at line 55 of file LayerRelationFilter.dcl.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 happend before.

Definition at line 55 of file ProcessingSignalListener.h.

---

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

• tracking/vxdHoughTracking/filters/relations/include/LayerRelationFilter.dcl.h
• tracking/vxdHoughTracking/filters/relations/include/LayerRelationFilter.icc.h