SuperClusterCreator Class Reference

Refines the clustering of wire hits from clusters to clusters. More...

#include <SuperClusterCreator.h>

Inheritance diagram for SuperClusterCreator:

Collaboration diagram for SuperClusterCreator:

Public Types
using	IOTypes = std::tuple< AIOTypes... >
	Types that should be served to apply on invokation.
using	IOVectors = std::tuple< std::vector< AIOTypes >... >
	Vector types that should be served to apply on invokation.

Public Member Functions
	SuperClusterCreator ()
	Constructor.
std::string	getDescription () final
	Short description of the findlet.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
	Expose the parameters to a module.
void	apply (std::vector< CDCWireHit > &inputWireHits, std::vector< CDCWireHitCluster > &outputSuperClusters) final
	Main algorithm applying the cluster refinement. More...
virtual void	apply (ToVector< AIOTypes > &... ioVectors)=0
	Main function executing the algorithm.
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 Types
using	ToVector = typename ToVectorImpl< T >::Type
	Short hand for ToRangeImpl.

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 = Findlet< CDCWireHit, CDCWireHitCluster >
	Type of the base class.

Private Attributes
bool	m_param_expandOverApogeeGap = false
	Parameter : Expand the super clusters over the typical gap at the apogee of the trajectory.
Clusterizer< CDCWireHit, CDCWireHitCluster >	m_wirehitClusterizer
	Instance of the hit cluster generator.
std::vector< WeightedRelation< CDCWireHit > >	m_wireHitRelations
	Memory for the wire hit neighborhood in a cluster.
WholeWireHitRelationFilter	m_wireHitRelationFilter {2}
	Wire hit neighborhood relation filter.
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

Refines the clustering of wire hits from clusters to clusters.

Definition at line 31 of file SuperClusterCreator.h.

Member Function Documentation

apply()

void apply ( std::vector< CDCWireHit > &  inputWireHits, std::vector< CDCWireHitCluster > &  outputSuperClusters  )

final

Main algorithm applying the cluster refinement.

Obtain the wire hits as pointers

Create the wire hit relations

Definition at line 48 of file SuperClusterCreator.cc.

{
  m_wireHitRelations.clear();
 
  if (m_param_expandOverApogeeGap) {
    auto wireHitsByLayer =
    adjacent_groupby(inputWireHits.begin(), inputWireHits.end(), [](const CDCWireHit & wireHit) {
      return wireHit.getWireID().getILayer();
    });
 
    for (const auto& wireHitsInLayer : wireHitsByLayer) {
      const CDCWireLayer& wireLayer = wireHitsInLayer.front().getWire().getWireLayer();
      const int nWires = wireLayer.size();
 
      auto sameWireHitChain = [](const CDCWireHit & lhs, const CDCWireHit & rhs) {
        return rhs.getWireID().getIWire() - lhs.getWireID().getIWire() == 1;
      };
 
      auto wireHitChains =
        unique_ranges(wireHitsInLayer.begin(), wireHitsInLayer.end(), sameWireHitChain);
 
      size_t nWireHits = 0;
      for (const VectorRange<CDCWireHit>& wireHitChain : wireHitChains) {
        nWireHits += wireHitChain.size();
      }
      assert(nWireHits == wireHitsInLayer.size());
 
      // Special treatment for the first and last wireHitChain as they might wrap around as one
      VectorRange<CDCWireHit> frontWrapChain(wireHitsInLayer.begin(), wireHitsInLayer.begin());
      VectorRange<CDCWireHit> backWrapChain(wireHitsInLayer.end(), wireHitsInLayer.end());
      if (wireHitChains.size() > 1) {
        if (wireHitChains.front().front().getWire().isPrimaryNeighborWith(
              wireHitChains.back().back().getWire())) {
          // Chains are touching
          // Keep their information around but eliminate them from the regular chains
          int wrapAroundChainSize = wireHitChains.front().size() + wireHitChains.back().size();
          if (wrapAroundChainSize >= 5) {
            // Warning reach over the local wire hit layer / outside the memory of the wire hit
            // vector to transport the size.
            frontWrapChain = wireHitChains.front();
            frontWrapChain.first = frontWrapChain.end() - wrapAroundChainSize;
 
            backWrapChain = wireHitChains.back();
            backWrapChain.second = backWrapChain.begin() + wrapAroundChainSize;
 
            wireHitChains.erase(wireHitChains.begin());
            wireHitChains.pop_back();
          }
        }
      }
 
      auto itLastChain = std::remove_if(wireHitChains.begin(), wireHitChains.end(), Size() < 5u);
      wireHitChains.erase(itLastChain, wireHitChains.end());
      if (wireHitChains.empty()) continue;
 
      auto connectWireHitChains = [this, nWires](const VectorRange<CDCWireHit>& lhs,
      const VectorRange<CDCWireHit>& rhs) {
        int iWireDelta = rhs.front().getWireID().getIWire() - lhs.back().getWireID().getIWire();
        if (iWireDelta < 0) iWireDelta += nWires;
        if (iWireDelta < static_cast<int>(lhs.size() + rhs.size())) {
          m_wireHitRelations.push_back({&rhs.front(), 0, &lhs.back()});
          m_wireHitRelations.push_back({&lhs.back(), 0, &rhs.front()});
        }
        return false;
      };
      // the return value is not needed
      // cppcheck-suppress ignoredReturnValue
      std::adjacent_find(wireHitChains.begin(), wireHitChains.end(), connectWireHitChains);
 
      if (not frontWrapChain.empty()) {
        connectWireHitChains(frontWrapChain, wireHitChains.front());
      }
      if (not backWrapChain.empty()) {
        connectWireHitChains(wireHitChains.back(), backWrapChain);
      }
      if (backWrapChain.empty() and frontWrapChain.empty()) {
        connectWireHitChains(wireHitChains.back(), wireHitChains.front());
      }
    }
  }
 
  const std::vector<CDCWireHit*> wireHitPtrs = as_pointers<CDCWireHit>(inputWireHits);
 
  RelationFilterUtil::appendUsing(m_wireHitRelationFilter, wireHitPtrs, m_wireHitRelations);
 
  B2ASSERT("Expect wire hit neighborhood to be symmetric ",
           WeightedRelationUtil<CDCWireHit>::areSymmetric(m_wireHitRelations));
 
  m_wirehitClusterizer.apply(wireHitPtrs, m_wireHitRelations, outputSuperClusters);
 
  int iSuperCluster = -1;
  for (CDCWireHitCluster& superCluster : outputSuperClusters) {
    ++iSuperCluster;
    superCluster.setISuperCluster(iSuperCluster);
    for (CDCWireHit* wireHit : superCluster) {
      wireHit->setISuperCluster(iSuperCluster);
    }
    std::sort(superCluster.begin(), superCluster.end());
  }
}

---

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

• tracking/trackFindingCDC/findlets/minimal/include/SuperClusterCreator.h
• tracking/trackFindingCDC/findlets/minimal/src/SuperClusterCreator.cc