StepUtils.h

Go to the documentation of this file.

//
//
// StepUtils - Core stepping algorithms
//
// Bruce Baller
//
#ifndef STEPUTILS_H
#define STEPUTILS_H

#include "larreco/RecoAlg/TCAlg/Utils.h"

// C/C++ standard libraries
#include <array>
#include <vector>
#include <utility> // std::pair<>
#include <cmath>
#include <iostream>
#include <fstream>
#include <iomanip>
#include <algorithm>

#include "messagefacility/MessageLogger/MessageLogger.h"

// LArSoft libraries
#include "larcoreobj/SimpleTypesAndConstants/geo_types.h"
#include "larevt/CalibrationDBI/Interface/ChannelStatusService.h"
#include "larevt/CalibrationDBI/Interface/ChannelStatusProvider.h"
#include "lardataobj/RecoBase/Hit.h"
#include "larreco/RecoAlg/TCAlg/DebugStruct.h"
#include "larreco/RecoAlg/TCAlg/TCShower.h"
#include "larreco/RecoAlg/TCAlg/TCVertex.h"
#include "larreco/RecoAlg/TCAlg/PFPUtils.h"

namespace tca {
  
  // Main stepping/crawling routine
  void StepAway(TCSlice& slc, Trajectory& tj);
  void SetStrategy(TCSlice& slc, Trajectory& tj);
  void Forecast(TCSlice& slc, Trajectory& tj);
  // Updates the last added trajectory point fit, average hit rms, etc.
  void UpdateTraj(TCSlice& slc, Trajectory& tj);
  // Version with a different strategy for tracking high energy electrons
  void UpdateStiffEl(TCSlice& slc, Trajectory& tj);
  // Check the quality of the trajectory and possibly trim it
  void CheckTraj(TCSlice& slc, Trajectory& tj);
  void CheckStiffEl(TCSlice& slc, Trajectory& tj);
  // Add hits on the trajectory point ipt that are close to the trajectory point Pos
  void AddHits(TCSlice& slc, Trajectory& tj, unsigned short ipt, bool& sigOK);
  // Large Angle version
  void AddLAHits(TCSlice& slc, Trajectory& tj, unsigned short ipt, bool& sigOK);
  // Try to use unused nearby hits in all trajectories after stepping is done
//  void UseUnusedHits(TCSlice& slc);
  // Step through TPs starting at the end and moving to the beginning
  void ReversePropagate(TCSlice& slc, Trajectory& tj);
  void GetHitMultiplet(TCSlice& slc, unsigned int theHit, std::vector<unsigned int>& hitsInMultiplet);
  void GetHitMultiplet(TCSlice& slc, unsigned int theHit, std::vector<unsigned int>& hitsInMultiplet, unsigned short& localIndex);
  // Returns fHits[iht]->RMS() * fScaleF * fHitErrFac * fHits[iht]->Multiplicity();
  float HitTimeErr(TCSlice& slc, const unsigned int iht);
  // Estimates the error^2 of the time using all hits in hitVec
  float HitsTimeErr2(TCSlice& slc, const std::vector<unsigned int>& hitVec);
  // defines HitPos, HitPosErr2 and Chg for the used hits in the trajectory point
  void ChkStopEndPts(TCSlice& slc, Trajectory& tj, bool prt);
  void DefineHitPos(TCSlice& slc, TrajPoint& tp);
  // Decide which hits to use to determine the trajectory point
  // fit, charge, etc. This is done by setting UseHit true and
  // setting inTraj < 0
  void FindUseHits(TCSlice& slc, Trajectory& tj, unsigned short ipt, float maxDelta, bool useChg);
  // Truncates the trajectory if a soft kink is found in it
  void FindSoftKink(TCSlice& slc, Trajectory& tj);
  // Fill gaps in the trajectory
  void FillGaps(TCSlice& slc, Trajectory& tj);
  // Check for many unused hits and try to use them
  void CheckHiMultUnusedHits(TCSlice& slc, Trajectory& tj);
  void CheckHiMultEndHits(TCSlice& slc, Trajectory& tj);
  // Check for high values of Delta at the beginning of the trajectory
  void HiEndDelta(TCSlice& slc, Trajectory& tj);

  // Estimate the Delta RMS of the TPs on the end of tj.
  void UpdateDeltaRMS(TCSlice& slc, Trajectory& tj);
  void MaskBadTPs(TCSlice& slc, Trajectory& tj, float const& maxChi);
  // The hits in the TP at the end of the trajectory were masked off. Decide whether to continue stepping with the
  // current configuration or whether to stop and possibly try with the next pass settings
  bool MaskedHitsOK(TCSlice& slc, Trajectory& tj);
  // Any re-sizing should have been done by the calling routine. This code updates the Pass and adjusts the number of
  // fitted points to get FitCHi < 2
  bool StopIfBadFits(TCSlice& slc, Trajectory& tj);
  // Does a local fit of just-added TPs to identify a kink while stepping.
  // Truncates the vector and returns true if one is found.
  void GottaKink(TCSlice& slc, Trajectory& tj, unsigned short& killPts);
  // Update the parameters at the beginning of the trajectory
  void FixTrajBegin(TCSlice& slc, Trajectory& tj);
  void FixTrajBegin(TCSlice& slc, Trajectory& tj, unsigned short atPt);
  void FixTrajEnd(TCSlice& slc, Trajectory& tj, unsigned short atPt);
  bool IsGhost(TCSlice& slc, std::vector<unsigned int>& tHits);
  bool IsGhost(TCSlice& slc, Trajectory& tj);
  void EndMerge(TCSlice& slc, CTP_t inCTP, bool lastPass);
  void MaskTrajEndPoints(TCSlice& slc, Trajectory& tj, unsigned short nPts);
  // Sets the StopsAtEnd bits for the trajectory
  void ChkStop(TCSlice& slc, Trajectory& tj);
  // Check the Michel electron topology, lastGoodPt is the last point of muon
  bool ChkMichel(TCSlice& slc, Trajectory& tj, unsigned short& lastGoodPt);
  // TY: Split high charge hits near the trajectory end
  void ChkHiChgHits(TCSlice& slc, CTP_t inCTP);
  void SplitHiChgHits(TCSlice& slc, Trajectory& tj);
  // Make a junk trajectory using the list of hits in tHits
  bool MakeJunkTraj(TCSlice& slc, std::vector<unsigned int> tHits);
} // namespace tca

#endif // ifndef STEPUTILS_H