ClusterRefiner.h

/**************************************************************************
 * 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.                  *
 **************************************************************************/
#pragma once
 
#include <tracking/trackingUtilities/findlets/base/Findlet.h>
 
#include <tracking/trackingUtilities/eventdata/segments/CDCWireHitCluster.h>
#include <tracking/trackingUtilities/eventdata/hits/CDCWireHit.h>
 
#include <tracking/trackingUtilities/ca/Clusterizer.h>
 
#include <tracking/trackingUtilities/filters/base/RelationFilterUtil.h>
 
#include <tracking/trackingUtilities/utilities/WeightedRelation.h>
 
#include <vector>
#include <string>
#include <algorithm>
 
namespace Belle2 {
  namespace TrackFindingCDC {

    template <class AWireHitRelationFilter>
    class ClusterRefiner : public
      TrackingUtilities::Findlet<const TrackingUtilities::CDCWireHitCluster, TrackingUtilities::CDCWireHitCluster> {
 
    private:
      using Super = TrackingUtilities::Findlet<const TrackingUtilities::CDCWireHitCluster, TrackingUtilities::CDCWireHitCluster>;
 
    public:
      ClusterRefiner()
      {
        this->addProcessingSignalListener(&m_wireHitRelationFilter);
      }

      std::string getDescription() final
      {
        return "Breaks bigger wire hit super cluster into smaller wire hit clusters";
      }

      void exposeParameters(ModuleParamList* moduleParamList, const std::string& prefix) final
      {
        m_wireHitRelationFilter.exposeParameters(moduleParamList, prefix);
      }
 
    public:
      void apply(const std::vector<TrackingUtilities::CDCWireHitCluster>& inputSuperClusters,
                 std::vector<TrackingUtilities::CDCWireHitCluster>& outputClusters) final
      {
        for (const TrackingUtilities::CDCWireHitCluster& superCluster : inputSuperClusters) {
          B2ASSERT("Expect the clusters to be sorted", std::is_sorted(superCluster.begin(),
                                                                      superCluster.end()));
 
          // Obtain the wire hits as pointers
          const std::vector<TrackingUtilities::CDCWireHit*>& wireHitPtrs = superCluster;
 
          // Create the wire hit relations within the supercluster.
          m_wireHitRelations.clear();
          TrackingUtilities::RelationFilterUtil::appendUsing(m_wireHitRelationFilter, wireHitPtrs, m_wireHitRelations);
          const std::size_t nClustersBefore = outputClusters.size();
          m_wireHitClusterizer.apply(superCluster, m_wireHitRelations, outputClusters);
          const std::size_t nClustersAfter = outputClusters.size();
 
          // Update the super cluster id of the just created clusters
          int iSuperCluster = superCluster.getISuperCluster();
          for (std::size_t iCluster = nClustersBefore; iCluster < nClustersAfter; ++iCluster) {
            TrackingUtilities::CDCWireHitCluster& cluster = outputClusters[iCluster];
            cluster.setISuperCluster(iSuperCluster);
            std::sort(cluster.begin(), cluster.end());
          }
        }
      }
 
    private:
      TrackingUtilities::Clusterizer<TrackingUtilities::CDCWireHit, TrackingUtilities::CDCWireHitCluster> m_wireHitClusterizer;

      std::vector<TrackingUtilities::WeightedRelation<TrackingUtilities::CDCWireHit>> m_wireHitRelations;

      AWireHitRelationFilter m_wireHitRelationFilter;
    };
  }
}