CbmKFTrackInterface.h

Go to the documentation of this file.

/* Copyright (C) 2006-2015 GSI Helmholtzzentrum fuer Schwerionenforschung, Darmstadt
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Sergey Gorbunov, Denis Bertini [committer] */
 
#ifndef CBMKFTRACKINTERFACE_H
#define CBMKFTRACKINTERFACE_H
 
#include "TObject.h"
 
class CbmKFHit;
class CbmKFVertexInterface;
 
class CbmKFTrackInterface {
 
 public:
  CbmKFTrackInterface() : fId() {}
  virtual ~CbmKFTrackInterface() {}
 
  virtual Double_t GetMass() const { return 0.1396; }  
  virtual Bool_t IsElectron() const { return 0; }      
 
  virtual Double_t* GetTrack();      
  virtual Double_t* GetCovMatrix();  
 
  virtual Double_t& GetRefChi2();  
  virtual Int_t& GetRefNDF();      
 
  virtual Int_t GetNOfHits() { return 0; }             
  virtual CbmKFHit* GetHit(Int_t) { return nullptr; }  
 
  Int_t Extrapolate(Double_t z, Double_t* QP0 = nullptr);
  Int_t Fit(Bool_t downstream = 1);
  void Smooth(Double_t Z);
  void Fit2Vertex(CbmKFVertexInterface& vtx);
 
  Int_t Propagate(Double_t z_out, Double_t QP0);
  Int_t Propagate(Double_t z_out);
 
  int Id() const { return fId; };
  void SetId(int id) { fId = id; };
 
 protected:
  int fId;
 
  ClassDef(CbmKFTrackInterface, 1)
};
 
 
/******************************************************************
 *
 *  There are few ways to let the Kalman Filter treat your track.
 *
 ******************************************************************
 *
 * // The first way: inherit the CbmKFTrackInterface, like :
 *
 * class CbmMyTrack :public CbmKFTrackInterface{
 *  public:
 *   // here overwrite CbmKF virtual methods
 *   Double_t *GetTrack(){ return fT; } 
 *   ...
 *   // Here is my methods
 *   ...
 *  private:
 *   Double_t fT[6]; 
 *   Double_t fVariablesForMyNeeds;
 * };
 *
 * // Then use your track directly:
 *
 * CbmMyTrack my_track;
 * ...
 * CbmKF::Instance()->FitTrack( my_track );
 *
 *
 ******************************************************************
 *
 *
 * // The second way: make interface class to your track, like:
 *
 * class CbmMyTrack{
 *  public:
 *   Double_t *GetFittedTrackParametersAtThePrimaryVertex();
 *   ...
 * };
 *
 * class CbmMyTrackInterface : public CbmKFTrackInterface{
 *  public:
 *   CbmMyTrackInterface( CbmMyTrack *track ):fTrack(track){}
 *   Double_t *GetTrack(){ 
 *     return ((CbmMyTrack*)fTrack)->GetFittedTrackParametersAtThePrimaryVertex(); 
 *   } 
 *   ...
 *  private:
 *   CbmMyTrackTrack *fTrack;
 * };
 *
 * // Then call the KF routines through the interface, like:
 *
 * CbmMyTrack my_track;
 * ...
 * CbmMyTrackInterface I(my_track);
 * CbmKF::Instance()->FitTrack( I );
 *
 ******************************************************************
 *
 *
 * // Other ways...
 *
 *
 */
 
#endif /* !CBMKFTRACKINTERFACE_H */