AxialTrackFinderHough.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/findlets/combined/AxialTrackFinderHough.h>
 
#include <tracking/trackingUtilities/eventdata/tracks/CDCTrack.h>
#include <tracking/trackingUtilities/eventdata/hits/CDCWireHit.h>
 
#include <tracking/trackingUtilities/utilities/StringManipulation.h>
 
#include <framework/core/ModuleParamList.templateDetails.h>
#include <framework/core/ModuleParam.h>
 
using namespace Belle2;
using namespace TrackFindingCDC;
using namespace TrackingUtilities;
 
AxialTrackFinderHough::AxialTrackFinderHough()
  : Super()
{
  addProcessingSignalListener(&m_fineHoughSearch);
  addProcessingSignalListener(&m_roughHoughSearch);
  addProcessingSignalListener(&m_axialTrackHitMigrator);
  addProcessingSignalListener(&m_axialTrackMerger);
 
  // Set default parameters of the hough spaces
 
  ModuleParamList moduleParamList;
  const std::string prefix = "";
  this->exposeParameters(&moduleParamList, prefix);
 
  // Setup the default parameters of the fine hough space
  moduleParamList.getParameter<int>("fineGranularityLevel").setDefaultValue(12);
  moduleParamList.getParameter<int>("fineSectorLevelSkip").setDefaultValue(2);
  // moduleParamList.getParameter<std::vector<double>>("fineCurvBounds").setDefaultValue({ -0.018, 0.75});
  moduleParamList.getParameter<std::vector<float>>("fineCurvBounds").setDefaultValue({{ -0.02, 0.14}});
  moduleParamList.getParameter<int>("fineDiscretePhi0Width").setDefaultValue(19);
  moduleParamList.getParameter<int>("fineDiscretePhi0Overlap").setDefaultValue(5);
  moduleParamList.getParameter<int>("fineDiscreteCurvWidth").setDefaultValue(1);
  moduleParamList.getParameter<int>("fineDiscreteCurvOverlap").setDefaultValue(-1);
  moduleParamList.getParameter<std::vector<ParameterVariantMap>>("fineRelaxationSchedule")
                                                              .setDefaultValue(getDefaultFineRelaxationSchedule());
 
  // Setup the default parameters of the rough hough space
  moduleParamList.getParameter<int>("roughGranularityLevel").setDefaultValue(10);
  moduleParamList.getParameter<int>("roughSectorLevelSkip").setDefaultValue(0);
  moduleParamList.getParameter<std::vector<float>>("roughCurvBounds").setDefaultValue({{ 0.0, 0.30}});
  moduleParamList.getParameter<int>("roughDiscretePhi0Width").setDefaultValue(19);
  moduleParamList.getParameter<int>("roughDiscretePhi0Overlap").setDefaultValue(5);
  moduleParamList.getParameter<int>("roughDiscreteCurvWidth").setDefaultValue(1);
  moduleParamList.getParameter<int>("roughDiscreteCurvOverlap").setDefaultValue(-1);
  moduleParamList.getParameter<std::vector<ParameterVariantMap>>("roughRelaxationSchedule")
                                                              .setDefaultValue(getDefaultRoughRelaxationSchedule());
}
 
std::string AxialTrackFinderHough::getDescription()
{
  return "Generates axial tracks from hits using several increasingly relaxed hough space search over phi0 and curvature.";
}
 
void AxialTrackFinderHough::exposeParameters(ModuleParamList* moduleParamList,
                                             const std::string& prefix)
{
  m_fineHoughSearch.exposeParameters(moduleParamList, prefixed("fine", prefix));
  m_roughHoughSearch.exposeParameters(moduleParamList, prefixed("rough", prefix));
  m_axialTrackHitMigrator.exposeParameters(moduleParamList, prefix);
  m_axialTrackMerger.exposeParameters(moduleParamList, prefixed("merge", prefix));
}
 
void AxialTrackFinderHough::apply(const std::vector<CDCWireHit>& wireHits,
                                  std::vector<CDCTrack>& tracks)
{
  // Acquire the axial hits
  std::vector<const CDCWireHit*> axialWireHits;
  axialWireHits.reserve(wireHits.size());
  for (const CDCWireHit& wireHit : wireHits) {
    wireHit->unsetTemporaryFlags();
    wireHit->unsetMaskedFlag();
    if (not wireHit.isAxial()) continue;
    if (wireHit->hasBackgroundFlag()) continue;
    axialWireHits.emplace_back(&wireHit);
  }
 
  // Fine hough search
  m_fineHoughSearch.apply(axialWireHits, tracks);
 
  // One step of migrating hits between the already found tracks
  m_axialTrackHitMigrator.apply(axialWireHits, tracks);
 
  // Rough hough search
  m_roughHoughSearch.apply(axialWireHits, tracks);
 
  // One step of migrating hits between the already found tracks
  m_axialTrackHitMigrator.apply(axialWireHits, tracks);
 
  // Do track merging and finalization steps
  m_axialTrackMerger.apply(tracks, axialWireHits);
 
  // Last step of migrating hits between the already found tracks
  m_axialTrackHitMigrator.apply(axialWireHits, tracks);
 
}
 
std::vector<ParameterVariantMap>
AxialTrackFinderHough::getDefaultFineRelaxationSchedule() const
{
  std::vector<ParameterVariantMap> result;
  // Relaxation schedule of the original hough implementation
  // Augmented by the road search parameters
  // Note: distinction between integer and double literals is essential
  // For the record: the setting seem a bit non-sensical, but work kind of well, experimentation needed.
 
  // NonCurler pass
  result.push_back(ParameterVariantMap{
    {"maxLevel", 10},
    {"minWeight", 50.0},
    {"maxCurv", 1.0 * 0.02},
    {"curvResolution", std::string("origin")},
    {"nRoadSearches", 1},
    {"roadLevel", 1},
  });
 
  result.push_back(ParameterVariantMap{
    {"maxLevel", 10},
    {"minWeight", 70.0},
    {"maxCurv", 2.0 * 0.02},
    {"curvResolution", std::string("origin")},
    {"nRoadSearches", 1},
    {"roadLevel", 1},
  });
 
  for (double minWeight = 50.0; minWeight > 10.0; minWeight *= 0.75) {
    result.push_back(ParameterVariantMap{
      {"maxLevel", 10},
      {"minWeight", minWeight},
      {"maxCurv", 0.07},
      {"curvResolution", std::string("origin")},
      {"nRoadSearches", 1},
      {"roadLevel", 1},
    });
  }
 
  // NonCurlerWithIncreasedThreshold pass
  result.push_back(ParameterVariantMap{
    {"maxLevel", 8},
    {"minWeight", 50.0},
    {"maxCurv", 1.0 * 0.02},
    {"curvResolution", std::string("nonOrigin")},
    {"nRoadSearches", 2},
    {"roadLevel", 1},
  });
 
  result.push_back(ParameterVariantMap{
    {"maxLevel", 8},
    {"minWeight", 70.0},
    {"maxCurv", 2.0 * 0.02},
    {"curvResolution", std::string("nonOrigin")},
    {"nRoadSearches", 2},
    {"roadLevel", 1},
  });
 
  result.push_back(ParameterVariantMap{
    {"maxLevel", 8},
    {"minWeight", 50.0},
    {"maxCurv", 0.07},
    {"curvResolution", std::string("nonOrigin")},
    {"nRoadSearches", 2},
    {"roadLevel", 1},
  });
 
  for (double minWeight = 37.5; minWeight > 10.0; minWeight *= 0.75) {
    result.push_back(ParameterVariantMap{
      {"maxLevel", 8},
      {"minWeight", minWeight},
      {"maxCurv",  m_maxCurvAcceptance},
      {"curvResolution", std::string("nonOrigin")},
      {"nRoadSearches", 2},
      {"roadLevel", 1},
    });
  }
 
  return result;
}
 
std::vector<ParameterVariantMap>
AxialTrackFinderHough::getDefaultRoughRelaxationSchedule() const
{
  std::vector<ParameterVariantMap> result;
 
  // FullRange pass
  result.push_back(ParameterVariantMap{
    {"maxLevel", 10},
    {"minWeight", 50.0},
    {"maxCurv", 1.0 * 0.02},
    {"curvResolution", std::string("nonOrigin")},
    {"nRoadSearches", 3},
    {"roadLevel", 0},
  });
 
  result.push_back(ParameterVariantMap{
    {"maxLevel", 10},
    {"minWeight", 70.0},
    {"maxCurv", 2.0 * 0.02},
    {"curvResolution", std::string("nonOrigin")},
    {"nRoadSearches", 3},
    {"roadLevel", 0},
  });
 
  for (double minWeight = 30.0; minWeight > 10.0; minWeight *= 0.75) {
    result.push_back(ParameterVariantMap{
      {"maxLevel", 10},
      {"minWeight", minWeight},
      {"maxCurv", 0.15},
      {"curvResolution", std::string("nonOrigin")},
      {"nRoadSearches", 3},
      {"roadLevel", 0},
    });
  }
 
  return result;
}