KaliVeda
Toolkit for HIC analysis
KVGeoImport Class Reference

Detailed Description

Import detector array described by ROOT geometry and set up corresponding KVMultiDetArray object.

To use:

gImp.ImportGeometry();
Import detector array described by ROOT geometry and set up corresponding KVMultiDetArray object.
Definition: KVGeoImport.h:69
static KVIonRangeTable * GetRangeTable()
Definition: KVMaterial.cpp:158
Base class for describing the geometry of a detector array.

RULES FOR VALID DETECTOR GEOMETRY

1.) All detector volumes & nodes must have names which begin with DET_

2.) They must be made of materials which are known by the range table fRangeTable.

3.) For multi-layer detectors, the active layer volume/node must have a name beginning with ACTIVE_

4.) The "thickness" of the detector or any layer inside a multilayer detector will be taken as the size of the volume's shape along its Z-axis (so make sure that you define your detector volumes in this way).

5.) It is assumed that the natural length units of the geometry are centimetres.

6.) The name of the KVDetector object created and added to the array will be taken from the unique full path of the node corresponding to the geometrical positioning of the detector, see KVGeoNavigator::ExtractDetectorNameFromPath()

STRUCTURE ELEMENTS

A structure element is any association of detectors which may occur several times in a geometry in different places, with the same internal structure.

Example: a wall of detectors in a rectangular array.

The detectors in the wall may all be represented by a single volume (if they are identical) called DET_SI, for example, which is placed N times in N different positions on nodes called, by default, DET_SI_1, DET_SI_2, etc.

Once you have defined the wall volume, call it STRUCT_SIWALL (or whatever you want: only the STRUCT_ part is mandatory). Now you can place the same wall structure in different positions of your geometry on nodes called STRUCT_SIWALL_1, STRUCT_SIWALL_2, etc.

This will give a full path to the node of DET_SI_1 in SIWALL_2 like this:

/TOP_1/STRUCT_SIWALL_2/DET_SI_1

which will be interpreted by KVGeoNavigator::ExtractDetectorNameFromPath() as a detector with unique name: SIWALL_2_SI_1 (the STRUCT_ and DET_ parts are stripped off).

Definition at line 69 of file KVGeoImport.h.

#include <KVGeoImport.h>

Inheritance diagram for KVGeoImport:

Public Member Functions

 KVGeoImport (TGeoManager *, KVIonRangeTable *, KVMultiDetArray *, Bool_t create=kTRUE)
 
void AddAcceptedDetectorName (const char *name)
 
void ImportGeometry (Double_t dTheta=0.1, Double_t dPhi=1.0, Double_t ThetaMin=0.0, Double_t PhiMin=0.0, Double_t ThetaMax=180.0, Double_t PhiMax=360.0)
 
void ParticleEntersNewVolume (KVNucleus *) override
 All detectors crossed by the particle's trajectory are added to the multidetector. More...
 
void PropagateParticle (KVNucleus *, TVector3 *TheOrigin=nullptr) override
 
void SetDetectorPlugin (const TString &name)
 
void SetLastDetector (KVDetector *d)
 
void SetOrigin (double x, double y, double z)
 
- Public Member Functions inherited from KVGeoNavigator
 KVGeoNavigator (TGeoManager *)
 Constructor. Call with pointer to geometry. More...
 
virtual ~KVGeoNavigator ()
 Destructor. More...
 
void AbsorbDetectorPaths (KVGeoNavigator *GN)
 
virtual void AddPointToCurrentTrack (Double_t, Double_t, Double_t)
 
const TClonesArrayCurrentStructures () const
 
void DrawTracks (KVNumberList *=nullptr)
 
void ExtractDetectorNameFromPath (KVString &)
 
TGeoVolumeGetCurrentDetectorNameAndVolume (KVString &, Bool_t &, Bool_t &segmented)
 
TGeoNodeGetCurrentDetectorNode () const
 
const TGeoHMatrixGetCurrentMatrix () const
 Returns pointer to internal copy of current global transformation matrix. More...
 
TGeoNodeGetCurrentNode () const
 
TString GetCurrentPath () const
 
TGeoVolumeGetCurrentVolume () const
 
const Char_tGetDetectorNameFormat () const
 
const TVector3GetEntryPoint () const
 
const TVector3GetExitPoint () const
 
TGeoManagerGetGeometry () 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 More...
 
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. 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_tGetLabel () const
 
UInt_t GetNumber () const
 
virtual TObjectGetObject () const
 
virtual const Char_tGetType () 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 ()
 
KVBaseoperator= (const KVBase &)
 copy assignment operator More...
 
void Print (Option_t *option="") const override
 
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 ()
 
TObjectClone (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
 
TClassIsA () const override
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 
TNamedoperator= (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 TObjectDrawClone (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 TObjectFindObject (const char *name) const
 
virtual TObjectFindObject (const TObject *obj) const
 
virtual Option_tGetDrawOption () const
 
virtual const char * GetIconName () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 
virtual Option_tGetOption () 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)
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (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
 

Additional Inherited Members

- Public Types inherited from KVBase
enum  EKaliVedaBits { kIsKaliVedaObject = BIT(23) }
 
enum class  GetX_status {
  ok , above_maximum , below_minimum , at_maximum ,
  at_minimum
}
 
- Public Types inherited from TObject
enum  EDeprecatedStatusBits
 
enum  EStatusBits
 
- Static Public Member Functions inherited from KVBase
static std::optional< TStringAbsoluteUnixPath (const TString &)
 
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_tFindFile (const Char_t *search, TString &wfil)
 
static const Char_tGetBINDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetDATABASEFilePath ()
 
static const Char_tGetDATADIRFilePath (const Char_t *namefile="")
 
template<typename ValType >
static ValType GetDataSetEnv (const KVString &dataset, const KVString &type, const ValType &defval={})
 
static const Char_tGetETCDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetExampleFilePath (const Char_t *library, const Char_t *namefile)
 Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.) More...
 
static const Char_tGetINCDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetKVBuildDate ()
 Returns KaliVeda build date. More...
 
static const Char_tGetKVBuildDir ()
 Returns top-level directory used for build. More...
 
static const Char_tGetKVBuildTime ()
 Returns KaliVeda build time. More...
 
static const Char_tGetKVBuildType ()
 Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...) More...
 
static const Char_tGetKVBuildUser ()
 Returns username of person who performed build. More...
 
static int GetKVMajorVersion ()
 
static int GetKVMinorVersion ()
 
static int GetKVPatchVersion ()
 
static const Char_tGetKVSourceDir ()
 Returns top-level directory of source tree used for build. More...
 
static const Char_tGetKVVersion ()
 Returns KaliVeda version string. More...
 
static const Char_tGetLIBDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetListOfPlugins (const Char_t *base)
 
static const Char_tGetListOfPluginURIs (const Char_t *base)
 
static const Char_tGetPluginURI (const Char_t *base, const Char_t *plugin)
 
static void GetTempFileName (TString &base)
 
static const Char_tGetTEMPLATEDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetWORKDIRFilePath (const Char_t *namefile="")
 
static const Char_tgitBranch ()
 Returns git branch of sources. More...
 
static const Char_tgitCommit ()
 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 TPluginHandlerLoadPlugin (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 Double_t ProtectedGetX (const TF1 &func, Double_t val, GetX_status &status, std::optional< Double_t > xmin={}, std::optional< Double_t > xmax={})
 
static Double_t ProtectedGetX (const TF1 *func, Double_t val, GetX_status &status, std::optional< Double_t > xmin={}, std::optional< Double_t > xmax={})
 
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_tWorkingDirectory ()
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
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

◆ KVGeoImport()

KVGeoImport::KVGeoImport ( TGeoManager g,
KVIonRangeTable r,
KVMultiDetArray m,
Bool_t  create = kTRUE 
)

Import geometry described by TGeoManager into KVMultiDetArray object

if create=kFALSE, we do not create any detectors etc., but just set up the required links between the geometry and the existing array detectors

We change the colours of volumes depending on their material

Definition at line 29 of file KVGeoImport.cpp.

Member Function Documentation

◆ AddAcceptedDetectorName()

void KVGeoImport::AddAcceptedDetectorName ( const char *  name)

Add to list of acceptable detector names when scanning geometry Each detector volume name will be tested; if it doesn't contain any of the (partial) detector names in the list, it will be ignored

Definition at line 237 of file KVGeoImport.cpp.

◆ ImportGeometry()

void KVGeoImport::ImportGeometry ( Double_t  dTheta = 0.1,
Double_t  dPhi = 1.0,
Double_t  ThetaMin = 0.0,
Double_t  PhiMin = 0.0,
Double_t  ThetaMax = 180.0,
Double_t  PhiMax = 360.0 
)

Scan the geometry in order to find all detectors and detector alignments.

This is done by sending out "particles" from \((0,0,0)\) or \((x,y,z)\) (if SetOrigin() was called beforehand) in all directions between (ThetaMin,ThetaMax) - with respect to Z-axis - and (PhiMin,PhiMax) - cylindrical angle in the (X,Y)-plane, over a grid of step dTheta in Theta and dPhi in Phi.

Definition at line 168 of file KVGeoImport.cpp.

◆ ParticleEntersNewVolume()

void KVGeoImport::ParticleEntersNewVolume ( KVNucleus )
overridevirtual

All detectors crossed by the particle's trajectory are added to the multidetector.

Reimplemented from KVGeoNavigator.

Definition at line 65 of file KVGeoImport.cpp.

◆ PropagateParticle()

void KVGeoImport::PropagateParticle ( KVNucleus nuc,
TVector3 TheOrigin = nullptr 
)
overridevirtual

Override KVGeoNavigator method We build the list of all trajectories through the array

Reimplemented from KVGeoNavigator.

Definition at line 204 of file KVGeoImport.cpp.

◆ SetDetectorPlugin()

void KVGeoImport::SetDetectorPlugin ( const TString name)
inline

Definition at line 111 of file KVGeoImport.h.

◆ SetLastDetector()

void KVGeoImport::SetLastDetector ( KVDetector d)
inline

Definition at line 106 of file KVGeoImport.h.

◆ SetOrigin()

void KVGeoImport::SetOrigin ( double  x,
double  y,
double  z 
)
inline

Call this method if needed before calling ImportGeometry in order to shoot particles from an arbitrary point (x,y,z) instead of (0,0,0). This can be useful if the detector array is "misaligned" so that its telescopes are not pointing towards the theoretical origin (i.e. target position).

Definition at line 117 of file KVGeoImport.h.