Propagator interface class for PandaRoot. More...

#include <PndPropagator.h>

Inheritance diagram for PndPropagator:

Public Member Functions
	PndPropagator ()
	default constructor More...

	PndPropagator (const TString &name, const TString &title)

virtual	~PndPropagator ()

virtual void	Init (FairTrackPar *)
	default destructor More...

virtual Bool_t	Propagate ([[gnu::unused]] FairTrackPar TStart, [[gnu::unused]] FairTrackPar TEnd, [[gnu::unused]] Int_t PDG)
	Propagate track to point, wire, plane or volume. More...

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)
	Propagate track to point, wire, plane or volume. More...

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)
	Find point of closest approach to point or wire. More...

virtual Bool_t	SetPropagateOnlyParameters ()
	Method to set to propagate only parameters. More...

virtual Bool_t	SetPCAPropagation ([[gnu::unused]] Int_t pca, [[gnu::unused]] Int_t dir=1, [[gnu::unused]] FairTrackPar *par=nullptr)
	Set PCA propagation. More...

virtual Bool_t	SetDestinationPlane ([[gnu::unused]] const TVector3 &v0, [[gnu::unused]] const TVector3 &v1, [[gnu::unused]] const TVector3 &v2)
	Method to set the plane to propagate particles to. More...

virtual Bool_t	SetOriginPlane ([[gnu::unused]] const TVector3 &v0, [[gnu::unused]] const TVector3 &v1)
	Method to set the plane to propagate particles from. More...

virtual Bool_t	SetDestinationVolume (std::string volName, Int_t copyNo, Int_t option)
	Method to set the volume to propagate particles to. More...

virtual Bool_t	SetDestinationLength (Float_t length)
	Method to set the length to propagate particles to. More...

virtual Bool_t	SetDestinationPoint (const TVector3 point)
	Method to set the point to propagate particles to. More...

virtual Bool_t	SetDestinationWire (const TVector3 wire1, const TVector3 wire2)
	Method to set wire to propagate to. More...

virtual PndProp::PCAOutputStruct	GetPcaOutput ()
	get PCAOutputStruct containing all relevant pca informations. More...

virtual Float_t	GetLengthAtPCA ()

virtual Float_t	GetDistAtPCA ()
	Get distance between point of closest approach and vertex. More...

virtual TVector3	GetPCA ()
	Get position of pca on track. More...

	ClassDef (PndPropagator, 1)

Protected Attributes
Int_t	fPcaMode
	if 1: propagate to point, if 2: propagate to line, if 0: no pca More...

TVector3	fPoint
	point to which to calculate pca More...

TVector3	fWire1
	first anchor point of line to which to calculate pca More...

TVector3	fWire2
	second anchor point of line to which to calculate pca More...

Float_t	fDestinationLength
	track length when PropagateToTrack is chosen More...

TString	fVolumeName
	volume name More...

Int_t	fVolumeCopyNo
	volume copy number More...

Bool_t	fVolumeEnter
	true if enter volume More...

TVector3	fInitialPosition
	initial position in cm More...

TVector3	fInitialMomentum
	initial momentum in GeV More...

TVector3	fFinalPosition
	final position More...

TVector3	fFinalMomentum
	final momentum More...

PndProp::PCAOutputStruct	fPcaOutput

Detailed Description

Propagator interface class for PandaRoot.

Definition at line 52 of file PndPropagator.h.

Constructor & Destructor Documentation

◆ PndPropagator() [1/2]

PndPropagator::PndPropagator ( )

default constructor

◆ PndPropagator() [2/2]

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

◆ ~PndPropagator()

virtual PndPropagator::~PndPropagator ( )

inlinevirtual

Definition at line 75 of file PndPropagator.h.

75 {};

Member Function Documentation

◆ ClassDef()

PndPropagator::ClassDef	(	PndPropagator	,
		1
	)

Referenced by PndHelixPropagator::GetPcaMode().

◆ FindPCA()

virtual PndProp::PCAOutputStruct PndPropagator::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
	)

inlinevirtual

Find point of closest approach to point or wire.

Parameters

pca	if = 1: closest approach to point if = 2: closest approach to wire if = 0: no closest approach
PDGCode	pdg code of the particle
point	point with respect to which calculate the closest approach
wire	first anchor point of line with respect to which calculate the closest approach
wire2	second anchor point of line with respect to which calculate the closest approach
maxdistance	geometrical distance[start - point/wire extr] * 2

Returns: kTRUE if successful

Definition at line 123 of file PndPropagator.h.

   {
     return PndProp::PCAOutputStruct();
   }

◆ GetDistAtPCA()

virtual Float_t PndPropagator::GetDistAtPCA ( )

inlinevirtual

Get distance between point of closest approach and vertex.

Definition at line 250 of file PndPropagator.h.

References PndProp::PCAOutputStruct::Distance.

250 { return fPcaOutput.Distance; };

PndPropagator::fPcaOutput

PndProp::PCAOutputStruct fPcaOutput

Definition: PndPropagator.h:69

PndProp::PCAOutputStruct::Distance

Double_t Distance

Definition: PndPropagator.h:43

◆ GetLengthAtPCA()

virtual Float_t PndPropagator::GetLengthAtPCA ( )

inlinevirtual

Get Track length at point of closest approach.

Reimplemented in PndGeanePro.

Definition at line 245 of file PndPropagator.h.

References PndProp::PCAOutputStruct::TrackLength.

245 { return fPcaOutput.TrackLength; };

PndPropagator::fPcaOutput

PndProp::PCAOutputStruct fPcaOutput

Definition: PndPropagator.h:69

PndProp::PCAOutputStruct::TrackLength

Float_t TrackLength

Definition: PndPropagator.h:44

◆ GetPCA()

virtual TVector3 PndPropagator::GetPCA ( )

inlinevirtual

Get position of pca on track.

Definition at line 255 of file PndPropagator.h.

References PndProp::PCAOutputStruct::OnTrackPCA.

255 { return fPcaOutput.OnTrackPCA; };

PndPropagator::fPcaOutput

PndProp::PCAOutputStruct fPcaOutput

Definition: PndPropagator.h:69

PndProp::PCAOutputStruct::OnTrackPCA

TVector3 OnTrackPCA

Definition: PndPropagator.h:41

◆ GetPcaOutput()

virtual PndProp::PCAOutputStruct PndPropagator::GetPcaOutput ( )

inlinevirtual

get PCAOutputStruct containing all relevant pca informations.

Definition at line 240 of file PndPropagator.h.

240 { return fPcaOutput; };

PndPropagator::fPcaOutput

PndProp::PCAOutputStruct fPcaOutput

Definition: PndPropagator.h:69

◆ Init()

virtual void PndPropagator::Init ( FairTrackPar * )

inlinevirtual

default destructor

Reimplemented in PndHelixPropagator, and PndGeanePro.

Definition at line 77 of file PndPropagator.h.

77 {};

◆ Propagate() [1/2]

virtual Bool_t PndPropagator::Propagate	(	[[gnu::unused] ] FairTrackPar *	TStart,
		[[gnu::unused] ] FairTrackPar *	TEnd,
		[[gnu::unused] ] Int_t	PDG
	)

inlinevirtual

Propagate track to point, wire, plane or volume.

Parameters

TStart	track parameters at point from which to propagate
TEnd	track parameters at end point of propagation
PDG	pdg code of the particle to propagate

Returns: kTRUE if successful

Definition at line 86 of file PndPropagator.h.

   {
     return kFALSE;
   }

◆ Propagate() [2/2]

virtual Bool_t PndPropagator::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
	)

inlinevirtual

Propagate track to point, wire, plane or volume.

Parameters

x1	coordinates of point from which to propagate
p1	momentum at point from which to propagate
x2	coordinates of end point of propagation
p2	momentum at end point of propagation
PDG	pdg code of the particle to propagate

Returns: kTRUE if successful

Definition at line 102 of file PndPropagator.h.

   {
     return kFALSE;
   }

◆ SetDestinationLength()

virtual Bool_t PndPropagator::SetDestinationLength ( Float_t length )

inlinevirtual

Method to set the length to propagate particles to.

Parameters

length track length

Returns: kTRUE if successful

Reimplemented in PndGeanePro.

Definition at line 206 of file PndPropagator.h.

   {
     fDestinationLength = length;
     return kFALSE;
   };

◆ SetDestinationPlane()

virtual Bool_t PndPropagator::SetDestinationPlane	(	[[gnu::unused] ] const TVector3 &	v0,
		[[gnu::unused] ] const TVector3 &	v1,
		[[gnu::unused] ] const TVector3 &	v2
	)

inlinevirtual

Method to set the plane to propagate particles to.

Parameters

v0	first plane defining vector
v1	second plane defining vector
v2	third plane defining vector

Returns: kTRUE if successful

Reimplemented in PndHelixPropagator.

Definition at line 165 of file PndPropagator.h.

   {
     return kFALSE;
   }

◆ SetDestinationPoint()

virtual Bool_t PndPropagator::SetDestinationPoint ( const TVector3 point )

inlinevirtual

Method to set the point to propagate particles to.

Parameters

point destination point

Returns: kTRUE if successful

Reimplemented in PndGeanePro.

Definition at line 217 of file PndPropagator.h.

   {
     fPoint = point;
     return kTRUE;
   };

◆ SetDestinationVolume()

virtual Bool_t PndPropagator::SetDestinationVolume	(	std::string	volName,
		Int_t	copyNo,
		Int_t	option
	)

inlinevirtual

Method to set the volume to propagate particles to.

Parameters

volName	volume name
copyNo	copy number
option	other options

Returns: kTRUE if successful

Reimplemented in PndGeanePro.

Definition at line 190 of file PndPropagator.h.

   {
     fVolumeName = volName;
     fVolumeCopyNo = copyNo;
     if (option == 1) fVolumeEnter = kTRUE;
     else fVolumeEnter = kFALSE;
     return kTRUE;
   }

◆ SetDestinationWire()

virtual Bool_t PndPropagator::SetDestinationWire	(	const TVector3	wire1,
		const TVector3	wire2
	)

inlinevirtual

Method to set wire to propagate to.

Parameters

wire1	first anchor point of wire to propagate to
wire2	second anchor point of wire to propagate to

Reimplemented in PndGeanePro.

Definition at line 228 of file PndPropagator.h.

   {
     fWire1 = wire1;
     fWire2 = wire2;
     return kTRUE;
   };

◆ SetOriginPlane()

virtual Bool_t PndPropagator::SetOriginPlane	(	[[gnu::unused] ] const TVector3 &	v0,
		[[gnu::unused] ] const TVector3 &	v1
	)

inlinevirtual

Method to set the plane to propagate particles from.

Parameters

v0	first plane defining vector
v1	second plane defining vector

Returns: kTRUE if successful

Reimplemented in PndHelixPropagator.

Definition at line 178 of file PndPropagator.h.

   {
     return kFALSE;
   }

◆ SetPCAPropagation()

virtual Bool_t PndPropagator::SetPCAPropagation	(	[[gnu::unused] ] Int_t	pca,
		[[gnu::unused] ] Int_t	dir = `1`,
		[[gnu::unused] ] FairTrackPar *	par = `nullptr`
	)

inlinevirtual

Set PCA propagation.

Parameters

pca	if = 1: closest approach to point if = 2: closest approach to wire if = 0: no closest approach
dir	if = +1: move forward if = -1: move backward
par	initial track parameters

Returns: kTRUE if successful

Definition at line 151 of file PndPropagator.h.

   {
     return kTRUE;
   }

◆ SetPropagateOnlyParameters()

virtual Bool_t PndPropagator::SetPropagateOnlyParameters ( )

inlinevirtual

Method to set to propagate only parameters.

Returns: kTRUE if successful

Reimplemented in PndGeanePro.

Definition at line 139 of file PndPropagator.h.

139 { return kFALSE; }

Member Data Documentation

◆ fDestinationLength

Float_t PndPropagator::fDestinationLength

protected

track length when PropagateToTrack is chosen

Definition at line 59 of file PndPropagator.h.

◆ fFinalMomentum

TVector3 PndPropagator::fFinalMomentum

protected

final momentum

Definition at line 67 of file PndPropagator.h.

◆ fFinalPosition

TVector3 PndPropagator::fFinalPosition

protected

final position

Definition at line 66 of file PndPropagator.h.

◆ fInitialMomentum

TVector3 PndPropagator::fInitialMomentum

protected

initial momentum in GeV

Definition at line 65 of file PndPropagator.h.

Referenced by PndHelixPropagator::Radius().

◆ fInitialPosition

TVector3 PndPropagator::fInitialPosition

protected

initial position in cm

Definition at line 64 of file PndPropagator.h.

◆ fPcaMode

Int_t PndPropagator::fPcaMode

protected

if 1: propagate to point, if 2: propagate to line, if 0: no pca

Definition at line 55 of file PndPropagator.h.

Referenced by PndHelixPropagator::GetPcaMode(), and PndHelixPropagator::SetPCAPropagation().

◆ fPcaOutput

PndProp::PCAOutputStruct PndPropagator::fPcaOutput

protected

Definition at line 69 of file PndPropagator.h.

Referenced by PndGeanePro::GetLengthAtPCA().

◆ fPoint

TVector3 PndPropagator::fPoint

protected

point to which to calculate pca

Definition at line 56 of file PndPropagator.h.

Referenced by PndHelixPropagator::GetPoint().

◆ fVolumeCopyNo

Int_t PndPropagator::fVolumeCopyNo

protected

volume copy number

Definition at line 61 of file PndPropagator.h.

◆ fVolumeEnter

Bool_t PndPropagator::fVolumeEnter

protected

true if enter volume

Definition at line 62 of file PndPropagator.h.

◆ fVolumeName

TString PndPropagator::fVolumeName

protected

volume name

Definition at line 60 of file PndPropagator.h.

◆ fWire1

TVector3 PndPropagator::fWire1

protected

first anchor point of line to which to calculate pca

Definition at line 57 of file PndPropagator.h.

◆ fWire2

TVector3 PndPropagator::fWire2

protected

second anchor point of line to which to calculate pca

Definition at line 58 of file PndPropagator.h.

The documentation for this class was generated from the following file:

PndPropagator.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PndPropagator() [1/2]

◆ PndPropagator() [2/2]

◆ ~PndPropagator()

Member Function Documentation

◆ ClassDef()

◆ FindPCA()

◆ GetDistAtPCA()

◆ GetLengthAtPCA()

◆ GetPCA()

◆ GetPcaOutput()

◆ Init()

◆ Propagate() [1/2]

◆ Propagate() [2/2]

◆ SetDestinationLength()

◆ SetDestinationPlane()

◆ SetDestinationPoint()

◆ SetDestinationVolume()

◆ SetDestinationWire()

◆ SetOriginPlane()

◆ SetPCAPropagation()

◆ SetPropagateOnlyParameters()

Member Data Documentation

◆ fDestinationLength

◆ fFinalMomentum

◆ fFinalPosition

◆ fInitialMomentum

◆ fInitialPosition

◆ fPcaMode

◆ fPcaOutput

◆ fPoint

◆ fVolumeCopyNo

◆ fVolumeEnter

◆ fVolumeName

◆ fWire1

◆ fWire2