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:

[legend]

Public Member Functions
	MCSampler ()
	Default constructor.

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

virtual	~MCSampler ()
	Destructor.

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

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.

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

	KVBase (const KVBase &)
	copy ctor

virtual	~KVBase ()

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

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

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

UInt_t	GetNumberOfObjects () const

virtual TObject *	GetObject () const

virtual const Char_t *	GetType () const

Bool_t	HasLabel () const

virtual Bool_t	IsCalled (const Char_t *name) const

Bool_t	IsLabelled (const Char_t *l) const

virtual Bool_t	IsType (const Char_t *typ) const

virtual void	List ()

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

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

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

void	SetLabel (const Char_t *lab)

virtual void	SetNumber (UInt_t num)

virtual void	SetType (const Char_t *str)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)

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

virtual	~TNamed ()

void	Clear (Option_t *option="") override

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

Int_t	Compare (const TObject *obj) const override

void	Copy (TObject &named) const override

virtual void	FillBuffer (char *&buffer)

const char *	GetName () const override

const char *	GetTitle () const override

ULong_t	Hash () const override

TClass *	IsA () const override

Bool_t	IsSortable () const override

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

TNamed &	operator= (const TNamed &rhs)

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

virtual void	SetName (const char *name)

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

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

virtual Int_t	Sizeof () const

void	Streamer (TBuffer &) override

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()

	TObject (const TObject &object)

virtual	~TObject ()

void	AbstractMethod (const char *method) const

virtual void	AppendPad (Option_t *option="")

virtual void	Browse (TBrowser *b)

ULong_t	CheckedHash ()

virtual const char *	ClassName () const

virtual void	Delete (Option_t *option="")

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)

virtual void	Draw (Option_t *option="")

virtual void	DrawClass () const

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

virtual void	Dump () const

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

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

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

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

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

virtual TObject *	FindObject (const char *name) const

virtual TObject *	FindObject (const TObject *obj) const

virtual Option_t *	GetDrawOption () const

virtual const char *	GetIconName () const

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

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const

virtual Bool_t	HandleTimer (TTimer *timer)

Bool_t	HasInconsistentHash () const

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

virtual Bool_t	InheritsFrom (const char *classname) const

virtual Bool_t	InheritsFrom (const TClass *cl) const

virtual void	Inspect () const

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const

virtual Bool_t	IsEqual (const TObject *obj) const

virtual Bool_t	IsFolder () const

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const

virtual Bool_t	Notify ()

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

void	operator delete (void *ptr)

void	operator delete (void ptr, void vp)

void	operator delete[] (void *ptr)

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

void *	operator new (size_t sz)

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

void *	operator new[] (size_t sz)

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

TObject &	operator= (const TObject &rhs)

virtual void	Paint (Option_t *option="")

virtual void	Pop ()

virtual Int_t	Read (const char *name)

virtual void	RecursiveRemove (TObject *obj)

void	ResetBit (UInt_t f)

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

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

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)

virtual void	SetDrawOption (Option_t *option="")

virtual void	SetUniqueID (UInt_t uid)

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()

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

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

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

Private Member Functions
void	init ()
	default initialisations

void	initialiseWeightList ()
	if nuclear masses are modified

void	SetBranch (TTree theTree, const TString &name, void variable, const TString &vartype)
	automatically generated legend for PlotProbabilities

Private Attributes
Double_t	EDISP
	the excitation energy (Exx)

Double_t	ESTAR
	variables for TTree branches

TBranch *	fBranch
	number of partitions in TTree/TChain

StatWeight *	fLastPicked

Double_t	fLegendProbaMin
	weight of channel picked by call to PickRandomChannel()

Bool_t	fModifyMasses
	the partition index

KVEvent *	fPartition
	branch containing events

Long64_t	fPartitions

Double_t	fSumWeights
	list of weights for all events

TLegend *	fTheLegend
	minimum probability for which channels are included in automatically generated TLegend when PlotProbabilities is called

TClass *	fWeight
	event read from fPartitionList tree

TClonesArray *	fWeightList
	statistical weight class

Long64_t	IPART
	the available kinetic energy

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

Public Types inherited from TObject
enum	EDeprecatedStatusBits

enum	EStatusBits

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

static void	BackupFileWithDate (const Char_t *path)

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

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

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

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

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

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

static const Char_t *	GetDATABASEFilePath ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static const Char_t *	GetListOfPlugins (const Char_t *base)

static const Char_t *	GetListOfPluginURIs (const Char_t *base)

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

static void	GetTempFileName (TString &base)

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

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

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

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

static void	InitEnvironment ()

static bool	is_gnuinstall ()

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

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

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

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

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

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

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

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

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

static const Char_t *	WorkingDirectory ()

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

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

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

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()

static Bool_t	GetObjectStat ()

static void	SetDtorOnly (void *obj)

static void	SetObjectStat (Bool_t stat)

Public Attributes inherited from TObject
	kBitMask

	kCanDelete

	kCannotPick

	kHasUUID

	kInconsistent

	kInvalidObject

	kIsOnHeap

	kIsReferenced

	kMustCleanup

	kNoContextMenu

	kNotDeleted

	kObjInCanvas

	kOverwrite

	kSingleKey

	kWriteDelete

	kZombie

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

void	MakeZombie ()

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Protected Attributes inherited from TObject
	kOnlyPrepStep

Constructor & Destructor Documentation

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

◆ init()

void MicroStat::MCSampler::init ( void )

private

default initialisations

Definition at line 21 of file MCSampler.cpp.

◆ initialiseWeightList()

void MicroStat::MCSampler::initialiseWeightList ( )

private

if nuclear masses are modified

set up the TClonesArray

Definition at line 36 of file MCSampler.cpp.

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

◆ SetBranch()

void MicroStat::MCSampler::SetBranch	(	TTree *	theTree,
		const TString &	name,
		void *	variable,
		const TString &	vartype
	)

private

automatically generated legend for PlotProbabilities

Definition at line 198 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.

Member Data Documentation

◆ EDISP

Double_t MicroStat::MCSampler::EDISP

private

the excitation energy (Exx)

Definition at line 40 of file MCSampler.h.

◆ ESTAR

Double_t MicroStat::MCSampler::ESTAR

private

variables for TTree branches

sum of all weights

Definition at line 39 of file MCSampler.h.

◆ fBranch

TBranch* MicroStat::MCSampler::fBranch

private

number of partitions in TTree/TChain

Definition at line 33 of file MCSampler.h.

◆ fLastPicked

StatWeight* MicroStat::MCSampler::fLastPicked

private

Definition at line 25 of file MCSampler.h.

◆ fLegendProbaMin

Double_t MicroStat::MCSampler::fLegendProbaMin

private

weight of channel picked by call to PickRandomChannel()

Definition at line 26 of file MCSampler.h.

◆ fModifyMasses

Bool_t MicroStat::MCSampler::fModifyMasses

private

the partition index

Definition at line 43 of file MCSampler.h.

◆ fPartition

KVEvent* MicroStat::MCSampler::fPartition

private

branch containing events

Definition at line 34 of file MCSampler.h.

◆ fPartitions

Long64_t MicroStat::MCSampler::fPartitions

private

Definition at line 32 of file MCSampler.h.

◆ fSumWeights

Double_t MicroStat::MCSampler::fSumWeights

private

list of weights for all events

Definition at line 37 of file MCSampler.h.

◆ fTheLegend

TLegend* MicroStat::MCSampler::fTheLegend

private

minimum probability for which channels are included in automatically generated TLegend when PlotProbabilities is called

Definition at line 27 of file MCSampler.h.

◆ fWeight

TClass* MicroStat::MCSampler::fWeight

private

event read from fPartitionList tree

Definition at line 35 of file MCSampler.h.

◆ fWeightList

TClonesArray* MicroStat::MCSampler::fWeightList

private

statistical weight class

Definition at line 36 of file MCSampler.h.

◆ IPART

Long64_t MicroStat::MCSampler::IPART

private

the available kinetic energy

Definition at line 41 of file MCSampler.h.

Detailed Description

Public Member Functions

Private Member Functions

Private Attributes

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

◆ init()

◆ initialiseWeightList()

◆ PickRandomChannel()

◆ PlotMultiplicities()

◆ PlotProbabilities()

◆ SetBranch()

◆ SetDecayChannel()

◆ SetEventList()

◆ SetExcitationEnergy()

◆ SetLegendProbaMin()

◆ SetModifyMasses()

◆ SetStatWeight()

◆ SetUpTreeBranches()

◆ ShowLegend()

◆ UpdateMasses()

Member Data Documentation

◆ EDISP

◆ ESTAR

◆ fBranch

◆ fLastPicked

◆ fLegendProbaMin

◆ fModifyMasses

◆ fPartition

◆ fPartitions

◆ fSumWeights

◆ fTheLegend

◆ fWeight

◆ fWeightList

◆ IPART