GPUTRDTracker.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
 
 
#ifndef GPUTRDTRACKER_H
#define GPUTRDTRACKER_H
 
#include "GPUCommonDef.h"
#include "GPUProcessor.h"
#include "GPUTRDDef.h"
#include "GPUDef.h"
#include "GPUTRDTrack.h"
#include "GPUTRDSpacePoint.h"
#include "GPULogging.h"
#include "GPUTRDInterfaces.h"
 
#ifndef GPUCA_GPUCODE_DEVICE
#include <vector>
#endif
 
namespace o2::gpu
{
 
class GPUTRDTrackletWord;
class GPUTRDGeometry;
class GPUChainTracking;
template <class T>
class GPUTRDTrackerDebug;
class GPUTRDRecoParam;
 
//-------------------------------------------------------------------------
template <class TRDTRK, class PROP>
class GPUTRDTracker_t : public GPUProcessor
{
 public:
#ifndef GPUCA_GPUCODE
  GPUTRDTracker_t();
  GPUTRDTracker_t(const GPUTRDTracker_t& tracker) = delete;
  GPUTRDTracker_t& operator=(const GPUTRDTracker_t& tracker) = delete;
  ~GPUTRDTracker_t();
 
  void SetMaxData(const GPUTrackingInOutPointers& io);
  void RegisterMemoryAllocation();
  void InitializeProcessor();
  void UpdateGeometry();
  void* SetPointersBase(void* base);
  void* SetPointersTracklets(void* base);
  void* SetPointersTracks(void* base);
 
  void PrepareTracking(GPUChainTracking* chainTracking);
  void SetNCandidates(int32_t n);
  void PrintSettings() const;
  bool IsInitialized() const { return mIsInitialized; }
  void StartDebugging();
#endif
 
  enum EGPUTRDTracker { kNLayers = 6,
                        kNStacks = 5,
                        kNSectors = 18,
                        kNChambers = 540 };
 
  struct HelperTrackAttributes {
    // additional TRD track attributes which are transient
    float mTime;       // time estimate for seeding track in us
    float mTimeAddMax; // max. time that can be added to this track seed in us
    float mTimeSubMax; // max. time that can be subtracted to this track seed in us
    int16_t mSide;     // -1 : A-side, +1 : C-side (relevant only for TPC-only tracks)
    GPUd() float GetTimeMin() const { return mTime - mTimeSubMax; }
    GPUd() float GetTimeMax() const { return mTime + mTimeAddMax; }
    GPUd() HelperTrackAttributes() : mTime(-1.f), mTimeAddMax(0.f), mTimeSubMax(0.f), mSide(0) {}
  };
 
  struct Hypothesis {
    int32_t mLayers;      // number of layers with TRD space point
    int32_t mCandidateId; // to which track candidate the hypothesis belongs
    int32_t mTrackletId;  // tracklet index to be used for update (global index within tracklet array)
    float mChi2;          // predicted chi2 for given space point
 
    GPUd() float GetReducedChi2() { return mLayers > 0 ? mChi2 / mLayers : mChi2; }
    GPUd() Hypothesis() : mLayers(0), mCandidateId(-1), mTrackletId(-1), mChi2(9999.f) {}
    GPUd() Hypothesis(int32_t layers, int32_t candidateId, int32_t trackletId, float chi2) : mLayers(layers), mCandidateId(candidateId), mTrackletId(trackletId), mChi2(chi2) {}
  };
 
  int16_t MemoryPermanent() const { return mMemoryPermanent; }
 
  GPUhd() void OverrideGPUGeometry(const GPUTRDGeometry* geo) { mGeo = geo; }
  void Reset();
  template <class T>
  GPUd() bool PreCheckTrackTRDCandidate(const T& trk) const
  {
    return true;
  }
  GPUd() bool PreCheckTrackTRDCandidate(const GPUTPCGMMergedTrack& trk) const { return trk.OK() && !trk.MergedLooper(); }
  GPUd() bool CheckTrackTRDCandidate(const TRDTRK& trk) const;
  GPUd() int32_t LoadTrack(const TRDTRK& trk, uint32_t tpcTrackId, bool checkTrack = true, HelperTrackAttributes* attribs = nullptr);
 
  GPUd() int32_t GetCollisionIDs(int32_t iTrk, int32_t* collisionIds) const;
  GPUd() void DoTrackingThread(int32_t iTrk, int32_t threadId = 0);
  static GPUd() bool ConvertTrkltToSpacePoint(const GPUTRDGeometry& geo, GPUTRDTrackletWord& trklt, GPUTRDSpacePoint& sp);
  GPUd() bool CalculateSpacePoints(int32_t iCollision = 0);
  GPUd() bool FollowProlongation(PROP* prop, TRDTRK* t, int32_t iTrk, int32_t threadId, int32_t collisionId);
  GPUd() int32_t GetDetectorNumber(const float zPos, const float alpha, const int32_t layer) const;
  GPUd() bool AdjustSector(PROP* prop, TRDTRK* t) const;
  GPUd() int32_t GetSector(float alpha) const;
  GPUd() float GetAlphaOfSector(const int32_t sec) const;
  GPUd() float GetAngularPull(float dYtracklet, float snp) const;
  GPUd() void RecalcTrkltCov(const float tilt, const float snp, const float rowSize, float (&cov)[3]);
  GPUd() void FindChambersInRoad(const TRDTRK* t, const float roadY, const float roadZ, const int32_t iLayer, int32_t* det, const float zMax, const float alpha, const float zShiftTrk) const;
  GPUd() bool IsGeoFindable(const TRDTRK* t, const int32_t layer, const float alpha, const float zShiftTrk) const;
  GPUd() void InsertHypothesis(Hypothesis hypo, int32_t& nCurrHypothesis, int32_t idxOffset);
 
  // settings
  GPUd() void SetGenerateSpacePoints(bool flag) { mGenerateSpacePoints = flag; }
  GPUd() bool GenerateSpacepoints() const { return mGenerateSpacePoints; }
  GPUd() void SetProcessPerTimeFrame(bool flag) { mProcessPerTimeFrame = flag; }
  GPUd() void EnableDebugOutput() { mDebugOutput = true; }
  GPUd() void SetMaxEta(float maxEta) { mMaxEta = maxEta; }
  GPUd() void SetRoadZ(float roadZ) { mRoadZ = roadZ; }
  GPUd() void SetTPCVdrift(float vDrift) { mTPCVdrift = vDrift; }
  GPUd() void SetTPCTDriftOffset(float t) { mTPCTDriftOffset = t; }
 
  GPUd() bool GetIsDebugOutputOn() const { return mDebugOutput; }
  GPUd() float GetMaxEta() const { return mMaxEta; }
  GPUd() int32_t GetNCandidates() const { return mNCandidates; }
  GPUd() float GetRoadZ() const { return mRoadZ; }
 
  // output
  GPUd() int32_t NTracks() const { return mNTracks; }
  GPUd() GPUTRDSpacePoint* SpacePoints() const { return mSpacePoints; }
  GPUd() TRDTRK* Tracks() const { return mTracks; }
  GPUd() void DumpTracks();
 
  // utility
  GPUd() const typename PROP::propagatorParam* getPropagatorParam();
 
 protected:
  float* mR;                            // radial position of each TRD chamber, alignment taken into account, radial spread within chambers < 7mm
  bool mIsInitialized;                  // flag is set upon initialization
  bool mGenerateSpacePoints;            // if true, only tracklets are provided as input and they will be converted into space points by the tracker
  bool mProcessPerTimeFrame;            // if true, tracking is done per time frame instead of on a single events basis
  int16_t mNAngleHistogramBins;         // number of bins per chamber for the angular difference histograms
  float mAngleHistogramRange;           // range of impact angles covered by each histogram
  int16_t mMemoryPermanent;             // memory id of permanent memory for the tracker
  int16_t mMemoryTracklets;             // memory id of memory for TRD tracklets
  int16_t mMemoryTracks;                // memory id of memory for tracks (used for i/o)
  int32_t mNMaxCollisions;              // max number of collisions to process (per time frame)
  int32_t mNMaxTracks;                  // max number of tracks the tracker can handle (per event)
  int32_t mNMaxSpacePoints;             // max number of space points hold by the tracker (per event)
  TRDTRK* mTracks;                      // array of trd-updated tracks
  HelperTrackAttributes* mTrackAttribs; // array with additional (transient) track attributes
  int32_t mNCandidates;                 // max. track hypothesis per layer
  int32_t mNTracks;                     // number of TPC tracks to be matched
  int32_t mNEvents;                     // number of processed events
  int32_t mMaxBackendThreads;           // maximum number of supported threads
  // index of first tracklet for each chamber within tracklets array, last entry is total number of tracklets for given collision
  // the array has (kNChambers + 1) * numberOfCollisions entries
  // note, that for collision iColl one has to add an offset corresponding to the index of the first tracklet of iColl to the index stored in mTrackletIndexArray
  int32_t* mTrackletIndexArray;
  Hypothesis* mHypothesis;        // array with multiple track hypothesis
  TRDTRK* mCandidates;            // array of tracks for multiple hypothesis tracking
  GPUTRDSpacePoint* mSpacePoints; // array with tracklet coordinates in global tracking frame
  const GPUTRDGeometry* mGeo;     // TRD geometry
  const GPUTRDRecoParam* mRecoParam; // TRD RecoParam
  bool mDebugOutput;                                  // store debug output
  static constexpr const float sRadialOffset = -0.1f; // due to (possible) mis-calibration of t0 -> will become obsolete when tracklet conversion is done outside of the tracker
  float mMaxEta;                                      // TPC tracks with higher eta are ignored
  float mRoadZ;                                       // in z, a constant search road is used
  float mZCorrCoefNRC;                                // tracklet z-position depends linearly on track dip angle
  float mTPCVdrift;                                   // TPC drift velocity used for shifting TPC tracks along Z
  float mTPCTDriftOffset;                             // TPC drift time additive offset
  GPUTRDTrackerDebug<TRDTRK>* mDebug;                 // debug output
};
} // namespace o2::gpu
 
#endif // GPUTRDTRACKER_H