Detailed Description

RESTSoft : Software for Rare Event Searches with TPCs

Class to store a particle definition

jul 2015: First concept Created as part of the conceptualization of existing REST software. J. Galan

Definition at line 32 of file TRestGeant4ParticleSource.h.

#include <TRestGeant4ParticleSource.h>

Inheritance diagram for TRestGeant4ParticleSource:

Public Member Functions
void	AddParticle (const TRestGeant4Particle &particle)

	ClassDefOverride (TRestGeant4ParticleSource, 5)

void	FlushParticlesTemplate ()

TString	GetAngularDistributionFilename () const

size_t	GetAngularDistributionFormulaNPoints () const

const TF1 *	GetAngularDistributionFunction () const

TString	GetAngularDistributionNameInFile () const

TVector2	GetAngularDistributionRange () const

Double_t	GetAngularDistributionRangeMax () const

Double_t	GetAngularDistributionRangeMin () const

TString	GetAngularDistributionType () const

TVector3	GetDirection () const

const TF2 *	GetEnergyAndAngularDistributionFunction () const

TString	GetEnergyDistributionFilename () const

size_t	GetEnergyDistributionFormulaNPoints () const

const TF1 *	GetEnergyDistributionFunction () const

TString	GetEnergyDistributionNameInFile () const

TVector2	GetEnergyDistributionRange () const

Double_t	GetEnergyDistributionRangeMax () const

Double_t	GetEnergyDistributionRangeMin () const

TString	GetEnergyDistributionType () const

TString	GetGenFilename () const

std::vector< TRestGeant4Particle >	GetParticles () const

virtual void	InitFromConfigFile () override
	To make settings from rml file. This method must be implemented in the derived class.

virtual void	PrintMetadata () override
	Implemented it in the derived metadata class to print out specific metadata information. More...

void	RemoveParticles ()

void	RemoveTemplates ()

void	SetAngularDistributionFilename (const TString &filename)

void	SetAngularDistributionFormula (const TString &formula)

void	SetAngularDistributionFormulaNPoints (size_t nPoints)

void	SetAngularDistributionNameInFile (const TString &name)

void	SetAngularDistributionRange (const TVector2 &range)

void	SetAngularDistributionType (const TString &type)

void	SetEnergyAndAngularDistributionFormula (const TString &formula)

void	SetEnergyDistributionFilename (const TString &filename)

void	SetEnergyDistributionFormula (const TString &formula)

void	SetEnergyDistributionFormulaNPoints (size_t nPoints)

void	SetEnergyDistributionNameInFile (const TString &name)

void	SetEnergyDistributionRange (const TVector2 &range)

void	SetEnergyDistributionType (const TString &type)

void	SetGenFilename (const TString &name)

void	SetRandomMethod (double(*method)())

virtual void	Update ()

Public Member Functions inherited from TRestGeant4Particle
Double_t	GetEnergy () const

Double_t	GetExcitationLevel () const

TVector3	GetMomentumDirection () const

TVector3	GetOrigin () const

Int_t	GetParticleCharge () const

TString	GetParticleName () const

void	Print () const
	Prints on screen the details about the Geant4 simulation conditions, stored in TRestGeant4Metadata.

void	SetDirection (TVector3 dir)

void	SetEnergy (Double_t en)

void	SetExcitationLevel (Double_t excitationEnergy)

void	SetOrigin (TVector3 pos)

void	SetParticle (TRestGeant4Particle particle)
	A copy method.

void	SetParticleCharge (Int_t charge)

void	SetParticleName (TString particle)

Public Member Functions inherited from TRestMetadata
void	AddLog (std::string log="", bool print=true)
	Add logs to messageBuffer.

void	DoNotStore ()
	If this method is called the metadata information will not be stored in disk.

TVector2	Get2DVectorParameterWithUnits (std::string parName, TVector2 defaultValue=TVector2(-1, -1))

TVector3	Get3DVectorParameterWithUnits (std::string parName, TVector3 defaultValue=TVector3(-1, -1, -1))

TString	GetCommit ()
	Returns the REST commit value stored in fCommit.

std::string	GetConfigBuffer ()
	Returns the config section of this class.

std::string	GetDataMemberValue (std::string memberName)
	Get the value of data member as string. More...

std::vector< std::string >	GetDataMemberValues (std::string memberName, Int_t precision=0)
	Get the value of datamember as a vector of strings. More...

TString	GetDataPath ()
	Returns a std::string with the path used for data storage.

Double_t	GetDblParameterWithUnits (std::string parName, Double_t defaultValue=PARAMETER_NOT_FOUND_DBL)
	Gets the value of the parameter name parName, after applying unit conversion. More...

Bool_t	GetError () const
	It returns true if an error was identified by a derived metadata class.

TString	GetErrorMessage ()
	Returns a std::string containing the error message.

TString	GetLibraryVersion ()
	Returns the REST libraty version stored in fLibraryVersion.

TString	GetMainDataPath ()
	Gets a std::string with the path used for data storage.

Int_t	GetNumberOfErrors () const

Int_t	GetNumberOfWarnings () const

std::string	GetParameter (std::string parName, TString defaultValue=PARAMETER_NOT_FOUND_STR)
	Returns corresponding REST Metadata parameter from multiple sources. More...

std::string	GetSectionName ()
	Returns the section name of this class, defined at the beginning of fSectionName.

TRestStringOutput::REST_Verbose_Level	GetVerboseLevel ()
	returns the verboselevel in type of REST_Verbose_Level enumerator

TString	GetVerboseLevelString ()
	returns the verbose level in type of TString More...

TString	GetVersion ()
	Returns the REST version stored in fVersion.

Int_t	GetVersionCode ()

UInt_t	GetVersionMajor () const

UInt_t	GetVersionMinor () const

UInt_t	GetVersionPatch () const

Bool_t	GetWarning () const
	It returns true if an error was identified by a derived metadata class.

TString	GetWarningMessage ()
	Returns a std::string containing the warning message.

virtual void	Initialize ()
	Making default settings.

TRestMetadata *	InstantiateChildMetadata (int index, std::string pattern="")
	This method will retrieve a new TRestMetadata instance of a child element of the present TRestMetadata instance based on the `index` given by argument, which defines the element order to be retrieved, 0 for first element found, 1 for the second element found, etc. More...

TRestMetadata *	InstantiateChildMetadata (std::string pattern="", std::string name="")
	This method will retrieve a new TRestMetadata instance of a child element of the present TRestMetadata instance based on the `name` given by argument. More...

Bool_t	isCleanState () const

Bool_t	isOfficialRelease () const

Int_t	LoadConfigFromBuffer ()
	Initialize data from a string element buffer. More...

Int_t	LoadConfigFromElement (TiXmlElement eSectional, TiXmlElement eGlobal, std::map< std::string, std::string > envs={})
	Main starter method. More...

Int_t	LoadConfigFromFile (const std::string &configFilename, const std::string &sectionName="")
	Give the file name, find out the corresponding section. Then call the main starter.

virtual void	Merge (const TRestMetadata &)

TRestMetadata &	operator= (const TRestMetadata &)

void	Print ()
	Implementing TObject::Print() method.

void	PrintConfigBuffer ()
	Print the config xml section stored in the class. More...

void	PrintMessageBuffer ()
	Print the buffered message.

void	PrintTimeStamp (Double_t timeStamp)
	Print the current time on local machine. More...

void	SetConfigFile (std::string configFilename)
	set config file path from external

void	SetError (std::string message="", bool print=true, int maxPrint=5)
	A metadata class may use this method to signal that something went wrong.

void	SetHostmgr (TRestManager *m)
	Set the host manager for this class.

void	SetSectionName (std::string sName)
	set the section name, clear the section content

void	SetVerboseLevel (TRestStringOutput::REST_Verbose_Level v)
	sets the verbose level

void	SetWarning (std::string message="", bool print=true, int maxPrint=5)
	A metadata class may use this method to signal that something went wrong.

void	Store ()
	If this method is called the metadata information will be stored in disk.

	TRestMetadata (const TRestMetadata &)

virtual void	UpdateMetadataMembers ()
	Method to allow implementation of specific metadata members updates at inherited classes.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	overwriting the write() method with fStore considered

void	WriteConfigBuffer (std::string fName)
	Writes the config buffer to a file in append mode.

	~TRestMetadata ()
	TRestMetadata default destructor.

Static Public Member Functions
static TRestGeant4ParticleSource *	instantiate (std::string model="")

Protected Attributes
TString	fAngularDistributionFilename

size_t	fAngularDistributionFormulaNPoints = 500

TF1 *	fAngularDistributionFunction = nullptr

TString	fAngularDistributionNameInFile

TVector2	fAngularDistributionRange

TString	fAngularDistributionType = "Flux"

TF2 *	fEnergyAndAngularDistributionFunction = nullptr

TString	fEnergyDistributionFilename

size_t	fEnergyDistributionFormulaNPoints = 5000

TF1 *	fEnergyDistributionFunction = nullptr

TString	fEnergyDistributionNameInFile

TVector2	fEnergyDistributionRange

TString	fEnergyDistributionType = "Mono"

TString	fGenFilename

std::vector< TRestGeant4Particle >	fParticles

std::vector< std::vector< TRestGeant4Particle > >	fParticlesTemplate

double(*	fRandomMethod )()

Protected Attributes inherited from TRestGeant4Particle
Int_t	fCharge = 0

TVector3	fDirection = {1, 0, 0}

Double_t	fEnergy = 0

Double_t	fExcitationLevel = 0

TVector3	fOrigin

TString	fParticleName

Protected Attributes inherited from TRestMetadata
std::string	configBuffer
	The buffer where the corresponding metadata section is stored. Filled only during Write()

std::string	fConfigFileName
	Full name of the rml file. More...

std::map< std::string, std::string >	fConstants
	Saving a list of rml constants. name-value std::pair. Constants are temporary for this class only.

TiXmlElement *	fElement
	Saving the sectional element together with global element.

TiXmlElement *	fElementGlobal
	Saving the global element, to be passed to the resident class, if necessary.

Bool_t	fError = false
	It can be used as a way to identify that something went wrong using SetError method.

TString	fErrorMessage = ""
	A std::string to store an optional error message through method SetError.

TRestManager *	fHostmgr
	All metadata classes can be initialized and managed by TRestManager.

Int_t	fNErrors = 0
	It counts the number of errors notified.

Int_t	fNWarnings = 0
	It counts the number of warnings notified.

std::string	fSectionName
	Section name given in the constructor of the derived metadata class.

Bool_t	fStore
	This variable is used to determine if the metadata structure should be stored in the ROOT file.

std::map< std::string, std::string >	fVariables
	Saving a list of rml variables. name-value std::pair.

TRestStringOutput::REST_Verbose_Level	fVerboseLevel
	Verbose level used to print debug info.

Bool_t	fWarning = false
	It can be used as a way to identify that something went wrong using SetWarning method.

TString	fWarningMessage = ""
	It can be used as a way to identify that something went wrong using SetWarning method.

std::string	messageBuffer
	The buffer to store the output message through TRestStringOutput in this class.

endl_t	RESTendl
	Termination flag object for TRestStringOutput.

Private Member Functions
void	ReadEventDataFile (TString fName)
	Reads an input file produced by Decay0. More...

bool	ReadNewDecay0File (TString fileName)
	Reads particle information using the file format from newer Decay0 versions. More...

bool	ReadOldDecay0File (TString fileName)
	Reads particle information using the file format from older Decay0 versions. More...

Additional Inherited Members
Protected Member Functions inherited from TRestMetadata
std::string	ElementToString (TiXmlElement *ele)
	Convert an TiXmlElement object to string. More...

TVector2	Get2DVectorParameterWithUnits (std::string parName, TiXmlElement *e, TVector2 defaultValue=TVector2(-1, -1))

TVector3	Get3DVectorParameterWithUnits (std::string parName, TiXmlElement *e, TVector3 defaultValue=TVector3(-1, -1, -1))

Double_t	GetDblParameterWithUnits (std::string parName, TiXmlElement *e, Double_t defaultVal=PARAMETER_NOT_FOUND_DBL)

TiXmlElement *	GetElement (std::string eleDeclare, TiXmlElement *e=nullptr)
	Get an xml element from a given parent element, according to its declaration.

TiXmlElement *	GetElementFromFile (std::string configFilename, std::string NameOrDecalre="")
	Open an xml encoded file and find its element. More...

TiXmlElement *	GetElementWithName (std::string eleDeclare, std::string eleName)
	Get an xml element from the default location, according to its declaration and its field "name".

TiXmlElement *	GetElementWithName (std::string eleDeclare, std::string eleName, TiXmlElement *e)
	Get an xml element from a given parent element, according to its declaration and its field "name".

std::string	GetFieldValue (std::string fieldName, std::string definition, size_t fromPosition=0)
	Gets field value in an xml element string by parsing it as TiXmlElement.

std::string	GetFieldValue (std::string parName, TiXmlElement *e)
	Returns the field value of an xml element which has the specified name. More...

std::string	GetKEYDefinition (std::string keyName)
	Gets the first key definition for keyName found inside buffer starting at fromPosition. More...

std::string	GetKEYDefinition (std::string keyName, size_t &Position)

std::string	GetKEYDefinition (std::string keyName, size_t &Position, std::string buffer)

std::string	GetKEYDefinition (std::string keyName, std::string buffer)

std::string	GetKEYStructure (std::string keyName)
	Gets the first key structure for keyName found inside buffer after fromPosition. More...

std::string	GetKEYStructure (std::string keyName, size_t &Position)

std::string	GetKEYStructure (std::string keyName, size_t &Position, std::string buffer)

std::string	GetKEYStructure (std::string keyName, size_t &Position, TiXmlElement *ele)

std::string	GetKEYStructure (std::string keyName, std::string buffer)

TiXmlElement *	GetNextElement (TiXmlElement *e)
	Get the next sibling xml element of this element, with same eleDeclare.

std::string	GetParameter (std::string parName, size_t &pos, std::string inputString)
	Returns the value for the parameter name parName found in inputString. More...

std::string	GetParameter (std::string parName, TiXmlElement *e, TString defaultValue=PARAMETER_NOT_FOUND_STR)
	Returns the value for the parameter named parName in the given section. More...

std::pair< std::string, std::string >	GetParameterAndUnits (std::string parname, TiXmlElement *e=nullptr)
	Returns the unit string of the given parameter of the given xml section. More...

std::map< std::string, std::string >	GetParametersList ()
	It retrieves a map of all parameter:value found in the metadata class.

TString	GetSearchPath ()

virtual void	InitFromRootFile ()
	Method called after the object is retrieved from root file.

virtual Int_t	LoadSectionMetadata ()
	This method does some preparation of xml section. More...

void	ReadAllParameters ()
	Reflection methods, Set value of a datamember in class according to TRestMetadata::fElement. More...

void	ReadParametersList (std::map< std::string, std::string > &list)
	It reads a parameter list and associates it to its corresponding metadata member. par0 --> fPar0.

std::string	ReplaceConstants (const std::string buffer)
	Identifies "constants" in the input buffer, and replace them with corresponding value. More...

std::string	ReplaceVariables (const std::string buffer)
	Identifies environmental variable replacing marks in the input buffer, and replace them with corresponding value. More...

void	ReSetVersion ()
	Resets the version of TRestRun to REST_RELEASE. Only TRestRun is allowed to update version.

std::string	SearchFile (std::string filename)
	Search files in current directory and directories specified in "searchPath" section. More...

void	SetLibraryVersion (TString version)
	Set the library version of this metadata class.

TiXmlElement *	StringToElement (std::string definition)
	Parsing a string into TiXmlElement object. More...

	TRestMetadata ()
	TRestMetadata default constructor.

	TRestMetadata (const char *configFilename)
	constructor

void	UnSetVersion ()
	Resets the version of TRestRun to -1, in case the file is old REST file. Only TRestRun is allowed to update version.

Member Function Documentation

◆ PrintMetadata()

void TRestGeant4ParticleSource::PrintMetadata ( )

overridevirtual

Implemented it in the derived metadata class to print out specific metadata information.

Prints metadata content on screen. Usually overloaded by the derived metadata class.

Reimplemented from TRestMetadata.

Reimplemented in TRestGeant4ParticleSourceDecay0, and TRestGeant4ParticleSourceCry.

Definition at line 35 of file TRestGeant4ParticleSource.cxx.

◆ ReadEventDataFile()

void TRestGeant4ParticleSource::ReadEventDataFile ( TString fName )

private

Reads an input file produced by Decay0.

The input file should contain the description of several pre-generated events, providing the names (or ids) of particles to be produced, their energy, and momentum. The particles and their properties are stored in a TRestG4ParticleCollection which will be randomly accessed by the restG4 package.

Parameters

fName The Decay0 filename located at REST_PATH/data/generator/

Definition at line 162 of file TRestGeant4ParticleSource.cxx.

◆ ReadNewDecay0File()

bool TRestGeant4ParticleSource::ReadNewDecay0File ( TString fileName )

private

Reads particle information using the file format from newer Decay0 versions.

This is an auxiliar method used in TRestG4Metadata::ReadEventDataFile that will read the Decay0 files produced with the newer Decay0 versions.

Definition at line 174 of file TRestGeant4ParticleSource.cxx.

◆ ReadOldDecay0File()

bool TRestGeant4ParticleSource::ReadOldDecay0File ( TString fileName )

private

Reads particle information using the file format from older Decay0 versions.

This is an auxiliar method used in TRestG4Metadata::ReadEventDataFile that will read the Decay0 files produced with the newer Decay0 versions.

Definition at line 270 of file TRestGeant4ParticleSource.cxx.

The documentation for this class was generated from the following files:

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Member Function Documentation

◆ PrintMetadata()

◆ ReadEventDataFile()

◆ ReadNewDecay0File()

◆ ReadOldDecay0File()