PndPropagator.h

Go to the documentation of this file.

//****************************************************************************
//*                   This file is part of PandaRoot.                        *
//*                                                                          *
//*            PandaRoot is distributed under the terms of the               *
//*              GNU General Public License (GPL) version 3,                 *
//*                 copied verbatim in the file "LICENSE".                   *
//*                                                                          *
//*  Copyright (C) 2006 - 2024 FAIR GmbH and copyright holders of PandaRoot  *
//*     The copyright holders are listed in the file "COPYRIGHTHOLDERS".     *
//*               The authors are listed in the file "AUTHORS".              *
//****************************************************************************

/*
 * PndPropagator.h
 *
 *  Created: April 2021
 *   Author: Gaiser
 */

#ifndef PNDPROPAGATOR_H
#define PNDPROPAGATOR_H

#include <Rtypes.h>      // for THashConsistencyHolder, ClassDef
#include <RtypesCore.h>  // for kTRUE
#include <iosfwd>        // for string
#include <string>        // for basic_string

#include "TNamed.h"      // for TNamed
#include "TString.h"     // for TString
#include "TVector3.h"    // for TVector3

#include "FairLogger.h"
#include "FairField.h"
#include "FairTrackPar.h"

namespace PndProp {
  struct PCAOutputStruct
  {
    PCAOutputStruct()
      : PCAStatusFlag(1)                  
      , Radius(0.)                        
      , OnTrackPCA(TVector3(0., 0., 0.))  
      , OnWirePCA(TVector3(0., 0., 0.))   
      , Distance(0.)                      
      , TrackLength(0.)                   
    {}
    Int_t PCAStatusFlag;
    Double_t Radius;
    TVector3 OnTrackPCA;
    TVector3 OnWirePCA;
    Double_t Distance;
    Float_t TrackLength;
  };
}

class PndPropagator : public TNamed
{
 protected:
  Int_t fPcaMode;             
  TVector3 fPoint;            
  TVector3 fWire1;            
  TVector3 fWire2;            
  Float_t fDestinationLength; 
  TString fVolumeName;        
  Int_t fVolumeCopyNo;        
  Bool_t fVolumeEnter;        

  TVector3 fInitialPosition;  
  TVector3 fInitialMomentum;  
  TVector3 fFinalPosition;    
  TVector3 fFinalMomentum;    

  PndProp::PCAOutputStruct fPcaOutput;

 public:
  PndPropagator(); 
  PndPropagator(const TString& name, const TString& title);

  virtual ~PndPropagator() {}; 

  virtual void Init(FairTrackPar* /* TParam */){};

  virtual Bool_t Propagate([[gnu::unused]] FairTrackPar* TStart,
                           [[gnu::unused]] FairTrackPar* TEnd,
                           [[gnu::unused]] Int_t PDG)
  {
    return kFALSE;
  }

  virtual Bool_t Propagate([[gnu::unused]] Float_t* x1,
                           [[gnu::unused]] Float_t* p1,
                           [[gnu::unused]] Float_t* x2,
                           [[gnu::unused]] Float_t* p2,
                           [[gnu::unused]] Int_t PDG)
  {
    return kFALSE;
  }

  virtual PndProp::PCAOutputStruct FindPCA([[gnu::unused]] Int_t PCA,
                                           [[gnu::unused]] Int_t PDGCode,
                                           [[gnu::unused]] TVector3 Point,
                                           [[gnu::unused]] TVector3 Wire1,
                                           [[gnu::unused]] TVector3 Wire2,
                                           [[gnu::unused]] Double_t MaxDistance)
  {
    return PndProp::PCAOutputStruct();
  }

  /* =========================================================================================================================================== */
  
  virtual Bool_t SetPropagateOnlyParameters() { return kFALSE; }

  virtual Bool_t SetPCAPropagation([[gnu::unused]] Int_t pca,
                                   [[gnu::unused]] Int_t dir = 1,
                                   [[gnu::unused]] FairTrackPar* par = nullptr)
  {
    return kTRUE;
  }

  virtual Bool_t SetDestinationPlane([[gnu::unused]] const TVector3& v0,
                                     [[gnu::unused]] const TVector3& v1,
                                     [[gnu::unused]] const TVector3& v2)
  {
    return kFALSE;
  }

  virtual Bool_t SetOriginPlane([[gnu::unused]] const TVector3& v0, [[gnu::unused]] const TVector3& v1)
  {
    return kFALSE;
  }

  virtual Bool_t SetDestinationVolume(std::string volName,
                                      Int_t copyNo,
                                      Int_t option)
  {
    fVolumeName = volName;
    fVolumeCopyNo = copyNo;
    if (option == 1) fVolumeEnter = kTRUE;
    else fVolumeEnter = kFALSE;
    return kTRUE;
  }

  virtual Bool_t SetDestinationLength(Float_t length)
  {
    fDestinationLength = length;
    return kFALSE;
  };

  virtual Bool_t SetDestinationPoint(const TVector3 point)
  {
    fPoint = point;
    return kTRUE;
  };

  virtual Bool_t SetDestinationWire(const TVector3 wire1, const TVector3 wire2)
  {
    fWire1 = wire1;
    fWire2 = wire2;
    return kTRUE;
  };

  /* =========================================================================================================================================== */

  virtual PndProp::PCAOutputStruct GetPcaOutput() { return fPcaOutput; };

  virtual Float_t GetLengthAtPCA() { return fPcaOutput.TrackLength; };
  
  virtual Float_t GetDistAtPCA() { return fPcaOutput.Distance; };
  
  virtual TVector3 GetPCA() { return fPcaOutput.OnTrackPCA; };

  ClassDef(PndPropagator, 1);
};

#endif //PNDPROPAGATOR_H