BridgingWireHitRelationFilter Class Reference

Wire hit relation filter that is compensating for hit inefficiencies. More...

#include <BridgingWireHitRelationFilter.h>

Inheritance diagram for BridgingWireHitRelationFilter:

Collaboration diagram for BridgingWireHitRelationFilter:

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
	BridgingWireHitRelationFilter ()
	Default constructor.
	~BridgingWireHitRelationFilter ()
	Default destructor.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
	Expose the set of parameters of the filter to the module parameter list.
void	initialize () override
	Receive signal at the begin of the event processing and prepare some parameters. More...
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 argumets. More...
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. More...
Weight	operator() (const Relation< CDCWireHit > &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 bool	needsTruthInformation ()
	Indicates if the filter requires Monte Carlo information.
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 = RelationFilter< CDCWireHit >
	Type of the base class.

Private Attributes
std::map< int, int >	m_param_missingPrimaryNeighborThresholdMap
	Parameter: A map from o'clock direction to the number of missing primary drift cells. More...
std::array< short, 12 >	m_missingPrimaryNeighborThresholds
	Array for the number of primary drift cells to be included for the o'clock position at each index.
std::vector< short >	m_consideredSecondaryNeighbors
	Indices of the considered o'clock positions of the secondary neighborhood.
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

Wire hit relation filter that is compensating for hit inefficiencies.

The default setup counters some hits lost due to a drift time cut off if the track enters at the edge of a drift cell. The biggest effect observed in the CDC simulation was observed when the track is along the 2, 4, 8 and 10 o'clock direction since in this case two neighboring hits can be lost due to this time cut off. In an attempt to detect if this occured the primary wire hit neighborhood is slightly extended to bridge to the secondary neighborhood in the critical directions.

The criterion can be lowered such that fewer missing hits trigger the inclusion of the secondary neighbors.

Definition at line 40 of file BridgingWireHitRelationFilter.h.

Member Function Documentation

getPossibleTos()

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 argumets.

Merge the sorted primary and secondary neighbors.

Definition at line 68 of file BridgingWireHitRelationFilter.cc.

{
  assert(std::is_sorted(wireHits.begin(), wireHits.end(), LessOf<Deref>()) &&
         "Expected wire hits to be sorted");
 
  std::vector<std::pair<const CDCWire*, int>> wireNeighbors;
  wireNeighbors.reserve(8);
 
  std::vector<CDCWireHit*> wireHitNeighbors;
  wireHitNeighbors.reserve(12);
 
  std::array<short, 12> missingPrimaryNeighbor = {0};
 
  const CDCWireTopology& wireTopology = CDCWireTopology::getInstance();
 
  const CDCWire& wire = from->getWire();
 
  // Analyse primary neighborhood - sorted such that the wire hits relations are most likely sorted.
  for (short oClockDirection : {5, 7, 3, 9, 1, 11}) {
    MayBePtr<const CDCWire> neighborWire = wireTopology.getPrimaryNeighbor(oClockDirection, wire);
    if (neighborWire) wireNeighbors.emplace_back(neighborWire, oClockDirection);
  }
 
  std::sort(std::begin(wireNeighbors), std::end(wireNeighbors));
 
  for (std::pair<const CDCWire*, int> wireAndOClockDirection : wireNeighbors) {
    const CDCWire* neighborWire = wireAndOClockDirection.first;
    int oClockDirection = wireAndOClockDirection.second;
 
    ConstVectorRange<CDCWireHit*> wireHitRange{
      std::equal_range(wireHits.begin(), wireHits.end(), neighborWire, LessOf<Deref>())};
    if (wireHitRange.empty()) {
      int ccwOClockDirection = oClockDirection - 1;
      int cwOClockDirection = oClockDirection == 11 ? 0 : oClockDirection + 1;
      ++missingPrimaryNeighbor[ccwOClockDirection];
      ++missingPrimaryNeighbor[oClockDirection];
      ++missingPrimaryNeighbor[cwOClockDirection];
    }
    wireHitNeighbors.insert(wireHitNeighbors.end(), wireHitRange.begin(), wireHitRange.end());
  }
 
  size_t nPrimaryWireHitNeighbors = wireHitNeighbors.size();
  wireNeighbors.clear();
 
  // Analyse secondary neighborhood
  for (short oClockDirection : m_consideredSecondaryNeighbors) {
    MayBePtr<const CDCWire> neighborWire = wireTopology.getSecondaryNeighbor(oClockDirection, wire);
    if (not neighborWire) continue;
    if (missingPrimaryNeighbor[oClockDirection] <
        m_missingPrimaryNeighborThresholds[oClockDirection])
      continue;
    wireNeighbors.emplace_back(neighborWire, oClockDirection);
  }
 
  std::sort(std::begin(wireNeighbors), std::end(wireNeighbors));
 
  for (std::pair<const CDCWire*, int> wireAndOClockDirection : wireNeighbors) {
    const CDCWire* neighborWire = wireAndOClockDirection.first;
    ConstVectorRange<CDCWireHit*> wireHitRange{
      std::equal_range(wireHits.begin(), wireHits.end(), neighborWire, LessOf<Deref>())};
    wireHitNeighbors.insert(wireHitNeighbors.end(), wireHitRange.begin(), wireHitRange.end());
  }
 
  std::inplace_merge(wireHitNeighbors.begin(),
                     wireHitNeighbors.begin() + nPrimaryWireHitNeighbors,
                     wireHitNeighbors.end(),
                     std::less<CDCWireHit*>());
 
  return wireHitNeighbors;
}

initialize()

void initialize ( void  )

overridevirtual

Receive signal at the begin of the event processing and prepare some parameters.

Prepare the lookup such that it turns out most likely sorted.

Reimplemented from ProcessingSignalListener.

Definition at line 49 of file BridgingWireHitRelationFilter.cc.

operator()() [1/4]

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 44 of file RelationFilter.icc.h.

operator()() [2/4]

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

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.

operator()() [4/4]

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 51 of file RelationFilter.icc.h.

Member Data Documentation

m_param_missingPrimaryNeighborThresholdMap

std::map<int, int> m_param_missingPrimaryNeighborThresholdMap

private

Initial value:

=
      {{0, 2}, {2, 2}, {4, 2}, {6, 2}, {8, 2}, {10, 2}}

Parameter: A map from o'clock direction to the number of missing primary drift cells.

Definition at line 68 of file BridgingWireHitRelationFilter.h.

---

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

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