Detailed Description

Simulate detection of events in a detector array.

Created by KVClassFactory on Sat Oct 10 09:37:42 2015 Author: John Frankland,,,

Definition at line 20 of file KVDetectionSimulator.h.

#include <KVDetectionSimulator.h>

Inheritance diagram for KVDetectionSimulator:

[legend]

Public Member Functions
	KVDetectionSimulator ()

	KVDetectionSimulator (KVMultiDetArray *a, Double_t cut_off=1.e-3)

void	ClearHitGroups ()

void	DetectEvent (KVEvent event, const Char_t detection_frame="")

KVMultiDetArray *	GetArray () const

TString	GetDetectionFrame () const

Double_t	GetMinKECutOff () const

KVTarget *	GetTarget () const

Bool_t	IncludeTargetEnergyLoss () const

void	SetArray (KVMultiDetArray *a, Double_t e_cut_off=1.e-3)

void	SetGeometricFilterMode ()

void	SetIncludeTargetEnergyLoss (Bool_t y=kTRUE)

void	SetMinKECutOff (Double_t cutoff)

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

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

	KVBase (const KVBase &)
	copy ctor More...

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

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

const Char_t *	GetLabel () const

UInt_t	GetNumber () 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 More...

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

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 ()

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

Int_t	Compare (const TObject *obj) 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)

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
KVRangeTableGeoNavigator *	get_array_navigator () const
	name of kinematical frame used in last call to DetectEvent() More...

KVNameValueList	PropagateParticle (KVNucleus *)

Private Attributes
KVMultiDetArray *	fArray = nullptr

Bool_t	fCalcTargELoss = kTRUE

TString	fDetectionFrame
	when true, only consider geometry, not particle energies More...

Bool_t	fGeoFilter = kFALSE
	whether to include energy loss in target, if defined More...

KVDetectorEvent	fHitGroups
	array used for detection More...

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. More...

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 KVString &class_name, KVString &imp_file, KVString &dec_file, const KVString &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 KVString	GetDataSetEnv (const KVString &dataset, const KVString &type, const char *defval)

template<typename ValType >
static ValType	GetDataSetEnv (const KVString &dataset, const KVString &type, const ValType &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.) More...

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

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

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

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

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

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

static int	GetKVMajorVersion ()

static int	GetKVMinorVersion ()

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

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

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. More...

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

static void	InitEnvironment ()

static bool	is_gnuinstall ()

static Bool_t	IsEnvInit ()

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. More...

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

◆ KVDetectionSimulator() [1/2]

KVDetectionSimulator::KVDetectionSimulator ( )

inline

Definition at line 34 of file KVDetectionSimulator.h.

◆ KVDetectionSimulator() [2/2]

KVDetectionSimulator::KVDetectionSimulator	(	KVMultiDetArray *	a,
		Double_t	e_cut_off = `1.e-3`
	)

Initialise a detection simulator

The detector array is put into simulation mode, and the minimum cut-off energy for propagation of particles is set (1 keV is default)

Definition at line 16 of file KVDetectionSimulator.cpp.

Member Function Documentation

◆ ClearHitGroups()

void KVDetectionSimulator::ClearHitGroups ( )

inline

Reset any detectors/groups hit by previous detection

Definition at line 81 of file KVDetectionSimulator.h.

◆ DetectEvent()

void KVDetectionSimulator::DetectEvent	(	KVEvent *	event,
		const Char_t *	detection_frame = `""`
	)

Simulate detection of event by multidetector array.

optional argument detection_frame(="" by default) can be used to give name of inertial reference frame (defined for all particles of 'event') to be used. e.g. if the simulated event's default reference frame is the centre of mass frame, before calling this method you should create the 'laboratory' or 'detector' frame with KVEvent::SetFrame(...), and then give the name of the 'LAB' or 'DET' frame as 3rd argument here.

For each particle in the event we calculate first its energy loss in the target (if the target has been defined, see KVMultiDetArray::SetTarget). By default these energy losses are calculated from a point half-way along the beam-direction through the target (taking into account the orientation of the target), if you want random depths for each event call GetTarget()->SetRandomized() before using DetectEvent().

If the particle escapes the target then we look for the group in the array that it will hit. If there is one, then the detection of this particle by the different members of the group is simulated.

The detectors concerned have their fEloss members set to the energy lost by the particle when it crosses them.

Give tags to the simulated particles via KVNucleus::AddGroup() method Two general tags :

DETECTED : cross at least one active layer of one detector
UNDETECTED : go through dead zone or stopped in target We add also different sub group :
For UNDETECTED particles : "NO HIT", "NEUTRON", "DEAD ZONE", "STOPPED IN TARGET" and "THRESHOLD", the last one concerns particles which go through the first detection stage of the multidetector array but stopped in an absorber (ie an inactive layer)
For DETECTED particles :
"PUNCH THROUGH" corrresponds to particle which cross all the materials in front of it (high energy particle punch through)
"INCOMPLETE" corresponds to particles which stopped in the first detection stage of the multidetector in a detector which can not give alone a clear identification,

Definition at line 62 of file KVDetectionSimulator.cpp.

◆ get_array_navigator()

KVRangeTableGeoNavigator* KVDetectionSimulator::get_array_navigator ( ) const

inlineprivate

name of kinematical frame used in last call to DetectEvent()

Definition at line 28 of file KVDetectionSimulator.h.

◆ GetArray()

KVMultiDetArray* KVDetectionSimulator::GetArray ( ) const

inline

Definition at line 54 of file KVDetectionSimulator.h.

◆ GetDetectionFrame()

TString KVDetectionSimulator::GetDetectionFrame ( ) const

inline

Returns: name of kinematical frame given in last call to DetectEvent()

Definition at line 87 of file KVDetectionSimulator.h.

◆ GetMinKECutOff()

Double_t KVDetectionSimulator::GetMinKECutOff ( ) const

inline

Definition at line 70 of file KVDetectionSimulator.h.

◆ GetTarget()

KVTarget* KVDetectionSimulator::GetTarget ( ) const

inline

Definition at line 58 of file KVDetectionSimulator.h.

◆ IncludeTargetEnergyLoss()

Bool_t KVDetectionSimulator::IncludeTargetEnergyLoss ( ) const

inline

Definition at line 66 of file KVDetectionSimulator.h.

◆ PropagateParticle()

KVNameValueList KVDetectionSimulator::PropagateParticle ( KVNucleus * part )

private

Simulate detection of a single particle

Propagate particle through the array, calculating its energy losses in all absorbers, and setting the energy loss members of the active detectors on the way.

Returns a list containing the name and energy loss of each detector hit in array (list is empty if none i.e. particle in beam pipe or dead zone of the multidetector)

Definition at line 207 of file KVDetectionSimulator.cpp.

◆ SetArray()

void KVDetectionSimulator::SetArray	(	KVMultiDetArray *	a,
		Double_t	e_cut_off = `1.e-3`
	)

inline

set mode for target energy loss calculations

Definition at line 45 of file KVDetectionSimulator.h.

◆ SetGeometricFilterMode()

void KVDetectionSimulator::SetGeometricFilterMode ( )

inline

In geometric filter mode, energy loss in target is not calculated and particles do not need to have sufficient energy to reach the detectors

Definition at line 37 of file KVDetectionSimulator.h.

◆ SetIncludeTargetEnergyLoss()

void KVDetectionSimulator::SetIncludeTargetEnergyLoss ( Bool_t y = kTRUE )

inline

Definition at line 62 of file KVDetectionSimulator.h.

◆ SetMinKECutOff()

void KVDetectionSimulator::SetMinKECutOff ( Double_t cutoff )

inline

Definition at line 74 of file KVDetectionSimulator.h.

Member Data Documentation

◆ fArray

KVMultiDetArray* KVDetectionSimulator::fArray = nullptr

private

Definition at line 22 of file KVDetectionSimulator.h.

◆ fCalcTargELoss

Bool_t KVDetectionSimulator::fCalcTargELoss = kTRUE

private

Definition at line 24 of file KVDetectionSimulator.h.

◆ fDetectionFrame

TString KVDetectionSimulator::fDetectionFrame

private

when true, only consider geometry, not particle energies

Definition at line 26 of file KVDetectionSimulator.h.

◆ fGeoFilter

Bool_t KVDetectionSimulator::fGeoFilter = kFALSE

private

whether to include energy loss in target, if defined

Definition at line 25 of file KVDetectionSimulator.h.

◆ fHitGroups

KVDetectorEvent KVDetectionSimulator::fHitGroups

private

array used for detection

used to reset hit detectors in between events

Definition at line 23 of file KVDetectionSimulator.h.

Detailed Description

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVDetectionSimulator() [1/2]

◆ KVDetectionSimulator() [2/2]

Member Function Documentation

◆ ClearHitGroups()

◆ DetectEvent()

◆ get_array_navigator()

◆ GetArray()

◆ GetDetectionFrame()

◆ GetMinKECutOff()

◆ GetTarget()

◆ IncludeTargetEnergyLoss()

◆ PropagateParticle()

◆ SetArray()

◆ SetGeometricFilterMode()

◆ SetIncludeTargetEnergyLoss()

◆ SetMinKECutOff()

Member Data Documentation

◆ fArray

◆ fCalcTargELoss

◆ fDetectionFrame

◆ fGeoFilter

◆ fHitGroups