WholeWireHitRelationFilter.cc

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
#include <tracking/trackFindingCDC/filters/wireHitRelation/WholeWireHitRelationFilter.h>
 
#include <tracking/trackingUtilities/eventdata/hits/CDCWireHit.h>
 
#include <cdc/topology/CDCWireTopology.h>
#include <cdc/topology/CDCWire.h>
 
#include <tracking/trackingUtilities/filters/base/RelationFilter.icc.h>
 
#include <tracking/trackingUtilities/utilities/StringManipulation.h>
#include <tracking/trackingUtilities/utilities/Functional.h>
 
#include <framework/core/ModuleParamList.templateDetails.h>
 
#include <vector>
#include <string>
#include <cassert>
 
using namespace Belle2;
using namespace CDC;
using namespace TrackFindingCDC;
using namespace TrackingUtilities;
 
template class TrackingUtilities::RelationFilter<const CDCWireHit>;
 
WholeWireHitRelationFilter::WholeWireHitRelationFilter(int neighborhoodDegree)
  : m_param_degree(neighborhoodDegree)
{
}
 
WholeWireHitRelationFilter::~WholeWireHitRelationFilter() = default;
 
void WholeWireHitRelationFilter::exposeParameters(ModuleParamList* moduleParamList,
                                                  const std::string& prefix)
{
  moduleParamList
  ->addParameter(prefixed(prefix, "degree"),
                 m_param_degree,
                 "Neighbor degree which are included. 1 for primary, 2 for secondary, 3 ...",
                 m_param_degree);
}
 
void WholeWireHitRelationFilter::prepare(const std::vector<CDCWireHit*>& wireHits)
{
  m_preparedWires.clear();
  m_preparedWires.reserve(wireHits.size());
  for (const CDCWireHit* wireHit : wireHits) {
    m_preparedWires.push_back(&wireHit->getWire());
  }
  m_preparedWireHitsData = wireHits.data();
  m_preparedWireHitsSize = wireHits.size();
}
 
std::vector<CDCWireHit*> WholeWireHitRelationFilter::getPossibleTos(
  CDCWireHit* from,
  const std::vector<CDCWireHit*>& wireHits) const
{
  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);
 
  // cppcheck-suppress knownConditionTrueFalse ; defensive null check on the wire neighbour lookup
  if (cwWireNeighbor) m_wireNeighbors.push_back(cwWireNeighbor);
  // cppcheck-suppress knownConditionTrueFalse ; defensive null check on the wire neighbour lookup
  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));
 
  // Use the wires precomputed by prepare() when called with the prepared vector.
  // The comparison LessOf<Deref>() used below resolves to operator<(CDCWireHit, CDCWire),
  // which compares the *address* of the wire of the hit with the address of the wire.
  // Searching the precomputed wire addresses therefore evaluates exactly the same
  // predicate on exactly the same values, only without dereferencing the wire hits.
  const bool prepared =
    wireHits.data() == m_preparedWireHitsData and wireHits.size() == m_preparedWireHitsSize;
 
  for (const CDCWire* neighborWire : m_wireNeighbors) {
    ConstVectorRange<CDCWireHit*> neighborWireHits = [&]() -> ConstVectorRange<CDCWireHit*> {
      if (prepared)
      {
        const auto itRange =
        std::equal_range(m_preparedWires.begin(), m_preparedWires.end(), neighborWire);
        return {
          wireHits.begin() + (itRange.first - m_preparedWires.begin()),
          wireHits.begin() + (itRange.second - m_preparedWires.begin())};
      }
      return ConstVectorRange<CDCWireHit*>{
        std::equal_range(wireHits.begin(), wireHits.end(), neighborWire, LessOf<Deref>())
      };
    }();
 
    m_wireHitNeighbors.insert(m_wireHitNeighbors.end(),
                              neighborWireHits.begin(),
                              neighborWireHits.end());
  }
 
  return m_wireHitNeighbors;
}