Detailed Description

Monte-Carlo sampling of events with statistical weights .

Definition at line 22 of file MCSampler.h.

#include <MCSampler.h>

Inheritance diagram for MicroStat::MCSampler:

Public Member Functions
	MCSampler ()
	Default constructor. More...

	MCSampler (const Char_t name, const Char_t title="")
	Write your code here. More...

virtual	~MCSampler ()
	Destructor. More...

void	CalculateWeights (Double_t excitation_energy)

void	GenerateEvent (TTree theTree, KVEvent event)

void	GenerateEvents (TTree , KVEvent event, Double_t, Long64_t npartitions, Long64_t nev_part=10)

Double_t	GetLegendProbaMin () const

KVEvent *	GetPartition (Long64_t i)

StatWeight *	GetRandomChannelWeight () const

Double_t	GetSumWeights () const

StatWeight *	GetWeight (Int_t i) const

TClonesArray *	GetWeights () const

Long64_t	PickRandomChannel ()

void	PlotMultiplicities (double emin=0., double emax=100., double estep=1., Option_t *opt="")

void	PlotProbabilities (double emin=0., double emax=100., double estep=1., Option_t *opt="")

Bool_t	SetDecayChannel ()

void	SetEventList (TTree *t, const TString &branchname)
	Define the TTree or TChain containing all possible events (partitions). More...

Bool_t	SetExcitationEnergy (Double_t Exx)

void	SetLegendProbaMin (Double_t p)

void	SetModifyMasses (Bool_t yes=kTRUE)

void	SetStatWeight (const TString &)

void	SetUpTreeBranches (KVEvent &event, TTree theTree, const TString &bname)

void	ShowLegend ()

void	UpdateMasses ()

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

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

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

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

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

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

virtual TObject *	GetObject () const

virtual const Char_t *	GetType () const

Bool_t	HasLabel () const

Bool_t	IsCalled (const Char_t *name, bool case_insensitive=false) const

Bool_t	IsLabelled (const Char_t *l, bool case_insensitive=false) const

Bool_t	IsType (const Char_t *typ, bool case_insensitive=false) const

virtual void	List ()

KVBase &	operator= (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)

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 }

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

Constructor & Destructor Documentation

◆ MCSampler() [1/2]

MicroStat::MCSampler::MCSampler ( )

Default constructor.

Definition at line 48 of file MCSampler.cpp.

◆ MCSampler() [2/2]

MicroStat::MCSampler::MCSampler	(	const Char_t *	name,
		const Char_t *	title = `""`
	)

Write your code here.

Definition at line 60 of file MCSampler.cpp.

◆ ~MCSampler()

MicroStat::MCSampler::~MCSampler ( )

virtual

Destructor.

Definition at line 71 of file MCSampler.cpp.

Member Function Documentation

◆ CalculateWeights()

void MicroStat::MCSampler::CalculateWeights ( Double_t excitation_energy )

calculate weights of all partitions for the given excitation energy (in MeV) of the initial compound nucleus Info("CalculateWeights","Calculating channel weights for E*=%f",excitation_energy);

Definition at line 133 of file MCSampler.cpp.

◆ GenerateEvent()

void MicroStat::MCSampler::GenerateEvent	(	TTree *	theTree,
		KVEvent *	event
	)

Generate 1 kinematical event for the partition previously picked at random after calling: SetExcitationEnergy(E*); SetDecayChannel(); theTree->Fill() is automatically called. This method can be called many times before either 1) picking a new decay channel 2) changing the energy

Definition at line 341 of file MCSampler.cpp.

◆ GenerateEvents()

void MicroStat::MCSampler::GenerateEvents	(	TTree *	theTree,
		KVEvent *	event,
		Double_t	Exx,
		Long64_t	npartitions,
		Long64_t	nev_part = `10`
	)

Generate (npartitions*nev_part) events for a given value of excitation energy 'Exx' [MeV]. For efficiency, for each chosen partition we generate nev_part events. This means :

calculating the statistical weight of all available decay channels/partitions
picking a channel at random
generating momenta of all nuclei in chosen channel
filling the TTree with the new event

Definition at line 252 of file MCSampler.cpp.

◆ GetLegendProbaMin()

Double_t MicroStat::MCSampler::GetLegendProbaMin ( ) const

inline

Definition at line 105 of file MCSampler.h.

◆ GetPartition()

KVEvent* MicroStat::MCSampler::GetPartition ( Long64_t i )

inline

Return pointer to partition with index i in the TTree/TChain fPartitionList

Definition at line 55 of file MCSampler.h.

◆ GetRandomChannelWeight()

StatWeight* MicroStat::MCSampler::GetRandomChannelWeight ( ) const

inline

Definition at line 83 of file MCSampler.h.

◆ GetSumWeights()

Double_t MicroStat::MCSampler::GetSumWeights ( ) const

inline

Definition at line 77 of file MCSampler.h.

◆ GetWeight()

StatWeight* MicroStat::MCSampler::GetWeight ( Int_t i ) const

inline

Definition at line 73 of file MCSampler.h.

◆ GetWeights()

TClonesArray* MicroStat::MCSampler::GetWeights ( ) const

inline

Definition at line 69 of file MCSampler.h.

◆ PickRandomChannel()

Long64_t MicroStat::MCSampler::PickRandomChannel ( )

Return the TTree index of a random channel according to the previously calculated weights The corresponding weight for the chosen channel can be retrieved by calling GetRandomChannelWeight() If no channel is open (i.e. all weights = 0, E* < Q value of first channel), we return -1.

Definition at line 169 of file MCSampler.cpp.

◆ PlotMultiplicities()

void MicroStat::MCSampler::PlotMultiplicities	(	double	emin = `0.`,
		double	emax = `100.`,
		double	estep = `1.`,
		Option_t *	opt = `""`
	)

Plot multiplicities of n,p,d,t,3He,4He,... as a function of E* (default) or EA (opt="EA")

Definition at line 469 of file MCSampler.cpp.

◆ PlotProbabilities()

void MicroStat::MCSampler::PlotProbabilities	(	double	emin = `0.`,
		double	emax = `100.`,
		double	estep = `1.`,
		Option_t *	opt = `""`
	)

Plot probability of each channel as a function of E* (default) or EA (opt="EA")

If SetLegendProbaMin has previously been called with a >0 value for the minimum probability, we generate a TLegend which contains only the channels whose probability reaches at least this minimum value in the given energy range. Call ShowLegend immediately after this method in order to display in current pad.

Definition at line 372 of file MCSampler.cpp.

◆ SetDecayChannel()

Bool_t MicroStat::MCSampler::SetDecayChannel ( )

Pick a random decay channel with excitation energy given to previous call to SetExcitationEnergy method. Returns kFALSE if no channel is open.

Definition at line 312 of file MCSampler.cpp.

◆ SetEventList()

void MicroStat::MCSampler::SetEventList	(	TTree *	t,
		const TString &	branchname
	)

Define the TTree or TChain containing all possible events (partitions).

Definition at line 83 of file MCSampler.cpp.

◆ SetExcitationEnergy()

Bool_t MicroStat::MCSampler::SetExcitationEnergy ( Double_t Exx )

Define excitation energy for random event generation This will calculate the channel weights for all partitions If sumOfWeights = 0 i.e. no channels are open, return kFALSE

Definition at line 294 of file MCSampler.cpp.

◆ SetLegendProbaMin()

void MicroStat::MCSampler::SetLegendProbaMin ( Double_t p )

inline

set minimum probability for which channels are included in automatically generated TLegend when PlotProbabilities is called this legend can be displayed by calling ShowLegend immediately after the call to PlotProbabilities. default is to include all channels.

Definition at line 96 of file MCSampler.h.

◆ SetModifyMasses()

void MicroStat::MCSampler::SetModifyMasses ( Bool_t yes = kTRUE )

inline

Definition at line 62 of file MCSampler.h.

◆ SetStatWeight()

void MicroStat::MCSampler::SetStatWeight ( const TString & w )

Set the kind of statistical weight to be used This is the name of a class derived from MicroStat::StatWeight

Definition at line 102 of file MCSampler.cpp.

◆ SetUpTreeBranches()

void MicroStat::MCSampler::SetUpTreeBranches	(	KVEvent *&	event,
		TTree *	theTree,
		const TString &	bname
	)

If branch 'bname' does not exist in 'theTree', it will be created and linked to 'event' which must contain the address of a valid KVEvent object. If branch already exists, we link it to 'event'.

Branches will also be created/filled with the following information: ESTAR/D the excitation energy (Exx) EDISP/D the available kinetic energy IPART/I the partition index

Definition at line 219 of file MCSampler.cpp.

◆ ShowLegend()

void MicroStat::MCSampler::ShowLegend ( )

inline

call immediately after a call to PlotProbabilities or PlotParticleMultiplicities in order to display the automatically generated TLegend containing all channels with probability > fLegendProbaMin or all nuclei with multiplicity > fLegendMultMin (set previously by call to SetLegendProbaMin/SetLegendMultMin).

Definition at line 109 of file MCSampler.h.

◆ UpdateMasses()

void MicroStat::MCSampler::UpdateMasses ( )

if nuclear masses are modified, we have to update those in the partition read from file

Definition at line 119 of file MCSampler.cpp.

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ MCSampler() [1/2]

◆ MCSampler() [2/2]

◆ ~MCSampler()

Member Function Documentation

◆ CalculateWeights()

◆ GenerateEvent()

◆ GenerateEvents()

◆ GetLegendProbaMin()

◆ GetPartition()

◆ GetRandomChannelWeight()

◆ GetSumWeights()

◆ GetWeight()

◆ GetWeights()

◆ PickRandomChannel()

◆ PlotMultiplicities()

◆ PlotProbabilities()

◆ SetDecayChannel()

◆ SetEventList()

◆ SetExcitationEnergy()

◆ SetLegendProbaMin()

◆ SetModifyMasses()

◆ SetStatWeight()

◆ SetUpTreeBranches()

◆ ShowLegend()

◆ UpdateMasses()