Detailed Description

Propagate particles through array geometry calculating energy losses.

Given a valid ROOT geometry, we propagate the particles of an event and, every time a particle traverses a volume made of a TGeoMaterial with a name corresponding to a material known by this range table, we calculate the energy loss of the particle, and store it in the particle's list of parameters in the form

"DE:[detector name]" = [energy lost in volume]

In the case of multilayer detectors, [detector name] is replaced by [detector name]/[layer name].

Example of use

In this case the geometry is made up of 3-layer Ionisation Chamber detectors (window + gas + window), with an ACTIVE gas layer, and single-layer Silicon detectors placed behind the IC.

KVEvent* evt = new KVEvent();
KVNucleus* nuc = evt->AddParticle();
Double_t theta = gRandom->Uniform(0,30);
Double_t phi = gRandom->Uniform(0,360);
nuc->SetZAandE(1,1,200); nuc->SetTheta(theta); nuc->SetPhi(phi);
 
KVRangeTableGeoNavigator rtgn(gGeoManager, KVMaterial::GetRangeTable())
rtgn.PropagateEvent(evt);
evt->Print();
 
KVEvent with 1 particles :
------------------------------------
KVNameValueList::EventParameters : Parameters associated with an event (0x3739f10)
KVNucleus Z=1 A=1 E*=0
KVParticle mass=938.783 Theta=14.017 Phi=44.7553 KE=199.73
KVNameValueList::ParticleParameters : Parameters associated with a particle in an event (0x37b3510)
<DE:CHIO_3/WINDOW_1=0.00151169>
<DE:CHIO_3/ACTIVE_GAS_1=0.00123736>
<DE:CHIO_3/WINDOW_2=0.00151169>
<DE:SI_1_5=0.265778>

Definition at line 55 of file KVRangeTableGeoNavigator.h.

#include <KVRangeTableGeoNavigator.h>

Inheritance diagram for KVRangeTableGeoNavigator:

[legend]

Public Member Functions
	KVRangeTableGeoNavigator (TGeoManager g, KVIonRangeTable r)

virtual	~KVRangeTableGeoNavigator ()

Bool_t	CheckIonForRangeTable (Int_t Z, Int_t A)

Double_t	GetCutOffKEForPropagation () const

virtual void	ParticleEntersNewVolume (KVNucleus *)

virtual void	PropagateParticle (KVNucleus , TVector3 TheOrigin=0)
	We start a new track to represent the particle's trajectory through the array.

void	SetCutOffKEForPropagation (Double_t e)

Public Member Functions inherited from KVGeoNavigator
	KVGeoNavigator (TGeoManager *)
	Constructor. Call with pointer to geometry.

virtual	~KVGeoNavigator ()
	Destructor.

void	AbsorbDetectorPaths (KVGeoNavigator *GN)

const TClonesArray &	CurrentStructures () const

void	DrawTracks (KVNumberList *=nullptr)

void	ExtractDetectorNameFromPath (KVString &)

TGeoVolume *	GetCurrentDetectorNameAndVolume (KVString &, Bool_t &)

TGeoNode *	GetCurrentDetectorNode () const

const TGeoHMatrix *	GetCurrentMatrix () const
	Returns pointer to internal copy of current global transformation matrix.

TGeoNode *	GetCurrentNode () const

TString	GetCurrentPath () const

TGeoVolume *	GetCurrentVolume () const

const Char_t *	GetDetectorNameFormat () const

const TVector3 &	GetEntryPoint () const

const TVector3 &	GetExitPoint () const

TGeoManager *	GetGeometry () const

Bool_t	GetNameCorrespondance (const Char_t *, TString &)

Double_t	GetStepSize () const

Int_t	GetTrackID () const

void	IncrementTrackID ()

Bool_t	IsTracking () const

void	PrintDetectorPaths ()

void	PropagateEvent (KVEvent , TVector3 TheOrigin=0)

void	ResetTrackID (Int_t id=0)

void	SetDetectorNameFormat (const Char_t *fmt)

void	SetNameCorrespondanceList (const Char_t *)

void	SetNameCorrespondanceList (const TEnv *)
	copy TEnv of name correspondances

void	SetStopPropagation (Bool_t stop=kTRUE)

void	SetStructureNameFormat (const Char_t type, const Char_t fmt)

void	SetTracking (Bool_t on=kTRUE)

Bool_t	StopPropagation () const

Public Member Functions inherited from KVBase
	KVBase ()
	Default constructor.

	KVBase (const Char_t name, const Char_t title="")
	Ctor for object with given name and type.

	KVBase (const KVBase &)
	copy ctor

virtual	~KVBase ()

virtual void	Clear (Option_t *opt="")
	Clear object properties : name, type/title, number, label.

virtual void	Copy (TObject &) const
	Make a copy of this object.

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

UInt_t	GetNumberOfObjects () const

virtual TObject *	GetObject () const

virtual const Char_t *	GetType () const

Bool_t	HasLabel () const

virtual Bool_t	IsCalled (const Char_t *name) const

Bool_t	IsLabelled (const Char_t *l) const

virtual Bool_t	IsType (const Char_t *typ) const

virtual void	List ()

KVBase &	operator= (const KVBase &)
	copy assignment operator

virtual void	Print (Option_t *option="") const

Double_t	ProtectedGetX (const TF1 *func, Double_t val, int &status, Double_t xmin=0.0, Double_t xmax=0.0) const

void	SetLabel (const Char_t *lab)

virtual void	SetNumber (UInt_t num)

virtual void	SetType (const Char_t *str)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)

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

virtual	~TNamed ()

void	Clear (Option_t *option="") override

TObject *	Clone (const char *newname="") const override

Int_t	Compare (const TObject *obj) const override

void	Copy (TObject &named) const override

virtual void	FillBuffer (char *&buffer)

const char *	GetName () const override

const char *	GetTitle () const override

ULong_t	Hash () const override

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override

TNamed &	operator= (const TNamed &rhs)

void	Print (Option_t *option="") const override

virtual void	SetName (const char *name)

virtual void	SetNameTitle (const char name, const char title)

virtual void	SetTitle (const char *title="")

virtual Int_t	Sizeof () const

void	Streamer (TBuffer &) override

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()

	TObject (const TObject &object)

virtual	~TObject ()

void	AbstractMethod (const char *method) const

virtual void	AppendPad (Option_t *option="")

virtual void	Browse (TBrowser *b)

ULong_t	CheckedHash ()

virtual const char *	ClassName () const

virtual void	Delete (Option_t *option="")

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)

virtual void	Draw (Option_t *option="")

virtual void	DrawClass () const

virtual TObject *	DrawClone (Option_t *option="") const

virtual void	Dump () const

virtual void	Error (const char method, const char msgfmt,...) const

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)

virtual void	Fatal (const char method, const char msgfmt,...) const

virtual TObject *	FindObject (const char *name) const

virtual TObject *	FindObject (const TObject *obj) const

virtual Option_t *	GetDrawOption () const

virtual const char *	GetIconName () const

virtual char *	GetObjectInfo (Int_t px, Int_t py) const

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const

virtual Bool_t	HandleTimer (TTimer *timer)

Bool_t	HasInconsistentHash () const

virtual void	Info (const char method, const char msgfmt,...) const

virtual Bool_t	InheritsFrom (const char *classname) const

virtual Bool_t	InheritsFrom (const TClass *cl) const

virtual void	Inspect () const

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const

virtual Bool_t	IsEqual (const TObject *obj) const

virtual Bool_t	IsFolder () const

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const

virtual Bool_t	Notify ()

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const

void	operator delete (void *ptr)

void	operator delete (void ptr, void vp)

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, void vp)

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)

virtual void	Paint (Option_t *option="")

virtual void	Pop ()

virtual Int_t	Read (const char *name)

virtual void	RecursiveRemove (TObject *obj)

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)

virtual void	SetDrawOption (Option_t *option="")

virtual void	SetUniqueID (UInt_t uid)

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()

virtual void	Warning (const char method, const char msgfmt,...) const

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const

Private Member Functions
void	AddPointToCurrentTrack (Double_t x, Double_t y, Double_t z)

void	InitialiseTrack (KVNucleus part, TVector3 TheOrigin)
	Start a new track to visualise trajectory of nucleus through the array.

Private Attributes
TVirtualGeoTrack *	fCurrentTrack
	current track of nucleus being propagated

Double_t	fCutOffEnergy
	cut-off KE in MeV below which we stop propagation

KVIonRangeTable *	fRangeTable

Double_t	fTrackTime
	track "clock"

Additional Inherited Members
Public Types inherited from KVBase
enum	EKaliVedaBits { kIsKaliVedaObject = BIT(23) }

Public Types inherited from TObject
enum	EDeprecatedStatusBits

enum	EStatusBits

Static Public Member Functions inherited from KVBase
static Bool_t	AreEqual (Double_t x, Double_t y, Long64_t maxdif=1)
	Comparison between two 64-bit floating-point values.

static void	BackupFileWithDate (const Char_t *path)

static void	CombineFiles (const Char_t file1, const Char_t file2, const Char_t *newfilename, Bool_t keep=kTRUE)

static void	Deprecated (const char method, const char advice)

static Bool_t	FindClassSourceFiles (const Char_t class_name, KVString &imp_file, KVString &dec_file, const Char_t dir_name=".")

static Bool_t	FindExecutable (TString &exec, const Char_t *path="$(PATH)")

static const Char_t *	FindFile (const Char_t *search, TString &wfil)

static const Char_t *	GetBINDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetDATABASEFilePath ()

static const Char_t *	GetDATADIRFilePath (const Char_t *namefile="")

static Bool_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Bool_t defval)

static const Char_t *	GetDataSetEnv (const Char_t dataset, const Char_t type, const Char_t *defval)

static Double_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Double_t defval)

static const Char_t *	GetETCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetExampleFilePath (const Char_t library, const Char_t namefile)
	Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.)

static const Char_t *	GetINCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetKVBuildDate ()
	Returns KaliVeda build date.

static const Char_t *	GetKVBuildDir ()
	Returns top-level directory used for build.

static const Char_t *	GetKVBuildTime ()
	Returns KaliVeda build time.

static const Char_t *	GetKVBuildType ()
	Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...)

static const Char_t *	GetKVBuildUser ()
	Returns username of person who performed build.

static const Char_t *	GetKVSourceDir ()
	Returns top-level directory of source tree used for build.

static const Char_t *	GetKVVersion ()
	Returns KaliVeda version string.

static const Char_t *	GetLIBDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetListOfPlugins (const Char_t *base)

static const Char_t *	GetListOfPluginURIs (const Char_t *base)

static const Char_t *	GetPluginURI (const Char_t base, const Char_t plugin)

static void	GetTempFileName (TString &base)

static const Char_t *	GetTEMPLATEDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetWORKDIRFilePath (const Char_t *namefile="")

static const Char_t *	gitBranch ()
	Returns git branch of sources.

static const Char_t *	gitCommit ()
	Returns last git commit of sources.

static void	InitEnvironment ()

static bool	is_gnuinstall ()

static Bool_t	IsThisAPlugin (const TString &uri, TString &base)

static TPluginHandler *	LoadPlugin (const Char_t base, const Char_t uri="0")

static Bool_t	OpenContextMenu (const char method, TObject obj, const char *alt_method_name="")

static void	OpenTempFile (TString &base, std::ofstream &fp)

static void	PrintSplashScreen ()
	Prints welcome message and infos on version etc.

static Bool_t	SearchAndOpenKVFile (const Char_t name, KVSQLite::database &dbfile, const Char_t kvsubdir="")

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ifstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ofstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchKVFile (const Char_t name, TString &fullpath, const Char_t kvsubdir="")

static const Char_t *	WorkingDirectory ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()

static Bool_t	GetObjectStat ()

static void	SetDtorOnly (void *obj)

static void	SetObjectStat (Bool_t stat)

Public Attributes inherited from TObject
	kBitMask

	kCanDelete

	kCannotPick

	kHasUUID

	kInconsistent

	kInvalidObject

	kIsOnHeap

	kIsReferenced

	kMustCleanup

	kNoContextMenu

	kNotDeleted

	kObjInCanvas

	kOverwrite

	kSingleKey

	kWriteDelete

	kZombie

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const

void	MakeZombie ()

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Protected Attributes inherited from TObject
	kOnlyPrepStep

Constructor & Destructor Documentation

◆ KVRangeTableGeoNavigator()

KVRangeTableGeoNavigator::KVRangeTableGeoNavigator	(	TGeoManager *	g,
		KVIonRangeTable *	r
	)

inline

Definition at line 71 of file KVRangeTableGeoNavigator.h.

◆ ~KVRangeTableGeoNavigator()

virtual KVRangeTableGeoNavigator::~KVRangeTableGeoNavigator ( )

inlinevirtual

Definition at line 75 of file KVRangeTableGeoNavigator.h.

Member Function Documentation

◆ AddPointToCurrentTrack()

void KVRangeTableGeoNavigator::AddPointToCurrentTrack	(	Double_t	x,
		Double_t	y,
		Double_t	z
	)

inlineprivatevirtual

Add point to current track & increase track time counter by 1 unit

Reimplemented from KVGeoNavigator.

Definition at line 63 of file KVRangeTableGeoNavigator.h.

◆ CheckIonForRangeTable()

Bool_t KVRangeTableGeoNavigator::CheckIonForRangeTable	(	Int_t	Z,
		Int_t	A
	)

inline

Return kTRUE if current range tables can handle ion

Definition at line 88 of file KVRangeTableGeoNavigator.h.

◆ GetCutOffKEForPropagation()

Double_t KVRangeTableGeoNavigator::GetCutOffKEForPropagation ( ) const

inline

Definition at line 80 of file KVRangeTableGeoNavigator.h.

◆ InitialiseTrack()

void KVRangeTableGeoNavigator::InitialiseTrack	(	KVNucleus *	part,
		TVector3 *	TheOrigin
	)

private

Start a new track to visualise trajectory of nucleus through the array.

Definition at line 138 of file KVRangeTableGeoNavigator.cpp.

◆ ParticleEntersNewVolume()

void KVRangeTableGeoNavigator::ParticleEntersNewVolume ( KVNucleus * part )

virtual

Overrides method in KVGeoNavigator base class. Every time a particle enters a new volume, we check the material to see if it is known (i.e. contained in the range table fRangeTable). If so, then we calculate the energy loss of the particle in this volume, reduce the particle's energy accordingly, and, if the energy falls below a certain cut-off (default 1.e-3 MeV; can be modified with SetCutOffKEForPropagation(Double_t) ), we stop the propagation.

The (cumulated) energy losses in the active layers of all hit detectors are updated with the energy lost by this particle

Reimplemented from KVGeoNavigator.

Definition at line 34 of file KVRangeTableGeoNavigator.cpp.

◆ PropagateParticle()

void KVRangeTableGeoNavigator::PropagateParticle	(	KVNucleus *	part,
		TVector3 *	TheOrigin = `0`
	)

virtual

We start a new track to represent the particle's trajectory through the array.

Reimplemented from KVGeoNavigator.

Definition at line 157 of file KVRangeTableGeoNavigator.cpp.

◆ SetCutOffKEForPropagation()

void KVRangeTableGeoNavigator::SetCutOffKEForPropagation ( Double_t e )

inline

Definition at line 76 of file KVRangeTableGeoNavigator.h.

Member Data Documentation

◆ fCurrentTrack

TVirtualGeoTrack* KVRangeTableGeoNavigator::fCurrentTrack

private

current track of nucleus being propagated

Definition at line 59 of file KVRangeTableGeoNavigator.h.

◆ fCutOffEnergy

Double_t KVRangeTableGeoNavigator::fCutOffEnergy

private

cut-off KE in MeV below which we stop propagation

Definition at line 58 of file KVRangeTableGeoNavigator.h.

◆ fRangeTable

KVIonRangeTable* KVRangeTableGeoNavigator::fRangeTable

private

Definition at line 57 of file KVRangeTableGeoNavigator.h.

◆ fTrackTime

Double_t KVRangeTableGeoNavigator::fTrackTime

private

track "clock"

Definition at line 60 of file KVRangeTableGeoNavigator.h.

Detailed Description

Example of use

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVRangeTableGeoNavigator()

◆ ~KVRangeTableGeoNavigator()

Member Function Documentation

◆ AddPointToCurrentTrack()

◆ CheckIonForRangeTable()

◆ GetCutOffKEForPropagation()

◆ InitialiseTrack()

◆ ParticleEntersNewVolume()

◆ PropagateParticle()

◆ SetCutOffKEForPropagation()

Member Data Documentation

◆ fCurrentTrack

◆ fCutOffEnergy

◆ fRangeTable

◆ fTrackTime