buildtestMPlex.cc

Go to the documentation of this file.

#include "RecoTracker/MkFitCMS/standalone/buildtestMPlex.h"
#include "RecoTracker/MkFitCore/standalone/ConfigStandalone.h"
#include "RecoTracker/MkFitCore/src/Matrix.h"
#include "RecoTracker/MkFitCore/interface/MkBuilder.h"
#include "RecoTracker/MkFitCMS/interface/MkStdSeqs.h"
#include "RecoTracker/MkFitCMS/standalone/MkStandaloneSeqs.h"

#include "oneapi/tbb/parallel_for.h"

#include <memory>

namespace mkfit {

  inline bool sortByHitsChi2(const std::pair<Track, TrackState> &cand1, const std::pair<Track, TrackState> &cand2) {
    if (cand1.first.nFoundHits() == cand2.first.nFoundHits())
      return cand1.first.chi2() < cand2.first.chi2();

    return cand1.first.nFoundHits() > cand2.first.nFoundHits();
  }

  inline bool sortByPhi(const Hit &hit1, const Hit &hit2) {
    return std::atan2(hit1.y(), hit1.x()) < std::atan2(hit2.y(), hit2.x());
  }

  inline bool sortByEta(const Hit &hit1, const Hit &hit2) { return hit1.eta() < hit2.eta(); }

  inline bool sortTracksByEta(const Track &track1, const Track &track2) { return track1.momEta() < track2.momEta(); }

  inline bool sortTracksByPhi(const Track &track1, const Track &track2) { return track1.momPhi() < track2.momPhi(); }

  struct sortTracksByPhiStruct {
    const std::vector<std::vector<Track>> &m_track_candidates;

    sortTracksByPhiStruct(std::vector<std::vector<Track>> *track_candidates) : m_track_candidates(*track_candidates) {}

    bool operator()(const std::pair<int, int> &track1, const std::pair<int, int> &track2) {
      return m_track_candidates[track1.first][track1.second].posPhi() <
             m_track_candidates[track2.first][track2.second].posPhi();
    }
  };

  // within a layer with a "reasonable" geometry, ordering by Z is the same as eta
  inline bool sortByZ(const Hit &hit1, const Hit &hit2) { return hit1.z() < hit2.z(); }

  //==============================================================================
  // NaN and Silly track parameter check
  //==============================================================================

  namespace {

    int check_nan_n_silly(TrackVec &tracks, const char *prefix) {
      int count = 0;
      for (auto &t : tracks) {
        if (t.hasSillyValues(Const::nan_n_silly_print_bad_cands_bkfit, false, prefix)) {
          ++count;
        }
      }
      return count;
    }

    void check_nan_n_silly_candidates(Event &ev) {
      // MIMI -- nan_n_silly_per_layer_count is in MkBuilder, could be in MkJob.
      // if (Const::nan_n_silly_check_cands_every_layer)
      // {
      //   int sc = (int) ev.nan_n_silly_per_layer_count_;
      //   if (sc > 0)
      //     printf("Nan'n'Silly: Number of silly candidates over all layers = %d\n", sc);
      // }
      if (Const::nan_n_silly_check_cands_pre_bkfit) {
        int sc = check_nan_n_silly(ev.candidateTracks_, "Pre-bkfit silly check");
        if (sc > 0)
          printf("Nan'n'Silly: Number of silly pre-bkfit candidates = %d\n", sc);
      }
    }

    void check_nan_n_silly_bkfit(Event &ev) {
      if (Const::nan_n_silly_check_cands_post_bkfit) {
        int sc = check_nan_n_silly(ev.fitTracks_, "Post-bkfit silly check");
        if (sc > 0)
          printf("Nan'n'Silly: Number of silly post-bkfit candidates = %d\n", sc);
      }
    }

  }  // namespace

  //==============================================================================
  // runBuildTestPlexDumbCMSSW
  //==============================================================================

  void runBuildingTestPlexDumbCMSSW(Event &ev, const EventOfHits &eoh, MkBuilder &builder) {
    const IterationConfig &itconf = Config::ItrInfo[0];

    MkJob job({Config::TrkInfo, itconf, eoh, eoh.refBeamSpot()});

    builder.begin_event(&job, &ev, __func__);

    if (Config::sim_val_for_cmssw) {
      StdSeq::root_val_dumb_cmssw(&ev);
    }

    builder.end_event();
  }

  //==============================================================================
  // runBuildTestPlexBestHit
  //==============================================================================

  double runBuildingTestPlexBestHit(Event &ev, const EventOfHits &eoh, MkBuilder &builder) {
    const IterationConfig &itconf = Config::ItrInfo[0];

    const bool validation_on = (Config::sim_val || Config::quality_val);

    TrackVec seeds1;
    if (validation_on) {
      unsigned int algorithms[] = {4};  //only initialStep

      for (auto const &s : ev.seedTracks_) {
        //keep seeds form the first iteration for processing
        if (std::find(algorithms, algorithms + 1, s.algoint()) != algorithms + 1)
          seeds1.push_back(s);
      }
      ev.seedTracks_.swap(seeds1);  //necessary for the validation - PrepareSeeds
      ev.relabel_bad_seedtracks();  //necessary for the validation - PrepareSeeds
    }

    IterationMaskIfc mask_ifc;

    // To disable hit-masks, pass nullptr in place of &mask_ifc to MkJob ctor
    // and optionally comment out ev.fill_hitmask_bool_vectors() call.

    ev.fill_hitmask_bool_vectors(itconf.m_track_algorithm, mask_ifc.m_mask_vector);

    MkJob job({Config::TrkInfo, itconf, eoh, eoh.refBeamSpot(), &mask_ifc});

    builder.begin_event(&job, &ev, __func__);

    bool seeds_sorted = false;
    // CCCC builder.PrepareSeeds();

    // EventOfCandidates event_of_cands;
    builder.find_tracks_load_seeds_BH(ev.seedTracks_, seeds_sorted);

#ifdef USE_VTUNE_PAUSE
    __SSC_MARK(0x111);  // use this to resume Intel SDE at the same point
    __itt_resume();
#endif

    double time = dtime();

    builder.findTracksBestHit();

    time = dtime() - time;

#ifdef USE_VTUNE_PAUSE
    __itt_pause();
    __SSC_MARK(0x222);  // use this to pause Intel SDE at the same point
#endif

    // Hack, get the tracks out.
    ev.candidateTracks_ = builder.ref_tracks();

    // For best hit, the candidateTracks_ vector is the direct input to the backward fit so only need to do clean_duplicates once
    if (Config::quality_val || Config::sim_val || Config::cmssw_val) {
      //Mark tracks as duplicates; if within CMSSW, remove duplicate tracks before backward fit
      // CCCC if (Config::removeDuplicates) {
      // CCCC   StdSeq::clean_duplicates(ev.candidateTracks_);
      // CCCC }
    }

    job.switch_to_backward();

    // now do backwards fit... do we want to time this section?
    if (Config::backwardFit) {
      builder.backwardFitBH();
      ev.fitTracks_ = builder.ref_tracks();
    }

    if (Config::quality_val) {
      StdSeq::Quality qval;
      qval.quality_val(&ev);
    } else if (Config::sim_val || Config::cmssw_val) {
      StdSeq::root_val(&ev);
    }

    builder.end_event();

    // ev.print_tracks(ev.candidateTracks_, true);

    if (validation_on) {
      ev.seedTracks_.swap(seeds1);
    }

    return time;
  }

  //==============================================================================
  // runBuildTestPlex Combinatorial: Standard TBB
  //==============================================================================

  double runBuildingTestPlexStandard(Event &ev, const EventOfHits &eoh, MkBuilder &builder) {
    const IterationConfig &itconf = Config::ItrInfo[0];

    const bool validation_on = (Config::sim_val || Config::quality_val);

    TrackVec seeds1;
    if (validation_on) {
      unsigned int algorithms[] = {4};  //only initialStep

      for (auto const &s : ev.seedTracks_) {
        //keep seeds form the first iteration for processing
        if (std::find(algorithms, algorithms + 1, s.algoint()) != algorithms + 1)
          seeds1.push_back(s);
      }
      ev.seedTracks_.swap(seeds1);  //necessary for the validation - PrepareSeeds
      ev.relabel_bad_seedtracks();  //necessary for the validation - PrepareSeeds
    }

    IterationMaskIfc mask_ifc;

    // To disable hit-masks, pass nullptr in place of &mask_ifc to MkJob ctor
    // and optionally comment out ev.fill_hitmask_bool_vectors() call.

    ev.fill_hitmask_bool_vectors(itconf.m_track_algorithm, mask_ifc.m_mask_vector);

    MkJob job({Config::TrkInfo, itconf, eoh, eoh.refBeamSpot(), &mask_ifc});

    builder.begin_event(&job, &ev, __func__);

    bool seeds_sorted = false;
    // CCCC builder.PrepareSeeds();
    ev.setCurrentSeedTracks(ev.seedTracks_);

    builder.find_tracks_load_seeds(ev.seedTracks_, seeds_sorted);

#ifdef USE_VTUNE_PAUSE
    __SSC_MARK(0x111);  // use this to resume Intel SDE at the same point
    __itt_resume();
#endif

    double time = dtime();

    builder.findTracksStandard();

    time = dtime() - time;

#ifdef USE_VTUNE_PAUSE
    __itt_pause();
    __SSC_MARK(0x222);  // use this to pause Intel SDE at the same point
#endif

    check_nan_n_silly_candidates(ev);

    // first store candidate tracks
    ev.candidateTracks_.clear();
    builder.export_best_comb_cands(ev.candidateTracks_);

    job.switch_to_backward();

    // now do backwards fit... do we want to time this section?
    if (Config::backwardFit) {
      // Using the TrackVec version until we home in on THE backward fit etc.
      // builder.backwardFit();
      builder.select_best_comb_cands();
      builder.backwardFitBH();
      ev.fitTracks_ = builder.ref_tracks();

      check_nan_n_silly_bkfit(ev);
    }

    // CCCC StdSeq::handle_duplicates(&ev);

    if (Config::quality_val) {
      StdSeq::Quality qval;
      qval.quality_val(&ev);
    } else if (Config::sim_val || Config::cmssw_val) {
      StdSeq::root_val(&ev);
    }

    ev.resetCurrentSeedTracks();

    builder.end_event();

    // ev.print_tracks(ev.candidateTracks_, true);

    if (validation_on) {
      ev.seedTracks_.swap(seeds1);
    }

    return time;
  }

  //==============================================================================
  // runBuildTestPlex Combinatorial: CloneEngine TBB
  //==============================================================================

  double runBuildingTestPlexCloneEngine(Event &ev, const EventOfHits &eoh, MkBuilder &builder) {
    const IterationConfig &itconf = Config::ItrInfo[0];

    const bool validation_on = (Config::sim_val || Config::quality_val);

    TrackVec seeds1;
    if (validation_on) {
      unsigned int algorithms[] = {4};  //only initialStep

      for (auto const &s : ev.seedTracks_) {
        //keep seeds form the first iteration for processing
        if (std::find(algorithms, algorithms + 1, s.algoint()) != algorithms + 1)
          seeds1.push_back(s);
      }
      ev.seedTracks_.swap(seeds1);  //necessary for the validation - PrepareSeeds
      ev.relabel_bad_seedtracks();  //necessary for the validation - PrepareSeeds
    }

    IterationMaskIfc mask_ifc;

    // To disable hit-masks, pass nullptr in place of &mask_ifc to MkJob ctor
    // and optionally comment out ev.fill_hitmask_bool_vectors() call.

    ev.fill_hitmask_bool_vectors(itconf.m_track_algorithm, mask_ifc.m_mask_vector);

    MkJob job({Config::TrkInfo, itconf, eoh, eoh.refBeamSpot(), &mask_ifc});

    builder.begin_event(&job, &ev, __func__);

    bool seeds_sorted = false;
    // CCCC builder.PrepareSeeds();
    ev.setCurrentSeedTracks(ev.seedTracks_);

    builder.find_tracks_load_seeds(ev.seedTracks_, seeds_sorted);

#ifdef USE_VTUNE_PAUSE
    __SSC_MARK(0x111);  // use this to resume Intel SDE at the same point
    __itt_resume();
#endif

    double time = dtime();

    builder.findTracksCloneEngine();

    time = dtime() - time;

#ifdef USE_VTUNE_PAUSE
    __itt_pause();
    __SSC_MARK(0x222);  // use this to pause Intel SDE at the same point
#endif

    check_nan_n_silly_candidates(ev);

    // first store candidate tracks - needed for BH backward fit and root_validation
    ev.candidateTracks_.clear();
    builder.export_best_comb_cands(ev.candidateTracks_);

    job.switch_to_backward();

    // now do backwards fit... do we want to time this section?
    if (Config::backwardFit) {
      // a) TrackVec version:
      builder.select_best_comb_cands();
      builder.backwardFitBH();
      ev.fitTracks_ = builder.ref_tracks();

      // b) Version that runs on CombCand / TrackCand
      // builder.backwardFit();
      // builder.quality_store_tracks(ev.fitTracks_);

      check_nan_n_silly_bkfit(ev);
    }

    // CCCC StdSeq::handle_duplicates(&ev);

    // validation section
    if (Config::quality_val) {
      StdSeq::Quality qval;
      qval.quality_val(&ev);
    } else if (Config::sim_val || Config::cmssw_val) {
      StdSeq::root_val(&ev);
    }

    ev.resetCurrentSeedTracks();

    builder.end_event();

    // ev.print_tracks(ev.candidateTracks_, true);

    if (validation_on) {
      ev.seedTracks_.swap(seeds1);
    }

    return time;
  }

  //==============================================================================
  // runBtpCe_MultiIter
  //
  // Prototype for running multiple iterations, sequentially, using the same builder.
  // For cmmsw seeds
  //
  // There is, in general, a mess in how tracks are processed, marked, or copied out
  // in various validation scenarios and export flags.
  //
  // In particular, MkBuilder::PrepareSeeds does a lot of things to whole / complete
  // event,seedTracks_ -- probably this would need to be split into common / and
  // per-iteration part.
  // - MkBuilder::prep_*** functions also mostly do not belong there (prep_sim is called from
  //   PrepareSeeds() for cmssw seeds).
  //
  // At this point we need to think about what should happen to Event before all the iterations and
  // after all the iterations ... from the Validation perspective.
  // And if we care about doing too muich work for seeds that will never get processed.
  //==============================================================================

  namespace {
    constexpr unsigned int algorithms[] = {4, 22, 23, 5, 24, 7, 8, 9, 10, 6};  //9 iterations
  }

  std::vector<double> runBtpCe_MultiIter(Event &ev, const EventOfHits &eoh, MkBuilder &builder, int n) {
    std::vector<double> timevec;
    if (n <= 0)
      return timevec;
    timevec.resize(n + 1, 0.0);

    const bool validation_on = (Config::sim_val || Config::quality_val);

    TrackVec seeds_used;
    TrackVec seeds1;

    if (validation_on) {
      for (auto const &s : ev.seedTracks_) {
        //keep seeds form the first n iterations for processing
        if (std::find(algorithms, algorithms + n, s.algoint()) != algorithms + n)
          seeds1.push_back(s);
      }
      ev.seedTracks_.swap(seeds1);  //necessary for the validation - PrepareSeeds
      ev.relabel_bad_seedtracks();  //necessary for the validation - PrepareSeeds
    }

    IterationMaskIfc mask_ifc;
    TrackVec seeds;
    TrackVec tmp_tvec;

    for (int it = 0; it <= n - 1; ++it) {
      const IterationConfig &itconf = Config::ItrInfo[it];

      // To disable hit-masks, pass nullptr in place of &mask_ifc to MkJob ctor
      // and optionally comment out ev.fill_hitmask_bool_vectors() call.

      ev.fill_hitmask_bool_vectors(itconf.m_track_algorithm, mask_ifc.m_mask_vector);

      MkJob job({Config::TrkInfo, itconf, eoh, eoh.refBeamSpot(), &mask_ifc});

      builder.begin_event(&job, &ev, __func__);

      {  // We could partition seeds once, store beg, end for each iteration in a map or vector.
        seeds.clear();
        int nc = 0;
        for (auto &s : ev.seedTracks_) {
          if (s.algoint() == itconf.m_track_algorithm) {
            if (itconf.m_requires_seed_hit_sorting) {
              s.sortHitsByLayer();
            }
            seeds.push_back(s);
            ++nc;
          } else if (nc > 0)
            break;
        }
      }

      bool do_seed_clean = bool(itconf.m_seed_cleaner);

      if (do_seed_clean)
        itconf.m_seed_cleaner(seeds, itconf, eoh.refBeamSpot());

      builder.seed_post_cleaning(seeds);

      // Add protection in case no seeds are found for iteration
      if (seeds.size() <= 0)
        continue;
      ev.setCurrentSeedTracks(seeds);

      builder.find_tracks_load_seeds(seeds, do_seed_clean);

      double time = dtime();

      builder.findTracksCloneEngine();

      timevec[it] = dtime() - time;
      timevec[n] += timevec[it];

      // Print min and max size of hots vectors of CombCands.
      // builder.find_min_max_hots_size();

      if (validation_on)
        seeds_used.insert(seeds_used.end(), seeds.begin(), seeds.end());  //cleaned seeds need to be stored somehow

      // Pre backward-fit filtering.
      // Note -- slightly different logic than run_OneIteration as we always do nan filters for
      // export for validation.
      filter_candidates_func pre_filter;
      if (itconf.m_pre_bkfit_filter)
        pre_filter = [&](const TrackCand &tc, const MkJob &jb) -> bool {
          return itconf.m_pre_bkfit_filter(tc, jb) && StdSeq::qfilter_nan_n_silly<TrackCand>(tc, jb);
        };
      else
        pre_filter = StdSeq::qfilter_nan_n_silly<TrackCand>;
      // pre_filter is always at least doing nan_n_silly filter.
      builder.filter_comb_cands(pre_filter, true);

      builder.select_best_comb_cands();

      {
        builder.export_tracks(tmp_tvec);
        if (itconf.m_duplicate_cleaner)
          itconf.m_duplicate_cleaner(builder.ref_tracks_nc(), itconf);
        ev.candidateTracks_.reserve(ev.candidateTracks_.size() + tmp_tvec.size());
        for (auto &&t : tmp_tvec)
          ev.candidateTracks_.emplace_back(std::move(t));
        tmp_tvec.clear();
      }

      job.switch_to_backward();

      // now do backwards fit... do we want to time this section?
      if (Config::backwardFit) {
        // a) TrackVec version:
        // builder.backwardFitBH();

        // b) Version that runs on CombCand / TrackCand
        const bool do_backward_search = Config::backwardSearch && itconf.m_backward_search;

        // We copy seed-hits into Candidates ... now we have to remove them so backward fit stops
        // before reaching seeding region. Ideally, we wouldn't add them in the first place but
        // if we want to export full tracks above we need to hold on to them (alternatively, we could
        // have a pointer to seed track in CombCandidate and copy them from there).
        if (do_backward_search)
          builder.compactifyHitStorageForBestCand(itconf.m_backward_drop_seed_hits, itconf.m_backward_fit_min_hits);

        builder.backwardFit();

        if (do_backward_search) {
          builder.beginBkwSearch();
          builder.findTracksCloneEngine(SteeringParams::IT_BkwSearch);
        }

        // Post backward-fit filtering.
        // Note -- slightly different logic than run_OneIteration as we export both pre and post
        // backward-fit tracks.
        filter_candidates_func post_filter;
        if (itconf.m_post_bkfit_filter)
          post_filter = [&](const TrackCand &tc, const MkJob &jb) -> bool {
            return itconf.m_post_bkfit_filter(tc, jb) && StdSeq::qfilter_nan_n_silly<TrackCand>(tc, jb);
          };
        else
          post_filter = StdSeq::qfilter_nan_n_silly<TrackCand>;
        // post_filter is always at least doing nan_n_silly filter.
        builder.filter_comb_cands(post_filter, true);

        if (do_backward_search)
          builder.endBkwSearch();

        builder.select_best_comb_cands(true);  // true -> clear m_tracks as they were already filled once above

        if (itconf.m_duplicate_cleaner)
          itconf.m_duplicate_cleaner(builder.ref_tracks_nc(), itconf);

        builder.export_tracks(ev.fitTracks_);
      }
      ev.resetCurrentSeedTracks();

      builder.end_event();
    }

    // MIMI - Fake back event pointer for final processing (that should be done elsewhere)
    MkJob job({Config::TrkInfo, Config::ItrInfo[0], eoh, eoh.refBeamSpot()});
    builder.begin_event(&job, &ev, __func__);

    if (validation_on) {
      StdSeq::prep_simtracks(&ev);
      //swap for the cleaned seeds
      ev.seedTracks_.swap(seeds_used);
    }

    check_nan_n_silly_candidates(ev);

    if (Config::backwardFit)
      check_nan_n_silly_bkfit(ev);

    // validation section
    if (Config::quality_val) {
      StdSeq::Quality qval;
      qval.quality_val(&ev);
    } else if (Config::sim_val || Config::cmssw_val) {
      StdSeq::root_val(&ev);
    }

    // ev.print_tracks(ev.candidateTracks_, true);

    // MIMI Unfake.
    builder.end_event();

    // In CMSSW runOneIter we now release memory for comb-cands:
    builder.release_memory();

    return timevec;
  }

}  // end namespace mkfit