Detailed Description

Base class for detector geometry description, interface to energy-loss calculations.

KVDetector is the base class for the description of all individual detectors in the KaliVeda framework. A detector is defined by the following characteristics:

it is composed of one or more absorber layers in which the energy loss of charged particles can be measured or calculated, described by KVMaterial objects;
it has a single active layer in which energy losses may be associated to data read out from some electronics/DAQ system via objects of the KVDetectorSignal class;
it can be attributed KVCalibrator objects used to transform raw KVDetectorSignal data into calibrated KVCalibratedSignal data;
it can have spacial dimensions and position (parent class KVPosition), when it is part of a KVMultiDetArray (array of detectors) deduced from a ROOT geometry description using class KVGeoImport:
- in this case, each KVDetector is associated with a node (KVGeoDetectorNode) in the geometry;
- each node is part of one or more trajectories (KVGeoDNTrajectory) which describe the possible flight paths of particles through the detectors of the array;
- the trajectories allow to describe the spacial relationships between the different detectors of the array ("in front", "behind"), from which $\Delta E-E$ telescopes (KVIDTelescope) can be deduced which group pairs of adjacent detectors along the trajectories;
- each detector is also the first node of a trajectory leading back towards the target (KVReconNucTrajectory) which is used in event reconstruction (KVEventReconstructor, KVGroupReconstructor) to determine the trajectory of reconstructed nuclei (KVReconstructedNucleus) starting from the detectors the furthest from the target which are fired in each event read from the raw data (KVRawDataReconstructor).

Example 1: defining a detector

KVDetector chio("Myl", 2.5*KVUnits::um);                       //first layer - 2.5 micron mylar window
KVMaterial *gas = new KVMaterial("C3F8", 5.*KVUnits::cm, 50.0*KVUnits::mbar);
chio.AddAbsorber(gas);                                         //second layer - 5cm of C3F8 gas at 50mbar pressure
chio.SetActiveLayer(gas);                                      //make gas layer "active"
KVMaterial *win = new KVMaterial("Myl",2.5*KVUnits::um);       //exit window
chio.AddAbsorber(win);

A detector is created either with the constructor taking the material type as argument:

KVDetector det("Si");

or using SetMaterial:

KVDetector det;

det.SetMaterial("Si");

KVDetector::SetMaterial

void SetMaterial(const Char_t *type) override

Definition: KVDetector.cpp:169

or it is created when a ROOT geometry is imported into a KVMultiDetArray object using KVGeoImport.

Calculate the energy loss of a charged particle in a detector

Two methods are available: one simply calculates the energy lost by the particle in the detector, but does not modify either the particle or the detector (GetELostByParticle()); the other simulates the passage of the particle through the detector, the particle's energy is reduced by the amount lost in the detector's absorbers and the total energy lost in the detector is increased, e.g.:

KVNucleus alpha(2,4);           //an alpha-particle
alpha.SetEnergy(100);           //with 100MeV kinetic energy
det.DetectParticle(&alpha);     //simulate passage of particle in the detector/target
det.GetEnergy();                        //energy lost by particle in detector/target
alpha.GetEnergy();                      //residual energy of particle
det.Clear();                            //reset detector ready for a new detection
 
KVNucleus xe("129Xe", 50.0);   // 50 MeV/nucleon 129Xe ion
 
chio.DetectParticle(&xe);
 
chio.GetEnergyLoss()
(double) 48.309654        // energy loss in gas (active) layer
 
xe.GetEnergy()
(double) 6380.9388       // kinetic energy of 129Xe after detector
 
50*129 - xe.GetEnergy() - chio.GetEnergyLoss()
(double) 20.751563       // energy lost in Mylar windows
 
chio.GetIncidentEnergy(54,129,chio.GetEnergyLoss())
(double) 6450.0000 // deduce incident energy from dE - corrected for Mylar
 
chio.GetIncidentEnergyFromERes(54,129,xe.GetEnergy())
(double) 6450.0000 // deduce incident energy from Eres - corrected for Mylar

Several methods are also provided in order to deduce either incident energy, $E_{inc}$, energy loss $\Delta E$, or residual energy, $E_{res}=E_{inc}-\Delta E$, from one of the others. All such methods are summarized in the following table:

	calculate $E_{inc}$	calculate $\Delta E$	calculate $E_{res}$
from $E_{inc}$	-	GetDeltaE()	GetERes()
from $E_{inc}$		GetELostByParticle()
from $\Delta E$	GetIncidentEnergy()	-	GetEResFromDeltaE()
from $E_{res}$	GetIncidentEnergyFromERes()	GetDeltaEFromERes()	-
from $E_{res}$	GetParticleEIncFromERes()

For more details on the underlying range tables, see parent class KVMaterial and Energy loss & range calculations in the Users Guide.

Important note on detector positions, angles, solid angle, distances etc.

For detector geometries based on the ROOT geometry package, the following methods refer to the surface of the first volume constituting the detector crossed from the target (referred to as the "entrance window"):

TVector3 GetRandomDirection();
void GetRandomAngles();
TVector3 GetDirection();
TVector3 GetCentreOfEntranceWindow() const;
Double_t GetTheta() const;
Double_t GetSinTheta() const;
Double_t GetCosTheta() const;
Double_t GetPhi();
Double_t GetDistance() const;
Double_t GetSolidAngle(void);

Definition at line 173 of file KVDetector.h.

#include <KVDetector.h>

Inheritance diagram for KVDetector:

[legend]

Public Member Functions
	KVDetector ()
	default ctor More...

	KVDetector (const Char_t *gas, const Double_t thick, const Double_t pressure, const Double_t temperature=19.0)

	KVDetector (const Char_t *type, const Float_t thick=0.0)
	Create a new detector of a given material and thickness in centimetres (default value = 0.0) More...

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

virtual	~ KVDetector ()

void	AddAbsorber (KVMaterial *)

Bool_t	AddCalibrator (KVCalibrator *cal, const KVNameValueList &opts="")

KVDetectorSignal *	AddDetectorSignal (const KVString &type)

Bool_t	AddDetectorSignalExpression (const KVString &type, const KVString &_expr)

KVDetectorSignalTrace *	AddDetectorSignalTrace ()

virtual void	AddEnergyLossInSubDetector (int, double)

void	AddHit (KVNucleus *part)

void	AddParentStructure (KVGeoStrucElement *elem)

Bool_t	BelongsToIdentifiedParticle () const

Bool_t	BelongsToUnidentifiedParticle () const

void	Clear (Option_t *opt="") override

void	ClearHits ()

void	Copy (TObject &obj) const override

void	DetectParticle (KVNucleus , TVector3 norm=0) override

virtual KVDrawable< TGraph >	DrawPunchThroughEnergyVsZ (Int_t massform=KVNucleus::kBetaMass)

virtual KVDrawable< TGraph >	DrawPunchThroughEsurAVsZ (Int_t massform=KVNucleus::kBetaMass)

virtual Int_t	FindZmin (Double_t ELOSS=-1., Char_t mass_formula=-1)

virtual Bool_t	Fired (Option_t *opt="any") const

KVMaterial *	GetAbsorber (const Char_t *name) const

KVMaterial *	GetAbsorber (Int_t i) const
	Returns pointer to the i-th absorber in the detector (i=0 first absorber, i=1 second, etc.) More...

KVMaterial *	GetActiveLayer () const override

TGeoHMatrix *	GetActiveLayerMatrix () const

TGeoBBox *	GetActiveLayerShape () const

TVector3	GetActiveLayerSurfaceCentre () const

TVector3	GetActiveLayerVolumeCentre () const

virtual Double_t	GetCalibratedEnergy () const

KVCalibrator *	GetCalibrator (const Char_t name, const Char_t type) const

KVCalibrator *	GetCalibrator (const Char_t *type) const

const TVector3	GetCentreOfEntranceWindow () const

virtual Double_t	GetCorrectedEnergy (KVNucleus *, Double_t e=-1., Bool_t transmission=kTRUE)

Double_t	GetCosineMaximumMisalignmentAngle () const override

Double_t	GetCosTheta () const override

Double_t	GetDeltaE (Int_t Z, Int_t A, Double_t Einc, Double_t=0.) override

Double_t	GetDeltaEFromERes (Int_t Z, Int_t A, Double_t Eres) override

virtual KVDetectorSignal *	GetDetectorSignal (const KVString &type) const

Double_t	GetDetectorSignalValue (const KVString &type, const KVNameValueList &params="") const

TVector3	GetDirection () override

Double_t	GetDistance () const override

Double_t	GetEIncOfMaxDeltaE (Int_t Z, Int_t A) override

virtual TF1 *	GetELossFunction (Int_t Z, Int_t A)

Double_t	GetELostByParticle (KVNucleus , TVector3 norm=0) override

virtual Double_t	GetEnergy () const

Double_t	GetEnergyLoss () const override

const KVPosition &	GetEntranceWindow () const

virtual Double_t	GetEntranceWindowSurfaceArea ()
	Return surface area of first layer of detector in cm2. More...

Double_t	GetERes (Int_t Z, Int_t A, Double_t Einc, Double_t=0.) override

virtual Double_t	GetEResAfterDetector () const

virtual TF1 *	GetEResFunction (Int_t Z, Int_t A)

KVGroup *	GetGroup () const

UInt_t	GetGroupNumber ()

Double_t	GetIncidentEnergy (Int_t Z, Int_t A, Double_t delta_e=-1.0, enum SolType type=kEmax) override

Double_t	GetIncidentEnergyFromERes (Int_t Z, Int_t A, Double_t Eres) override

virtual Int_t	GetIndex () const

Double_t	GetInverseDetectorSignalValue (const KVString &output, Double_t value, const KVString &input, const KVNameValueList &params="") const

Double_t	GetLinearRange (Int_t Z, Int_t A, Double_t Einc) override

const KVList *	GetListOfAbsorbers () const

KVList *	GetListOfCalibrators () const

const KVSeqCollection &	GetListOfDetectorSignals () const

const KVSeqCollection &	GetListOfDetectorSignalsForRawTree () const

const Char_t *	GetMaterialName () const

Double_t	GetMaxDeltaE (Int_t Z, Int_t A) override

Double_t	GetMaximumMisalignmentAngle () const override

const Char_t *	GetNameOfArray () const

Int_t	GetNHits () const
	Return the number of particles hitting this detector in an event. More...

KVGeoDetectorNode *	GetNode ()

TVector3	GetNormalToDetector () const

Int_t	GetNumberOfAbsorberLayers () const

KVGeoStrucElement *	GetParentStructure (const Char_t type, const Char_t name="") const

Double_t	GetParticleEIncFromERes (KVNucleus , TVector3 norm=0) override

Double_t	GetPhi () const override

Double_t	GetPunchThroughEnergy (Int_t Z, Int_t A) override

void	GetRandomAngles (Double_t &th, Double_t &ph, Option_t *t="isotropic") override

TVector3	GetRandomDirection (Option_t *t="isotropic") override

Double_t	GetRange (Int_t Z, Int_t A, Double_t Einc) override

virtual TF1 *	GetRangeFunction (Int_t Z, Int_t A)

Double_t	GetSinTheta () const override

virtual Double_t	GetSmallestEmaxValid (Int_t Z, Int_t A) const

Double_t	GetSolidAngle () const override

Double_t	GetTheta () const override

virtual Double_t	GetTotalDeltaE (Int_t Z, Int_t A, Double_t Einc)

Double_t	GetTotalThicknessInCM () const

Bool_t	HasDetectorSignal (const KVString &type) const

Bool_t	HasSameStructureAs (const KVDetector *) const

void	IncrementIdentifiedParticles (Int_t n=1)

void	IncrementUnidentifiedParticles (Int_t n=1)

void	init ()
	default initialisations More...

Bool_t	IsAnalysed ()

Bool_t	IsCalibrated (const KVNameValueList &params={}) const

virtual Bool_t	IsDetecting () const

Bool_t	IsGasDetector () const

Bool_t	IsMultiLayer () const

virtual Bool_t	IsOK () const

virtual Bool_t	IsPresent () const

virtual Bool_t	IsSegmented () const

virtual Bool_t	IsSimMode () const

Bool_t	IsSingleLayer () const

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

virtual void	ReadDefinitionFromFile (const Char_t *)

void	RemoveAllAbsorbers ()

virtual void	RemoveCalibrators ()

auto	RemoveHit (KVNucleus *part)

void	RemoveParentStructure (KVGeoStrucElement *elem)

Bool_t	ReplaceCalibrator (const Char_t type, KVCalibrator cal, const KVNameValueList &opts="")

virtual void	Reset (Option_t *opt="")

void	SetActiveLayer (Int_t i)

void	SetActiveLayer (KVMaterial *actif)

void	SetActiveLayerMatrix (const TGeoHMatrix *)
	Set ROOT geometry global matrix transformation to coordinate frame of active layer volume. More...

void	SetActiveLayerShape (TGeoBBox *)
	Set ROOT geometry shape of active layer volume. More...

void	SetAnalysed (Bool_t b=kTRUE)

void	SetDetecting (Bool_t yes=kTRUE)

void	SetDetectorSignalValue (const KVString &type, Double_t val) const

virtual void	SetEnergy (Double_t e) const

void	SetEnergyLoss (Double_t e) const override

void	SetEntranceWindowMatrix (const TGeoHMatrix *)
	Set ROOT geometry global matrix transformation to coordinate frame of entrance window. More...

void	SetEntranceWindowShape (TGeoBBox *)
	Set ROOT geometry shape of entrance window. More...

virtual void	SetEResAfterDetector (Double_t e)

void	SetMaterial (const Char_t *type) override

void	SetNameOfArray (const TString &n)

void	SetPresent (Bool_t yes=kTRUE)

void	SetPressure (Double_t P) override

virtual void	SetSimMode (Bool_t on=kTRUE)

void	SetTemperature (Double_t T) override

void	SetThickness (Double_t thick) override

Public Member Functions inherited from KVMaterial
	KVMaterial ()
	default ctor More...

	KVMaterial (const Char_t *gas, const Double_t thick, const Double_t pressure, const Double_t temperature=19.0)

	KVMaterial (const Char_t *type, const Double_t thick=0.0)
	Create material with given type and linear thickness in cm. More...

	KVMaterial (const KVMaterial &)
	Copy ctor. More...

	KVMaterial (Double_t area_density, const Char_t *type)
	Create material with given area density in $g/cm^{2}$ and given type. More...

virtual	~ KVMaterial ()

void	Clear (Option_t *opt="") override
	Reset absorber - set stored energy lost by particles in absorber to zero. More...

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

virtual TGeoVolume *	GetAbsGeoVolume () const

Double_t	GetAreaDensity () const

Double_t	GetDensity () const

Double_t	GetEffectiveAreaDensity (const TVector3 &norm, const TVector3 &direction)

Double_t	GetEffectiveThickness (const TVector3 &norm, const TVector3 &direction)

Double_t	GetEmaxValid (Int_t Z, Int_t A)

virtual Double_t	GetEResFromDeltaE (Int_t Z, Int_t A, Double_t dE=-1.0, enum SolType type=kEmax)

virtual TGeoMedium *	GetGeoMedium (const Char_t *="")

virtual KVDrawable< TGraph >	GetGraphOfDeltaEVsE (const KVNucleus &nuc, Int_t npts, Double_t Emin, Double_t Emax)

Double_t	GetMass () const

virtual Double_t	GetPressure () const

virtual Double_t	GetTemperature () const

virtual Double_t	GetThickness () const

Double_t	GetZ () const

void	init ()

Bool_t	IsGas () const

Bool_t	IsIsotopic () const

Bool_t	IsNat () const

void	Print (Option_t *option="") const override
	Show information on this material. More...

virtual void	SetAbsGeoVolume (TGeoVolume *v)

void	SetAreaDensity (Double_t dens)

void	SetDensity (Double_t)

void	SetMass (Int_t a)

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

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

Public Member Functions inherited from KVPosition
	KVPosition ()=default

	KVPosition (const KVPosition &o)

	KVPosition (Double_t thmin, Double_t thmax, Double_t phmin, Double_t phmax, Double_t dist=0.0)

	KVPosition (KVPosition &&other)

virtual	~KVPosition ()=default

void	CalculateEstimatedAngularLimits (int N=10000)

Double_t	GetAzimuthalWidth (Double_t phmin=-1., Double_t phimax=-1.) const

void	GetCornerCoordinates (TVector3 *, Double_t=0)

void	GetCornerCoordinatesInOwnFrame (TVector3 *, Double_t=0)

Double_t	GetPhiMax () const

Double_t	GetPhiMin () const

TRotation	GetRandomIsotropicRotation ()

Double_t	GetThetaMax () const

Double_t	GetThetaMin () const

void	GetWidthsFromDimension (Double_t lin_dim)

Bool_t	IsAlignedWith (KVPosition *pos)
	kTRUE if one of the two solid angle elements is completely contained within the other. More...

Bool_t	IsAzimuthallyWiderThan (KVPosition *pos)

Bool_t	IsInPhiRange (const Double_t phi)

Bool_t	IsInPolarRange (const Double_t theta)
	kTRUE if given angle theta is within the polar range of this solid angle element More...

Bool_t	IsOverlappingWith (KVPosition *pos)
	kTRUE if there is at least partial overlap between two solid angle elements More...

Bool_t	IsSmallerThan (KVPosition *pos)
	kTRUE if "this" is entirely contained within "pos" More...

KVPosition &	operator= (KVPosition other)

virtual Bool_t	ROOTGeo () const

virtual void	SetAzimuthalAngle (Double_t ph)

virtual void	SetAzimuthalMinMax (Double_t min, Double_t max)
	Set min and max azimuthal angles and calculate (mean) phi. More...

virtual void	SetAzimuthalWidth (Double_t aw)

void	SetDistance (Double_t d)

void	SetPhi (Double_t p)

void	SetPhiMinMax (Double_t min, Double_t max)

virtual void	SetPolarAngle (Double_t th)

virtual void	SetPolarMinMax (Double_t min, Double_t max)
	Set min and max polar angles and calculate (mean) theta. More...

virtual void	SetPolarWidth (Double_t pw)

void	SetTheta (Double_t t)

Static Public Member Functions
static KVDetector *	MakeDetector (const Char_t *name, Float_t thick)

Static Public Member Functions inherited from KVMaterial
static KVIonRangeTable *	ChangeRangeTable (const Char_t *name)

static KVIonRangeTable *	GetRangeTable ()

Static Public Member Functions inherited from KVBase
static std::optional< TString >	AbsoluteUnixPath (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_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="")

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

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

Private Types
enum	{ kIsAnalysed = BIT(14) , kActiveSet = BIT(15) , kUnidentifiedParticle = BIT(16) , kIdentifiedParticle = BIT(17) }

Private Member Functions
void	AddDetectorSignal (KVDetectorSignal *ds)

Double_t	ELossActive (Double_t x, Double_t par)

Double_t	EResDet (Double_t x, Double_t par)

template<typename AbsorberStack >
Double_t	get_corrected_energy (AbsorberStack stack, KVNucleus nuc, Double_t e, Bool_t transmission)

TGeoHMatrix *	GetMatrix () const override

TVector3	GetNormalIntoShape () const override

TVector3	GetRandomPointOnSurface () const override

TGeoBBox *	GetShape () const override

Double_t	GetSurfaceArea (int npoints=100000) const override

TVector3	GetSurfaceCentre () const override

TVector3	GetVolumeCentre () const override

Double_t	RangeDet (Double_t x, Double_t par)

void	remove_signal_for_calibrator (KVCalibrator *K)

void	SetMatrix (const TGeoHMatrix *m) override

void	SetShape (TGeoBBox *s) override

virtual Bool_t	use_signal_for_raw_data_tree (const TString &) const

Private Attributes
KVList	fAbsorbers
	list of absorbers making up the detector More...

KVMaterial *	fActiveLayer
	The active absorber in the detector. More...

KVList *	fCalibrators
	list of associated calibrator objects More...

Bool_t	fDetecting
	=kTRUE if detector is "detecting", =kFALSE if not More...

KVUniqueNameList	fDetSignals
	list of signals associated with detector More...

KVUniqueNameList	fDetSignalsForRawTree
	list of signals used for raw data TTree More...

TF1 *	fELossF
	parametric function dE in active layer vs. incident energy More...

TF1 *	fEResF
	parametric function Eres residual energy after all layers of detector More...

Double_t	fEResforEinc
	used by GetIncidentEnergy & GetCorrectedEnergy More...

KVPosition	fEWPosition
	position of entrance window i.e. first volume in detector geometry More...

TString	fFName
	dynamically generated full name of detector More...

Int_t	fIdentP
	temporary counters, determine state of identified/unidentified particle flags More...

TString	fNameOfArray
	name of multidetector array this detector is part of More...

KVGeoDetectorNode	fNode
	positioning information relative to other detectors More...

KVUniqueNameList	fParentStrucList
	list of geometry structures which directly contain this detector More...

KVUnownedList	fParticles
	list of particles hitting detector in an event More...

Bool_t	fPresent
	=kTRUE if detector is present, =kFALSE if it has been removed More...

TF1 *	fRangeF
	parametric function range of particles in detector More...

Bool_t	fSimMode
	=kTRUE when using to simulate detector response, =kFALSE when analysing data More...

Bool_t	fSingleLayer
	=kTRUE if detector has a single absorber layer More...

Int_t	fUnidentP
	temporary counters, determine state of identified/unidentified particle flags More...

Static Private Attributes
static Int_t	fDetCounter = 0

Additional Inherited Members
Public Types inherited from KVMaterial
enum	SolType { kEmax , kEmin }

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

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

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
kIsAnalysed
kActiveSet
kUnidentifiedParticle
kIdentifiedParticle

Definition at line 183 of file KVDetector.h.

Constructor & Destructor Documentation

◆ KVDetector() [1/4]

KVDetector::KVDetector ( )

default ctor

Definition at line 59 of file KVDetector.cpp.

◆ KVDetector() [2/4]

KVDetector::KVDetector	(	const Char_t *	type,
		const Float_t	thick = `0.0`
	)

Create a new detector of a given material and thickness in centimetres (default value = 0.0)

Definition at line 72 of file KVDetector.cpp.

◆ KVDetector() [3/4]

KVDetector::KVDetector	(	const Char_t *	gas,
		const Double_t	thick,
		const Double_t	pressure,
		const Double_t	temperature = `19.0`
	)

Create gaseous dteector with given type, linear thickness in cm, pressure in Torr, and temperature in degrees C (default value 19°C).

Note: this just defines some gas, the 'detector' has no windows!

Definition at line 91 of file KVDetector.cpp.

◆ KVDetector() [4/4]

KVDetector::KVDetector ( const KVDetector & obj )

copy ctor

Definition at line 109 of file KVDetector.cpp.

◆ ~ KVDetector()

virtual KVDetector::~ KVDetector ( )

virtual

Member Function Documentation

◆ AddAbsorber()

void KVDetector::AddAbsorber ( KVMaterial * mat )

Add a layer of absorber material to the detector By default, the first layer added is set as the "Active" layer. Call SetActiveLayer to change this.

Definition at line 592 of file KVDetector.cpp.

◆ AddCalibrator()

Bool_t KVDetector::AddCalibrator	(	KVCalibrator *	cal,
		const KVNameValueList &	opts = `""`
	)

Associate a calibration with this detector.

This will add a new signal to the list of the detector's signals.

Also sets calibrator's name to [detname]_[caltype] where caltype is the type of the KVCalibration object.

Parameters

[in] cal pointer to KVCalibrator object (must be on heap, i.e. created with new: detector handles deletion)

[in]

opts

can be used to pass any extra parameters/options needed by the calibrator. For example, if it contains a parameter ZRange:

ZRange=1-10

then the calibrator will be handled by a KVZDependentCalibratedSignal (handles several calibrators which provide the same output signal, each one is used for a specific range of atomic numbers)

Returns: kFALSE in case of problems (non-existent input signal for calibrator, output signal not defined for calibrator), otherwise kTRUE

Definition at line 421 of file KVDetector.cpp.

◆ AddDetectorSignal() [1/2]

KVDetectorSignal * KVDetector::AddDetectorSignal ( const KVString & type )

Add a new signal to the list of detector's signals.

Parameters

[in] type define the name of the signal to add

Returns: pointer to the new signal object

Note: do not delete{.cpp} the signal object: the detector handles deletion

If the type is "SignalTrace", we add a special KVDetectorSignalTrace object

Definition at line 1834 of file KVDetector.cpp.

◆ AddDetectorSignal() [2/2]

void KVDetector::AddDetectorSignal ( KVDetectorSignal * ds )

inlineprivate

Internal use only.

Add KVDetectorSignal object to list of detector's signals.

Definition at line 287 of file KVDetector.h.

◆ AddDetectorSignalExpression()

Bool_t KVDetector::AddDetectorSignalExpression	(	const KVString &	type,
		const KVString &	_expr
	)

Add a new KVDetectorSignalExpression to this detector

Parameters

[in]	type	the name/type of the new signal
[in]	_expr	mathematical expression using any of the known signals of the detector

Note: If the expression is not valid, no signal will be created and method returns kFALSE.

Definition at line 1880 of file KVDetector.cpp.

◆ AddDetectorSignalTrace()

KVDetectorSignalTrace * KVDetector::AddDetectorSignalTrace ( )

Add a new signal trace (with type "SignalTrace") to the list of detector's signals.

Returns: pointer to the new signal object

Note: do not delete{.cpp} the signal object: the detector handles deletion

Definition at line 1858 of file KVDetector.cpp.

◆ AddEnergyLossInSubDetector()

virtual void KVDetector::AddEnergyLossInSubDetector	(	int	,
		double
	)

inlinevirtual

Reimplemented in KVSegmentedDetector.

Definition at line 864 of file KVDetector.h.

◆ AddHit()

void KVDetector::AddHit ( KVNucleus * part )

inline

Add to the list of particles hitting this detector in an event

Definition at line 424 of file KVDetector.h.

◆ AddParentStructure()

void KVDetector::AddParentStructure ( KVGeoStrucElement * elem )

Definition at line 1662 of file KVDetector.cpp.

◆ BelongsToIdentifiedParticle()

Bool_t KVDetector::BelongsToIdentifiedParticle ( ) const

inline

Definition at line 575 of file KVDetector.h.

◆ BelongsToUnidentifiedParticle()

Bool_t KVDetector::BelongsToUnidentifiedParticle ( ) const

inline

Definition at line 571 of file KVDetector.h.

◆ Clear()

void KVDetector::Clear ( Option_t * opt = "" )

overridevirtual

Set energy loss(es) etc. to zero

If opt="N":

we do not reset acquisition parameters/raw detector signals
in SimMode we do not reset energy losses (this is called before reconstruction happens)

Reimplemented from KVBase.

Reimplemented in KVFAZIADetector, and KVSegmentedDetector.

Definition at line 550 of file KVDetector.cpp.

◆ ClearHits()

void KVDetector::ClearHits ( )

inline

clear the list of particles hitting this detector in an event

Definition at line 442 of file KVDetector.h.

◆ Copy()

void KVDetector::Copy ( TObject & obj ) const

overridevirtual

copy 'this' to 'obj' The structure of the detector is copied, with new cloned objects for each absorber layer. The active layer is set in the new detector.

Reimplemented from KVBase.

Reimplemented in KVFAZIADetector.

Definition at line 130 of file KVDetector.cpp.

◆ DetectParticle()

void KVDetector::DetectParticle	(	KVNucleus *	kvp,
		TVector3 *	norm = `0`
	)

overridevirtual

Calculate the energy loss of a charged particle traversing the detector, the particle is slowed down, it is added to the list of all particles hitting the detector.

The apparent energy loss of the particle in the active layer of the detector is set.

If the optional argument 'norm' is given, it is supposed to be a vector normal to the detector, oriented from the origin towards the detector.

In this case the effective thicknesses of the detector's absorbers 'seen' by the particle depending on its direction of motion is used for the calculation.

Note that if the detector is part of an array geometry, GetEntranceWindow().GetNormalIntoShape() returns a TVector3 unit vector which is the normal to the detector.

Reimplemented from KVMaterial.

Definition at line 200 of file KVDetector.cpp.

◆ DrawPunchThroughEnergyVsZ()

KVDrawable< TGraph > KVDetector::DrawPunchThroughEnergyVsZ ( Int_t massform = KVNucleus::kBetaMass )

virtual

Creates and fills a KVDrawable<TGraph> with the punch through energy in MeV vs. Z for the given detector, for Z=1-92. The mass of each nucleus is calculated according to the given mass formula (see KVNucleus).

Definition at line 1596 of file KVDetector.cpp.

◆ DrawPunchThroughEsurAVsZ()

KVDrawable< TGraph > KVDetector::DrawPunchThroughEsurAVsZ ( Int_t massform = KVNucleus::kBetaMass )

virtual

Creates and fills a KVDrawable<TGraph> with the punch through energy in MeV/nucleon vs. Z for the given detector, for Z=1-92. The mass of each nucleus is calculated according to the given mass formula (see KVNucleus).

Definition at line 1621 of file KVDetector.cpp.

◆ ELossActive()

Double_t KVDetector::ELossActive	(	Double_t *	x,
		Double_t *	par
	)

private

Calculates energy loss (in MeV) in active layer of detector, taking into account preceding layers

Arguments are: x[0] is incident energy in MeV Parameters are: par[0] Z of ion par[1] A of ion

Definition at line 967 of file KVDetector.cpp.

◆ EResDet()

Double_t KVDetector::EResDet	(	Double_t *	x,
		Double_t *	par
	)

private

Calculates residual energy (in MeV) of particle after traversing all layers of detector. Returned value is -1000 if particle stops in one of the layers of the detector.

Arguments are: x[0] is incident energy in MeV Parameters are: par[0] Z of ion par[1] A of ion

Definition at line 1061 of file KVDetector.cpp.

◆ FindZmin()

Int_t KVDetector::FindZmin	(	Double_t	ELOSS = `-1.`,
		Char_t	mass_formula = `-1`
	)

virtual

For particles which stop in the first stage of an identification telescope, we can at least estimate a minimum Z value based on the energy lost in this detector.

This is based on the KVMaterial::GetMaxDeltaE method, giving the maximum energy loss in the active layer of the detector for a given nucleus (A,Z).

The "Zmin" is the Z of the particle which gives a maximum energy loss just greater than that measured in the detector. Particles with Z<Zmin could not lose as much energy and so are excluded.

If ELOSS is not given, we use the current value of GetEnergy() Use 'mass_formula' to change the formula used to calculate the A of the nucleus from its Z. Default is valley of stability value. (see KVNucleus::GetAFromZ).

If the value of ELOSS or GetEnergy() is <=0 we return Zmin=0

Definition at line 897 of file KVDetector.cpp.

◆ Fired()

virtual Bool_t KVDetector::Fired ( Option_t * opt = "any" ) const

inlinevirtual

Returns kTRUE if detector was hit (fired) in an event

The actual meaning of hit/fired depends on the context and the option string opt.

If the detector is in "simulation mode", i.e. if SetSimMode(kTRUE) has been called, this method returns kTRUE if the calculated energy loss in the active layer is > 0.

In "experimental mode" (i.e. IsSimMode() returns kFALSE), depending on the option:

opt="any" (default): Returns true if ANY of the raw parameters associated with the detector were present in the last handled event opt="all" : Returns true if ALL of the raw parameters associated with the detector were present in the last handled event

Reimplemented in KVFAZIADetector.

Definition at line 461 of file KVDetector.h.

◆ get_corrected_energy()

template<typename AbsorberStack >

Double_t KVDetector::get_corrected_energy	(	AbsorberStack *	stack,
		KVNucleus *	nuc,
		Double_t	e,
		Bool_t	transmission
	)

inlineprivate

Definition at line 239 of file KVDetector.h.

◆ GetAbsorber() [1/2]

KVMaterial* KVDetector::GetAbsorber ( const Char_t * name ) const

inline

Return absorber with given name

Definition at line 328 of file KVDetector.h.

◆ GetAbsorber() [2/2]

KVMaterial * KVDetector::GetAbsorber ( Int_t i ) const

Returns pointer to the i-th absorber in the detector (i=0 first absorber, i=1 second, etc.)

Definition at line 608 of file KVDetector.cpp.

◆ GetActiveLayer()

KVMaterial* KVDetector::GetActiveLayer ( ) const

inlineoverridevirtual

Get pointer to the "active" layer in the detector, i.e. the one in which energy losses are measured

Reimplemented from KVMaterial.

Definition at line 322 of file KVDetector.h.

◆ GetActiveLayerMatrix()

TGeoHMatrix* KVDetector::GetActiveLayerMatrix ( ) const

inline

Return coordinate transformation matrix to active layer

Definition at line 599 of file KVDetector.h.

◆ GetActiveLayerShape()

TGeoBBox* KVDetector::GetActiveLayerShape ( ) const

inline

Return geometry of active layer

Definition at line 594 of file KVDetector.h.

◆ GetActiveLayerSurfaceCentre()

TVector3 KVDetector::GetActiveLayerSurfaceCentre ( ) const

inline

Return centre of entrance surface of active layer [this is NOT necessarily the same as the entrance window]

Definition at line 583 of file KVDetector.h.

◆ GetActiveLayerVolumeCentre()

TVector3 KVDetector::GetActiveLayerVolumeCentre ( ) const

inline

Return centre of the active layer volume

Definition at line 589 of file KVDetector.h.

◆ GetCalibratedEnergy()

virtual Double_t KVDetector::GetCalibratedEnergy ( ) const

inlinevirtual

Returns energy loss in detector calculated using available calibration(s)

Definition at line 369 of file KVDetector.h.

◆ GetCalibrator() [1/2]

KVCalibrator * KVDetector::GetCalibrator	(	const Char_t *	name,
		const Char_t *	type
	)		const

inline

Definition at line 869 of file KVDetector.h.

◆ GetCalibrator() [2/2]

KVCalibrator * KVDetector::GetCalibrator ( const Char_t * type ) const

inline

Definition at line 877 of file KVDetector.h.

◆ GetCentreOfEntranceWindow()

const TVector3 KVDetector::GetCentreOfEntranceWindow ( ) const

inline

This method does exactly the same as the method in previous versions of KaliVeda: it returns the vector position of the centre of the surface (entrance) of the "entrance window" of the detector i.e. the first volume encountered

Definition at line 699 of file KVDetector.h.

◆ GetCorrectedEnergy()

Double_t KVDetector::GetCorrectedEnergy	(	KVNucleus *	nuc,
		Double_t	e = `-1.`,
		Bool_t	transmission = `kTRUE`
	)

virtual

Returns: the calculated total energy loss in the detector for a given nucleus including inactive absorber layers.

Parameters

[in]	e	[MeV] energy loss of nucleus in active layer - if not given, we use current value
[in]	transmission	if kTRUE (default): the particle is assumed to emerge with a non-zero residual energy $E_{res}$ after the detector if kFALSE: the particle is assumed to stop in the detector.

Warning: if transmission=kTRUE, and if the residual energy after the detector is known (i.e. measured in a detector placed after this one), you should first call method SetEResAfterDetector() with the value of the residual energy before calling this method. Otherwise, especially for heavy ions, the correction may be false for particles which are just above the punch-through energy.

Angle of incidence and effective thickness

It is possible that the measured energy loss in the active layer is greater than the maximum theoretical value calculated from range tables. Apart from the uncertainty in the actual measurement (plus the uncertainty of the detector calibration), for any detector covering a finite solid angle the angles of incidence of particles hitting the detector will have a distribution, with very few (even none) arriving in a direction perpendicular to the detector's surface, i.e. in the direction of the axis along which the detector's nominal thickness is defined.

In this case, the effective thickness of the detector is increased by a factor $1/\cos\psi$, where $\psi$ is the angle between the particle's trajectory and the normal to the detector. We take this into account when trying to decide if the measured energy loss is consistent with the nucleus in question, by using a KVMaterialStack.

KVMaterialStack can calculate the minimum value of $\psi_{\Delta E}$ that would be compatible with a given energy loss (i.e. that for which the maximum possible energy loss is that which was measured): see KVMaterialStack::GetMinimumIncidentAngleForDEMax(). We can then check if such an angle is compatible with the geometry of the detector - GetMaximumMisalignmentAngle() gives the largest possible value, $\psi_{max}$, for particles impinging on the detector.

If a minimum angle of incidence $\psi_{\Delta E}$ which is consistent with the geometry can be found, it is stored in the parameters of the reconstructed nucleus with name GetCorrectedEnergy.IncidenceAngle i.e. for any reconstructed nucleus you can do

KVReconstructedNucleus& rnuc; // reference to a reconstructed nucleus
if( rnuc.GetParameters()->HasParameter("GetCorrectedEnergy.IncidenceAngle") )
{
auto psi = rnuc.GetParameters()->GetDoubleValue("GetCorrectedEnergy.IncidenceAngle");
}

If $\psi_{\Delta E}>\psi_{max}$, we use the (apparently impossible) incidence angle in order to calculate the corrected energy, and we add the following warning parameters to the particle, each of which begins with the name of the detector (unlike the previous one):

[det].GetCorrectedEnergy.Warning = 1
[det].GetCorrectedEnergy.MeasuredDE = [value]
[det].GetCorrectedEnergy.MaxDE = [value]
[det].GetCorrectedEnergy.Transmission = 0 or 1
[det].GetCorrectedEnergy.ERES = [value]
[det].GetCorrectedEnergy.RequiredIncidenceAngle = [value]
[det].GetCorrectedEnergy.MaximumIncidenceAngle = [value]

Reimplemented in KVCsI.

Definition at line 762 of file KVDetector.cpp.

◆ GetCosineMaximumMisalignmentAngle()

Double_t KVDetector::GetCosineMaximumMisalignmentAngle ( ) const

inlineoverridevirtual

For any detector covering a finite solid angle the angles of incidence of particles hitting the detector will have a distribution, with very few (even none) arriving in a direction perpendicular to the detector's surface, i.e. in the direction of the axis along which the detector's nominal thickness is defined.

In this case, the effective thickness of the detector is increased by a factor $1/\cos\psi$, where $\psi$ is the angle between the particle's trajectory and the normal to the detector. From the geometry and position of the detector we can calculate the largest possible value, $\psi_{max}$, for particles impinging on the detector.

Returns: $\cos\psi_{max}$

Reimplemented from KVPosition.

Definition at line 774 of file KVDetector.h.

◆ GetCosTheta()

Double_t KVDetector::GetCosTheta ( ) const

inlineoverridevirtual

cosinus of polar angle corresponding to centre of entrance window of detector

Reimplemented from KVPosition.

Definition at line 748 of file KVDetector.h.

◆ GetDeltaE()

Double_t KVDetector::GetDeltaE	(	Int_t	Z,
		Int_t	A,
		Double_t	Einc,
		Double_t	= `0.`
	)

overridevirtual

Returns energy loss of given nucleus in the active layer of the detector. optimization for single-layer detectors

Reimplemented from KVMaterial.

Definition at line 1262 of file KVDetector.cpp.

◆ GetDeltaEFromERes()

Double_t KVDetector::GetDeltaEFromERes	(	Int_t	Z,
		Int_t	A,
		Double_t	Eres
	)

overridevirtual

Overrides KVMaterial::GetDeltaEFromERes

Calculate energy loss in active layer of detGetAlignedDetector for nucleus (Z,A) having a residual kinetic energy Eres (MeV)

Reimplemented from KVMaterial.

Definition at line 1399 of file KVDetector.cpp.

◆ GetDetectorSignal()

virtual KVDetectorSignal* KVDetector::GetDetectorSignal ( const KVString & type ) const

inlinevirtual

Parameters

[in] type name/type of signal

Returns: pointer to the signal with given type if defined for detector

Warning: If no such signal defined, returns nullptr

Reimplemented in KVCsI.

Definition at line 543 of file KVDetector.h.

◆ GetDetectorSignalValue()

Double_t KVDetector::GetDetectorSignalValue	(	const KVString &	type,
		const KVNameValueList &	params = `""`
	)		const

inline

Parameters

[in]	type	name/type of signal
[in]	params	list of extra parameters possibly required to calculate value of signal can be passed as a string of `"param1=value,param2=value,..."` parameter/value pairs

Returns: value of signal of given type associated with detector

Note: Some signals require the necessary calibrators to be present & initialised; If the signal is not available, returns 0.

Definition at line 503 of file KVDetector.h.

◆ GetDirection()

TVector3 KVDetector::GetDirection ( )

inlineoverridevirtual

direction corresponding to centre of entrance window

Reimplemented from KVPosition.

Definition at line 724 of file KVDetector.h.

◆ GetDistance()

Double_t KVDetector::GetDistance ( void ) const

inlineoverridevirtual

distance from target [cm] to entrance window of detector

Reimplemented from KVPosition.

Definition at line 730 of file KVDetector.h.

◆ GetEIncOfMaxDeltaE()

Double_t KVDetector::GetEIncOfMaxDeltaE	(	Int_t	Z,
		Int_t	A
	)

overridevirtual

Returns incident energy corresponding to maximum energy loss in the active layer of the detector, for a given nucleus.

Reimplemented from KVMaterial.

Definition at line 1234 of file KVDetector.cpp.

◆ GetELossFunction()

TF1 * KVDetector::GetELossFunction	(	Int_t	Z,
		Int_t	A
	)

virtual

Return pointer to TF1 giving energy loss in active layer of detector as function of incident energy, for a given nucleus (Z,A). The TF1::fNpx parameter is taken from environment variable KVDetector.EnergyLoss.Npx

Definition at line 1211 of file KVDetector.cpp.

◆ GetELostByParticle()

Double_t KVDetector::GetELostByParticle	(	KVNucleus *	kvp,
		TVector3 *	norm = `0`
	)

overridevirtual

Calculate the total energy loss of a charged particle traversing the detector.

This does not affect the "stored" energy loss value of the detector nor the energy of the particle.

If the optional argument 'norm' is given, it is supposed to be a vector normal to the detector, oriented from the origin towards the detector.

In this case the effective thicknesses of the detector's absorbers 'seen' by the particle depending on its direction of motion is used for the calculation.

Reimplemented from KVMaterial.

Definition at line 266 of file KVDetector.cpp.

◆ GetEnergy()

virtual Double_t KVDetector::GetEnergy ( ) const

inlinevirtual

Returns either the calibrated energy loss measured in the active layer of the detector, or (if IsSimMode()==kTRUE) the simulated energy losses

Reimplemented in KVPhoswich.

Definition at line 374 of file KVDetector.h.

◆ GetEnergyLoss()

Double_t KVDetector::GetEnergyLoss ( ) const

inlineoverridevirtual

Reimplemented from KVMaterial.

Definition at line 394 of file KVDetector.h.

◆ GetEntranceWindow()

const KVPosition& KVDetector::GetEntranceWindow ( ) const

inline

Returns KVPosition object corresponding to the entrance window volume i.e. the first volume encountered in the detector

Definition at line 693 of file KVDetector.h.

◆ GetEntranceWindowSurfaceArea()

Double_t KVDetector::GetEntranceWindowSurfaceArea ( )

virtual

Return surface area of first layer of detector in cm2.

Definition at line 1142 of file KVDetector.cpp.

◆ GetERes()

Double_t KVDetector::GetERes	(	Int_t	Z,
		Int_t	A,
		Double_t	Einc,
		Double_t	= `0.`
	)

overridevirtual

Returns residual energy of given nucleus after the detector. Returns 0 if Einc<=0

Reimplemented from KVMaterial.

Definition at line 1293 of file KVDetector.cpp.

◆ GetEResAfterDetector()

virtual Double_t KVDetector::GetEResAfterDetector ( ) const

inlinevirtual

Definition at line 631 of file KVDetector.h.

◆ GetEResFunction()

TF1 * KVDetector::GetEResFunction	(	Int_t	Z,
		Int_t	A
	)

virtual

Return pointer toTF1 giving residual energy after detector as function of incident energy, for a given nucleus (Z,A). The TF1::fNpx parameter is taken from environment variable KVDetector.ResidualEnergy.Npx

Definition at line 1161 of file KVDetector.cpp.

◆ GetGroup()

KVGroup * KVDetector::GetGroup ( ) const

Definition at line 1644 of file KVDetector.cpp.

◆ GetGroupNumber()

UInt_t KVDetector::GetGroupNumber ( )

Definition at line 1653 of file KVDetector.cpp.

◆ GetIncidentEnergy()

Double_t KVDetector::GetIncidentEnergy	(	Int_t	Z,
		Int_t	A,
		Double_t	delta_e = `-1.0`,
		enum SolType	type = `kEmax`
	)

overridevirtual

Returns incident energy corresponding to energy loss delta_e in active layer of detector for a given nucleus. If delta_e is not given, the current energy loss in the active layer is used.

By default the solution corresponding to the highest incident energy is returned This is the solution found for Einc greater than the maximum of the dE(Einc) curve. If you want the low energy solution set SolType = KVIonRangeTable::kEmin.

Warning: Calculating the incident energy of a particle using only the dE in a detector is ambiguous, as in general (and especially for very heavy ions) the maximum of the dE curve occurs for Einc greater than the punch-through energy, therefore it is not always true to assume that if the particle does not stop in the detector the required solution is that for type=KVIonRangeTable::kEmax. For a range of energies between punch-through and dE_max, the required solution is still that for type=KVMaterial::kEmin. If the residual energy of the particle is unknown, there is no way to know which is the correct solution.; If the given energy loss in the active layer is greater than the maximum theoretical dE for given Z & A, (dE > GetMaxDeltaE(Z,A)) then we return a NEGATIVE incident energy corresponding to the maximum, GetEIncOfMaxDeltaE(Z,A)

Reimplemented from KVMaterial.

Definition at line 1329 of file KVDetector.cpp.

◆ GetIncidentEnergyFromERes()

Double_t KVDetector::GetIncidentEnergyFromERes	(	Int_t	Z,
		Int_t	A,
		Double_t	Eres
	)

overridevirtual

Overrides KVMaterial::GetIncidentEnergyFromERes

Calculate incident energy of nucleus from residual energy.

Returns -1 if Eres is out of defined range of values

Reimplemented from KVMaterial.

Definition at line 1421 of file KVDetector.cpp.

◆ GetIndex()

virtual Int_t KVDetector::GetIndex ( ) const

inlinevirtual

Return a numerical identifier for the detector

Can be overridden in specialised detector classes

Reimplemented in KVINDRADetector, and KVFAZIADetector.

Examples: ExampleCorrelationAnalysis.cpp, and ExampleRawAnalysis.cpp.

Definition at line 848 of file KVDetector.h.

◆ GetInverseDetectorSignalValue()

Double_t KVDetector::GetInverseDetectorSignalValue	(	const KVString &	output,
		Double_t	value,
		const KVString &	input,
		const KVNameValueList &	params = `""`
	)		const

inline

Parameters

[in]	output	name/type of output signal
[in]	value	value of output signal
[in]	input	name/type of input signal
[in]	params	list of extra parameters possibly required to calculate value of signal can be passed as a string of `"param1=value,param2=value,..."` parameter/value pairs

Calculate the value of the input signal for a given value of the output signal.

This uses the inverse calibrations of all intermediate signals.

Note: If the output signal is not defined, or if input & output are not related, this returns 0.

Definition at line 527 of file KVDetector.h.

◆ GetLinearRange()

Double_t KVDetector::GetLinearRange	(	Int_t	Z,
		Int_t	A,
		Double_t	Einc
	)

overridevirtual

Returns range of ion in centimetres in this detector, taking into account all layers. Note that for Einc > punch through energy, this range is no longer correct (but still > total thickness of detector).

Reimplemented from KVMaterial.

Definition at line 1559 of file KVDetector.cpp.

◆ GetListOfAbsorbers()

const KVList* KVDetector::GetListOfAbsorbers ( ) const

inline

Definition at line 333 of file KVDetector.h.

◆ GetListOfCalibrators()

KVList* KVDetector::GetListOfCalibrators ( ) const

inline

Definition at line 411 of file KVDetector.h.

◆ GetListOfDetectorSignals()

const KVSeqCollection& KVDetector::GetListOfDetectorSignals ( ) const

inline

Definition at line 823 of file KVDetector.h.

◆ GetListOfDetectorSignalsForRawTree()

const KVSeqCollection& KVDetector::GetListOfDetectorSignalsForRawTree ( ) const

inline

This list of 'raw' signals to be used in the TTree filled by runfile_analyser is filled the first time this method is called; that way it can include any signals added by calibrations.

Definition at line 827 of file KVDetector.h.

◆ GetMaterialName()

const Char_t* KVDetector::GetMaterialName ( ) const

inline

Definition at line 359 of file KVDetector.h.

◆ GetMatrix()

TGeoHMatrix* KVDetector::GetMatrix ( ) const

inlineoverrideprivatevirtual

Reimplemented from KVPosition.

Definition at line 204 of file KVDetector.h.

◆ GetMaxDeltaE()

Double_t KVDetector::GetMaxDeltaE	(	Int_t	Z,
		Int_t	A
	)

overridevirtual

Returns maximum energy loss in the active layer of the detector, for a given nucleus.

Reimplemented from KVMaterial.

Definition at line 1248 of file KVDetector.cpp.

◆ GetMaximumMisalignmentAngle()

Double_t KVDetector::GetMaximumMisalignmentAngle ( ) const

inlineoverridevirtual

For any detector covering a finite solid angle the angles of incidence of particles hitting the detector will have a distribution, with very few (even none) arriving in a direction perpendicular to the detector's surface, i.e. in the direction of the axis along which the detector's nominal thickness is defined.

In this case, the effective thickness of the detector is increased by a factor $1/\cos\psi$, where $\psi$ is the angle between the particle's trajectory and the normal to the detector. From the geometry and position of the detector we can calculate the largest possible value, $\psi_{max}$, for particles impinging on the detector.

Returns: $\psi_{max}$

Reimplemented from KVPosition.

Definition at line 760 of file KVDetector.h.

◆ GetNameOfArray()

const Char_t* KVDetector::GetNameOfArray ( ) const

inline

Return name of multidetector array this detector belongs to

Definition at line 817 of file KVDetector.h.

◆ GetNHits()

Int_t KVDetector::GetNHits ( ) const

inline

Return the number of particles hitting this detector in an event.

Definition at line 448 of file KVDetector.h.

◆ GetNode()

KVGeoDetectorNode* KVDetector::GetNode ( )

inline

Definition at line 354 of file KVDetector.h.

◆ GetNormalIntoShape()

TVector3 KVDetector::GetNormalIntoShape ( ) const

inlineoverrideprivatevirtual

Reimplemented from KVPosition.

Definition at line 224 of file KVDetector.h.

◆ GetNormalToDetector()

TVector3 KVDetector::GetNormalToDetector ( ) const

inline

Returns: unit vector normal to detector's entrance window, oriented into/towards the detector

This is the axis along which the nominal thicknesses of all the absorbers in the detector are defined.

Definition at line 788 of file KVDetector.h.

◆ GetNumberOfAbsorberLayers()

Int_t KVDetector::GetNumberOfAbsorberLayers ( ) const

inline

Definition at line 337 of file KVDetector.h.

◆ GetParentStructure()

KVGeoStrucElement * KVDetector::GetParentStructure	(	const Char_t *	type,
		const Char_t *	name = `""`
	)		const

Get parent geometry structure element of given type. Give unique name of structure if more than one element of same type is possible.

Definition at line 1682 of file KVDetector.cpp.

◆ GetParticleEIncFromERes()

Double_t KVDetector::GetParticleEIncFromERes	(	KVNucleus *	kvp,
		TVector3 *	norm = `0`
	)

overridevirtual

Calculate the energy of particle 'kvn' before its passage through the detector, based on the current kinetic energy, Z & A of nucleus 'kvn', supposed to be after passing through the detector.

If the optional argument 'norm' is given, it is supposed to be a vector normal to the detector, oriented from the origin towards the detector.

In this case the effective thicknesses of the detector's absorbers 'seen' by the particle depending on its direction of motion is used for the calculation.

Reimplemented from KVMaterial.

Definition at line 301 of file KVDetector.cpp.

◆ GetPhi()

Double_t KVDetector::GetPhi ( ) const

inlineoverridevirtual

azimuthal angle [deg.] corresponding to centre of entrance window of detector

Reimplemented from KVPosition.

Definition at line 754 of file KVDetector.h.

◆ GetPunchThroughEnergy()

Double_t KVDetector::GetPunchThroughEnergy	(	Int_t	Z,
		Int_t	A
	)

overridevirtual

Returns energy (in MeV) necessary for ion (Z,A) to punch through all layers of this detector

Reimplemented from KVMaterial.

Definition at line 1574 of file KVDetector.cpp.

◆ GetRandomAngles()

void KVDetector::GetRandomAngles	(	Double_t &	th,
		Double_t &	ph,
		Option_t *	t = `"isotropic"`
	)

inlineoverridevirtual

random angles [deg.] corresponding to point on entrance window

Reimplemented from KVPosition.

Definition at line 718 of file KVDetector.h.

◆ GetRandomDirection()

TVector3 KVDetector::GetRandomDirection ( Option_t * t = "isotropic" )

inlineoverridevirtual

random direction corresponding to point on entrance window

Reimplemented from KVPosition.

Definition at line 712 of file KVDetector.h.

◆ GetRandomPointOnSurface()

TVector3 KVDetector::GetRandomPointOnSurface ( ) const

inlineoverrideprivatevirtual

Reimplemented from KVPosition.

Definition at line 212 of file KVDetector.h.

◆ GetRange()

Double_t KVDetector::GetRange	(	Int_t	Z,
		Int_t	A,
		Double_t	Einc
	)

overridevirtual

WARNING: SAME AS KVDetector::GetLinearRange Only linear range in centimetres is calculated for detectors!

Reimplemented from KVMaterial.

Definition at line 1544 of file KVDetector.cpp.

◆ GetRangeFunction()

TF1 * KVDetector::GetRangeFunction	(	Int_t	Z,
		Int_t	A
	)

virtual

Return pointer toTF1 giving range (in centimetres) in detector as function of incident energy, for a given nucleus (Z,A). The TF1::fNpx parameter is taken from environment variable KVDetector.Range.Npx

Definition at line 1186 of file KVDetector.cpp.

◆ GetShape()

TGeoBBox* KVDetector::GetShape ( ) const

inlineoverrideprivatevirtual

Reimplemented from KVPosition.

Definition at line 208 of file KVDetector.h.

◆ GetSinTheta()

Double_t KVDetector::GetSinTheta ( ) const

inlineoverridevirtual

sinus of polar angle corresponding to centre of entrance window of detector

Reimplemented from KVPosition.

Definition at line 742 of file KVDetector.h.

◆ GetSmallestEmaxValid()

Double_t KVDetector::GetSmallestEmaxValid	(	Int_t	Z,
		Int_t	A
	)		const

virtual

Returns the smallest maximum energy for which range tables are valid for all absorbers in the detector, and given ion (Z,A)

Definition at line 1445 of file KVDetector.cpp.

◆ GetSolidAngle()

Double_t KVDetector::GetSolidAngle ( void ) const

inlineoverridevirtual

Return solid angle [msr] corresponding to the entrance window of the detector

Reimplemented from KVPosition.

Definition at line 706 of file KVDetector.h.

◆ GetSurfaceArea()

Double_t KVDetector::GetSurfaceArea ( int npoints = 100000 ) const

inlineoverrideprivatevirtual

Reimplemented from KVPosition.

Definition at line 228 of file KVDetector.h.

◆ GetSurfaceCentre()

TVector3 KVDetector::GetSurfaceCentre ( ) const

inlineoverrideprivatevirtual

Reimplemented from KVPosition.

Definition at line 216 of file KVDetector.h.

◆ GetTheta()

Double_t KVDetector::GetTheta ( ) const

inlineoverridevirtual

polar angle [deg.] corresponding to centre of entrance window of detector

Reimplemented from KVPosition.

Definition at line 736 of file KVDetector.h.

◆ GetTotalDeltaE()

Double_t KVDetector::GetTotalDeltaE	(	Int_t	Z,
		Int_t	A,
		Double_t	Einc
	)

virtual

Returns calculated total energy loss of ion in ALL layers of the detector. This is just (Einc - GetERes(Z,A,Einc))

Definition at line 1279 of file KVDetector.cpp.

◆ GetTotalThicknessInCM()

Double_t KVDetector::GetTotalThicknessInCM ( ) const

inline

Calculate and return the total thickness in centimetres of ALL absorbers making up the detector, not just the active layer (value returned by GetThickness()).

Definition at line 343 of file KVDetector.h.

◆ GetVolumeCentre()

TVector3 KVDetector::GetVolumeCentre ( ) const

inlineoverrideprivatevirtual

Reimplemented from KVPosition.

Definition at line 220 of file KVDetector.h.

◆ HasDetectorSignal()

Bool_t KVDetector::HasDetectorSignal ( const KVString & type ) const

inline

Parameters

[in] type name/type of signal

Returns: kTRUE if signal with given type is defined for detector

Definition at line 552 of file KVDetector.h.

◆ HasSameStructureAs()

Bool_t KVDetector::HasSameStructureAs ( const KVDetector * other ) const

Return kTRUE if the two detectors have the same internal structure, i.e.

the same number of absorber layers
in the same order
with the same material & thickness

Definition at line 1803 of file KVDetector.cpp.

◆ IncrementIdentifiedParticles()

void KVDetector::IncrementIdentifiedParticles ( Int_t n = 1 )

inline

Definition at line 565 of file KVDetector.h.

◆ IncrementUnidentifiedParticles()

void KVDetector::IncrementUnidentifiedParticles ( Int_t n = 1 )

inline

Definition at line 559 of file KVDetector.h.

◆ init()

void KVDetector::init ( void )

default initialisations

Definition at line 32 of file KVDetector.cpp.

◆ IsAnalysed()

Bool_t KVDetector::IsAnalysed ( )

inline

Definition at line 453 of file KVDetector.h.

◆ IsCalibrated()

Bool_t KVDetector::IsCalibrated ( const KVNameValueList & params = {} ) const

A detector is considered to be calibrated if it has a signal "Energy" available and if depending on the supplied parameters this signal can be calculated

Definition at line 527 of file KVDetector.cpp.

◆ IsDetecting()

virtual Bool_t KVDetector::IsDetecting ( ) const

inlinevirtual

return if the detector is ready to detect or not

Definition at line 666 of file KVDetector.h.

◆ IsGasDetector()

Bool_t KVDetector::IsGasDetector ( ) const

inline

Returns: kTRUE if active layer is gaseous material (alias for IsGas())

Definition at line 807 of file KVDetector.h.

◆ IsMultiLayer()

Bool_t KVDetector::IsMultiLayer ( ) const

inline

Returns kTRUE for detectors with several absorber layers

Definition at line 802 of file KVDetector.h.

◆ IsOK()

virtual Bool_t KVDetector::IsOK ( ) const

inlinevirtual

return kTRUE if detector is here and working

Definition at line 676 of file KVDetector.h.

◆ IsPresent()

virtual Bool_t KVDetector::IsPresent ( ) const

inlinevirtual

return the presence or not of the detector

Definition at line 657 of file KVDetector.h.

◆ IsSegmented()

virtual Bool_t KVDetector::IsSegmented ( ) const

inlinevirtual

Reimplemented in KVSegmentedDetector.

Definition at line 860 of file KVDetector.h.

◆ IsSimMode()

virtual Bool_t KVDetector::IsSimMode ( ) const

inlinevirtual

Returns simulation mode of detector: IsSimMode()=kTRUE : we are in simulation mode (calculation of energy losses etc.) IsSimMode()=kFALSE: we are analysing/reconstruction experimental data Changes behaviour of Fired(): in simulation mode, Fired() returns kTRUE whenever the energy loss in the active layer is >0

Definition at line 647 of file KVDetector.h.

◆ IsSingleLayer()

Bool_t KVDetector::IsSingleLayer ( ) const

inline

Returns kTRUE for detectors with a single absorber layer

Definition at line 797 of file KVDetector.h.

◆ MakeDetector()

KVDetector * KVDetector::MakeDetector	(	const Char_t *	name,
		Float_t	thickness
	)

static

Static function which will create an instance of the KVDetector-derived class corresponding to 'name' These are defined as 'Plugin' objects in the file $KVROOT/KVFiles/.kvrootrc : [name_of_dataset].detector_type detector_type To use the dataset-dependent plugin, call this method with name = "[name_of_dataset].detector_type" If not, the default plugin will be used first we check if there is a special plugin for the DataSet if not we take the default one

'thickness' is passed as argument to the constructor for the detector plugin check and load plugin library

Definition at line 1102 of file KVDetector.cpp.

◆ Print()

void KVDetector::Print ( Option_t * opt = "" ) const

overridevirtual

Print info on this detector if option="data" the energy loss and raw data are displayed

Reimplemented from KVBase.

Definition at line 338 of file KVDetector.cpp.

◆ RangeDet()

Double_t KVDetector::RangeDet	(	Double_t *	x,
		Double_t *	par
	)

private

Calculates range (in centimetres) of ions in detector as a function of incident energy (in MeV), taking into account all layers of the detector.

Arguments are: x[0] = incident energy in MeV Parameters are: par[0] = Z of ion par[1] = A of ion

Definition at line 1005 of file KVDetector.cpp.

◆ ReadDefinitionFromFile()

void KVDetector::ReadDefinitionFromFile ( const Char_t * envrc )

virtual

Create detector from text file in 'TEnv' format.

Example:

Layer: Gold Gold.Material: Au Gold.AreaDensity: 200.*KVUnits::ug +Layer: Gas1 Gas1.Material: C3F8 Gas1.Thickness: 5.*KVUnitscm Gas1.Pressure: 50.*KVUnits::mbar Gas1.Active: yes +Layer: Si1 Si1.Material: Si Si1.Thickness: 300.*KVUnitsum

Definition at line 1482 of file KVDetector.cpp.

◆ remove_signal_for_calibrator()

void KVDetector::remove_signal_for_calibrator ( KVCalibrator * K )

private

Used when a calibrator object is removed or replaced We remove and delete the corresponding output signal from the list of detector signals

Definition at line 662 of file KVDetector.cpp.

◆ RemoveAllAbsorbers()

void KVDetector::RemoveAllAbsorbers ( )

Completely reset the KVDetector as if it had just been created by a call to the default constructor:

removes all absorber layers
removes all calibrators/detector signals

Definition at line 631 of file KVDetector.cpp.

◆ RemoveCalibrators()

void KVDetector::RemoveCalibrators ( )

virtual

Removes all calibrations associated to this detector: in other words, we delete all the KVCalibrator objects in list fCalibrators.

We also destroy all signals provided by these calibrators

Reimplemented in KVCsI.

Definition at line 684 of file KVDetector.cpp.

◆ RemoveHit()

auto KVDetector::RemoveHit ( KVNucleus * part )

inline

Remove from list of particles hitting this detector in an event

Returns: non-null pointer if particle was in the list (and hence removed), or nullptr if particle was not in the list

Definition at line 431 of file KVDetector.h.

◆ RemoveParentStructure()

void KVDetector::RemoveParentStructure ( KVGeoStrucElement * elem )

Definition at line 1671 of file KVDetector.cpp.

◆ ReplaceCalibrator()

Bool_t KVDetector::ReplaceCalibrator	(	const Char_t *	type,
		KVCalibrator *	cal,
		const KVNameValueList &	opts = `""`
	)

Replace calibrator of given type with the given calibrator object The calibrator object should not be shared with any other detectors: it now belongs to this detector, which will delete it when necessary. If an exising calibrator with the same type is already defined, it will be deleted and removed from the detector's calibrator list

Returns kFALSE in case of problems.

The (optional) KVNameValueList argument can be used to pass any extra parameters/options.

Definition at line 499 of file KVDetector.cpp.

◆ Reset()

virtual void KVDetector::Reset ( Option_t * opt = "" )

inlinevirtual

Definition at line 418 of file KVDetector.h.

◆ SetActiveLayer() [1/2]

void KVDetector::SetActiveLayer ( Int_t i )

inline

Set active layer with index (=0, 1, ...)

Definition at line 317 of file KVDetector.h.

◆ SetActiveLayer() [2/2]

void KVDetector::SetActiveLayer ( KVMaterial * actif )

inline

Definition at line 312 of file KVDetector.h.

◆ SetActiveLayerMatrix()

void KVDetector::SetActiveLayerMatrix ( const TGeoHMatrix * m )

Set ROOT geometry global matrix transformation to coordinate frame of active layer volume.

Definition at line 1702 of file KVDetector.cpp.

◆ SetActiveLayerShape()

void KVDetector::SetActiveLayerShape ( TGeoBBox * s )

Set ROOT geometry shape of active layer volume.

Definition at line 1713 of file KVDetector.cpp.

◆ SetAnalysed()

void KVDetector::SetAnalysed ( Bool_t b = kTRUE )

inline

Definition at line 457 of file KVDetector.h.

◆ SetDetecting()

void KVDetector::SetDetecting ( Bool_t yes = kTRUE )

inline

Definition at line 671 of file KVDetector.h.

◆ SetDetectorSignalValue()

void KVDetector::SetDetectorSignalValue	(	const KVString &	type,
		Double_t	val
	)		const

inline

Parameters

[in]	type	name/type of signal
[in]	val	value to set for signal

Set value of signal of given type associated with detector

Note: Only to be used with raw detector signals (i.e. not expressions, not calibrated signals)

Definition at line 516 of file KVDetector.h.

◆ SetEnergy()

virtual void KVDetector::SetEnergy ( Double_t e ) const

inlinevirtual

Set value of energy lost in active layer

Reimplemented in KVPhoswich.

Definition at line 386 of file KVDetector.h.

◆ SetEnergyLoss()

void KVDetector::SetEnergyLoss ( Double_t e ) const

inlineoverridevirtual

Reimplemented from KVMaterial.

Definition at line 398 of file KVDetector.h.

◆ SetEntranceWindowMatrix()

void KVDetector::SetEntranceWindowMatrix ( const TGeoHMatrix * m )

Set ROOT geometry global matrix transformation to coordinate frame of entrance window.

Definition at line 1724 of file KVDetector.cpp.

◆ SetEntranceWindowShape()

void KVDetector::SetEntranceWindowShape ( TGeoBBox * s )

Set ROOT geometry shape of entrance window.

Definition at line 1735 of file KVDetector.cpp.

◆ SetEResAfterDetector()

virtual void KVDetector::SetEResAfterDetector ( Double_t e )

inlinevirtual

Definition at line 627 of file KVDetector.h.

◆ SetMaterial()

void KVDetector::SetMaterial ( const Char_t * type )

overridevirtual

Set material of active layer. If no absorbers have been added to the detector, create and add one (active layer by default)

Reimplemented from KVMaterial.

Definition at line 169 of file KVDetector.cpp.

◆ SetMatrix()

void KVDetector::SetMatrix ( const TGeoHMatrix * m )

inlineoverrideprivatevirtual

Make KVPosition methods private to avoid misuse N.B. the inherited KVPosition part of KVDetector is used for the ACTIVE layer of the detector the entrance window is described by member KVPosition fEWPosition

Reimplemented from KVPosition.

Definition at line 196 of file KVDetector.h.

◆ SetNameOfArray()

void KVDetector::SetNameOfArray ( const TString & n )

inline

Definition at line 813 of file KVDetector.h.

◆ SetPresent()

void KVDetector::SetPresent ( Bool_t yes = kTRUE )

inline

Definition at line 662 of file KVDetector.h.

◆ SetPressure()

void KVDetector::SetPressure ( Double_t P )

overridevirtual

Parameters

[in] P pressure in [Torr]

For a gaseous detector, set/change the pressure of the active gas layer.

For ROOT geometries, we change the medium/material of the corresponding node in the geometry in order to reflect the change in pressure (gases are represented by different media/materials for each pressure/temperature) so that it will be taken into account for example when filtering simulated data.

Reimplemented from KVMaterial.

Reimplemented in KVChIo.

Definition at line 1910 of file KVDetector.cpp.

◆ SetShape()

void KVDetector::SetShape ( TGeoBBox * s )

inlineoverrideprivatevirtual

Reimplemented from KVPosition.

Definition at line 200 of file KVDetector.h.

◆ SetSimMode()

virtual void KVDetector::SetSimMode ( Bool_t on = kTRUE )

inlinevirtual

Set simulation mode of detector If on=kTRUE (default), we are in simulation mode (calculation of energy losses etc.) If on=kFALSE, we are analysing/reconstruction experimental data Changes behaviour of Fired(): in simulation mode, Fired() returns kTRUE whenever the energy loss in the active layer is >0

Definition at line 638 of file KVDetector.h.

◆ SetTemperature()

void KVDetector::SetTemperature ( Double_t T )

overridevirtual

Parameters

[in] T pressure in [deg. C]

For a gaseous detector, set/change the temperature of the active gas layer.

For ROOT geometries, we change the medium/material of the corresponding node in the geometry in order to reflect the change in temperature (gases are represented by different media/materials for each pressure/temperature) so that it will be taken into account for example when filtering simulated data.

Reimplemented from KVMaterial.

Definition at line 1941 of file KVDetector.cpp.

◆ SetThickness()

void KVDetector::SetThickness ( Double_t thick )

overridevirtual

Overrides KVMaterial::SetThickness

If ROOT geometry is defined, we modify the DZ thickness of the volume representing this detector in accordance with the new thickness.

This is only implemented for single-layer detectors with the following shapes:

TGeoBBox (rectangular box)
TGeoTube (tube)
TGeoArb8 (arbitrary trapezoid with less than 8 vertices standing on two parallel planes perpendicular to Z axis)

Reimplemented from KVMaterial.

Reimplemented in KVSilicon.

Definition at line 1754 of file KVDetector.cpp.

◆ use_signal_for_raw_data_tree()

virtual Bool_t KVDetector::use_signal_for_raw_data_tree ( const TString & ) const

inlineprivatevirtual

Reimplemented in KVINDRADetector, and KVFAZIADetector.

Definition at line 295 of file KVDetector.h.

Member Data Documentation

◆ fAbsorbers

KVList KVDetector::fAbsorbers

private

list of absorbers making up the detector

Definition at line 269 of file KVDetector.h.

◆ fActiveLayer

KVMaterial* KVDetector::fActiveLayer

private

The active absorber in the detector.

Definition at line 180 of file KVDetector.h.

◆ fCalibrators

KVList* KVDetector::fCalibrators

private

list of associated calibrator objects

Definition at line 267 of file KVDetector.h.

◆ fDetCounter

Int_t KVDetector::fDetCounter = 0

staticprivate

Definition at line 179 of file KVDetector.h.

◆ fDetecting

Bool_t KVDetector::fDetecting

private

=kTRUE if detector is "detecting", =kFALSE if not

Definition at line 283 of file KVDetector.h.

◆ fDetSignals

KVUniqueNameList KVDetector::fDetSignals

private

list of signals associated with detector

Definition at line 233 of file KVDetector.h.

◆ fDetSignalsForRawTree

KVUniqueNameList KVDetector::fDetSignalsForRawTree

mutableprivate

list of signals used for raw data TTree

Definition at line 234 of file KVDetector.h.

◆ fELossF

TF1* KVDetector::fELossF

private

parametric function dE in active layer vs. incident energy

Definition at line 275 of file KVDetector.h.

◆ fEResF

TF1* KVDetector::fEResF

private

parametric function Eres residual energy after all layers of detector

Definition at line 276 of file KVDetector.h.

◆ fEResforEinc

Double_t KVDetector::fEResforEinc

private

used by GetIncidentEnergy & GetCorrectedEnergy

Definition at line 279 of file KVDetector.h.

◆ fEWPosition

KVPosition KVDetector::fEWPosition

private

position of entrance window i.e. first volume in detector geometry

Definition at line 176 of file KVDetector.h.

◆ fFName

TString KVDetector::fFName

private

dynamically generated full name of detector

Definition at line 266 of file KVDetector.h.

◆ fIdentP

Int_t KVDetector::fIdentP

private

temporary counters, determine state of identified/unidentified particle flags

Definition at line 190 of file KVDetector.h.

◆ fNameOfArray

TString KVDetector::fNameOfArray

private

name of multidetector array this detector is part of

Definition at line 181 of file KVDetector.h.

◆ fNode

KVGeoDetectorNode KVDetector::fNode

private

positioning information relative to other detectors

Definition at line 178 of file KVDetector.h.

◆ fParentStrucList

KVUniqueNameList KVDetector::fParentStrucList

private

list of geometry structures which directly contain this detector

Definition at line 177 of file KVDetector.h.

◆ fParticles

KVUnownedList KVDetector::fParticles

private

list of particles hitting detector in an event

Definition at line 268 of file KVDetector.h.

◆ fPresent

Bool_t KVDetector::fPresent

private

=kTRUE if detector is present, =kFALSE if it has been removed

Definition at line 282 of file KVDetector.h.

◆ fRangeF

TF1* KVDetector::fRangeF

private

parametric function range of particles in detector

Definition at line 277 of file KVDetector.h.

◆ fSimMode

Bool_t KVDetector::fSimMode

private

=kTRUE when using to simulate detector response, =kFALSE when analysing data

Definition at line 281 of file KVDetector.h.

◆ fSingleLayer

Bool_t KVDetector::fSingleLayer

private

=kTRUE if detector has a single absorber layer

Definition at line 285 of file KVDetector.h.

◆ fUnidentP

Int_t KVDetector::fUnidentP

private

temporary counters, determine state of identified/unidentified particle flags

Definition at line 191 of file KVDetector.h.

	calculate \(E_{inc}\)	calculate \(\Delta E\)	calculate \(E_{res}\)
from \(E_{inc}\)	-	GetDeltaE()	GetERes()
from \(E_{inc}\)		GetELostByParticle()
from \(\Delta E\)	GetIncidentEnergy()	-	GetEResFromDeltaE()
from \(E_{res}\)	GetIncidentEnergyFromERes()	GetDeltaEFromERes()	-
from \(E_{res}\)	GetParticleEIncFromERes()

Detailed Description

Example 1: defining a detector

Calculate the energy loss of a charged particle in a detector

Important note on detector positions, angles, solid angle, distances etc.

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ KVDetector() [1/4]

◆ KVDetector() [2/4]

◆ KVDetector() [3/4]

◆ KVDetector() [4/4]

◆ ~ KVDetector()

Member Function Documentation

◆ AddAbsorber()

◆ AddCalibrator()

◆ AddDetectorSignal() [1/2]

◆ AddDetectorSignal() [2/2]

◆ AddDetectorSignalExpression()

◆ AddDetectorSignalTrace()

◆ AddEnergyLossInSubDetector()

◆ AddHit()

◆ AddParentStructure()

◆ BelongsToIdentifiedParticle()

◆ BelongsToUnidentifiedParticle()

◆ Clear()

◆ ClearHits()

◆ Copy()

◆ DetectParticle()

◆ DrawPunchThroughEnergyVsZ()

◆ DrawPunchThroughEsurAVsZ()

◆ ELossActive()

◆ EResDet()

◆ FindZmin()

◆ Fired()

◆ get_corrected_energy()

◆ GetAbsorber() [1/2]

◆ GetAbsorber() [2/2]

◆ GetActiveLayer()

◆ GetActiveLayerMatrix()

◆ GetActiveLayerShape()

◆ GetActiveLayerSurfaceCentre()

◆ GetActiveLayerVolumeCentre()

◆ GetCalibratedEnergy()

◆ GetCalibrator() [1/2]

◆ GetCalibrator() [2/2]

◆ GetCentreOfEntranceWindow()

◆ GetCorrectedEnergy()

Angle of incidence and effective thickness

◆ GetCosineMaximumMisalignmentAngle()

◆ GetCosTheta()

◆ GetDeltaE()

◆ GetDeltaEFromERes()

◆ GetDetectorSignal()

◆ GetDetectorSignalValue()

◆ GetDirection()

◆ GetDistance()

◆ GetEIncOfMaxDeltaE()

◆ GetELossFunction()

◆ GetELostByParticle()

◆ GetEnergy()

◆ GetEnergyLoss()

◆ GetEntranceWindow()

◆ GetEntranceWindowSurfaceArea()

◆ GetERes()

◆ GetEResAfterDetector()

◆ GetEResFunction()

◆ GetGroup()

◆ GetGroupNumber()

◆ GetIncidentEnergy()

◆ GetIncidentEnergyFromERes()

◆ GetIndex()

◆ GetInverseDetectorSignalValue()

◆ GetLinearRange()