REST-for-Physics
v2.3
Rare Event Searches ToolKit for Physics
|
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>
Public Member Functions | |
void | AddParticle (const TRestGeant4Particle &particle) |
ClassDefOverride (TRestGeant4ParticleSource, 6) | |
void | FlushParticlesTemplate () |
TString | GetAngularDistributionFilename () const |
size_t | GetAngularDistributionFormulaNPoints () const |
const TF1 * | GetAngularDistributionFunction () const |
double | GetAngularDistributionIsotropicConeHalfAngle () 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. More... | |
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 | SetAngularDistributionIsotropicConeHalfAngle (double angle) |
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 () |
![]() | |
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. More... | |
void | SetDirection (const TVector3 &dir) |
void | SetEnergy (Double_t en) |
void | SetExcitationLevel (Double_t excitationEnergy) |
void | SetOrigin (const TVector3 &pos) |
void | SetParticle (TRestGeant4Particle particle) |
A copy method. More... | |
void | SetParticleCharge (Int_t charge) |
void | SetParticleName (TString particle) |
![]() | |
void | AddLog (std::string log="", bool print=true) |
Add logs to messageBuffer. More... | |
void | DoNotStore () |
If this method is called the metadata information will not be stored in disk. More... | |
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. More... | |
std::string | GetConfigBuffer () |
Returns the config section of this class. More... | |
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. More... | |
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. More... | |
TString | GetErrorMessage () |
Returns a std::string containing the error message. More... | |
TString | GetLibraryVersion () |
Returns the REST libraty version stored in fLibraryVersion. More... | |
TString | GetMainDataPath () |
Gets a std::string with the path used for data storage. More... | |
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. More... | |
TRestStringOutput::REST_Verbose_Level | GetVerboseLevel () |
returns the verboselevel in type of REST_Verbose_Level enumerator More... | |
TString | GetVerboseLevelString () |
returns the verbose level in type of TString More... | |
TString | GetVersion () |
Returns the REST version stored in fVersion. More... | |
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. More... | |
TString | GetWarningMessage () |
Returns a std::string containing the warning message. More... | |
virtual void | Initialize () |
Making default settings. More... | |
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 §ionName="") |
Give the file name, find out the corresponding section. Then call the main starter. More... | |
virtual void | Merge (const TRestMetadata &) |
TRestMetadata & | operator= (const TRestMetadata &) |
void | Print () |
Implementing TObject::Print() method. More... | |
void | PrintConfigBuffer () |
Print the config xml section stored in the class. More... | |
void | PrintMessageBuffer () |
Print the buffered message. More... | |
virtual void | PrintMetadata () |
Implemented it in the derived metadata class to print out specific metadata information. More... | |
void | PrintTimeStamp (Double_t timeStamp) |
Print the current time on local machine. More... | |
void | SetConfigFile (std::string configFilename) |
set config file path from external More... | |
void | SetError (std::string message="", bool print=true, int maxPrint=5) |
A metadata class may use this method to signal that something went wrong. More... | |
void | SetHostmgr (TRestManager *m) |
Set the host manager for this class. More... | |
void | SetSectionName (std::string sName) |
set the section name, clear the section content More... | |
void | SetVerboseLevel (TRestStringOutput::REST_Verbose_Level v) |
sets the verbose level More... | |
void | SetWarning (std::string message="", bool print=true, int maxPrint=5) |
A metadata class may use this method to signal that something went wrong. More... | |
void | Store () |
If this method is called the metadata information will be stored in disk. More... | |
TRestMetadata (const TRestMetadata &) | |
virtual void | UpdateMetadataMembers () |
Method to allow implementation of specific metadata members updates at inherited classes. More... | |
virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) |
overwriting the write() method with fStore considered More... | |
void | WriteConfigBuffer (std::string fName) |
Writes the config buffer to a file in append mode. More... | |
~TRestMetadata () | |
TRestMetadata default destructor. More... | |
Static Public Member Functions | |
static TRestGeant4ParticleSource * | instantiate (std::string model="") |
Protected Attributes | |
TString | fAngularDistributionFilename |
size_t | fAngularDistributionFormulaNPoints = 500 |
TF1 * | fAngularDistributionFunction = nullptr |
double | fAngularDistributionIsotropicConeHalfAngle = 0 |
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 )() |
![]() | |
Int_t | fCharge = 0 |
TVector3 | fDirection = {1, 0, 0} |
Double_t | fEnergy = 0 |
Double_t | fExcitationLevel = 0 |
TVector3 | fOrigin |
TString | fParticleName |
![]() | |
std::string | configBuffer |
The buffer where the corresponding metadata section is stored. Filled only during Write() More... | |
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. More... | |
TiXmlElement * | fElement |
Saving the sectional element together with global element. More... | |
TiXmlElement * | fElementGlobal |
Saving the global element, to be passed to the resident class, if necessary. More... | |
Bool_t | fError = false |
It can be used as a way to identify that something went wrong using SetError method. More... | |
TString | fErrorMessage = "" |
A std::string to store an optional error message through method SetError. More... | |
TRestManager * | fHostmgr |
All metadata classes can be initialized and managed by TRestManager. More... | |
Int_t | fNErrors = 0 |
It counts the number of errors notified. More... | |
Int_t | fNWarnings = 0 |
It counts the number of warnings notified. More... | |
std::string | fSectionName |
Section name given in the constructor of the derived metadata class. More... | |
Bool_t | fStore |
This variable is used to determine if the metadata structure should be stored in the ROOT file. More... | |
std::map< std::string, std::string > | fVariables |
Saving a list of rml variables. name-value std::pair. More... | |
TRestStringOutput::REST_Verbose_Level | fVerboseLevel |
Verbose level used to print debug info. More... | |
Bool_t | fWarning = false |
It can be used as a way to identify that something went wrong using SetWarning method. More... | |
TString | fWarningMessage = "" |
It can be used as a way to identify that something went wrong using SetWarning method. More... | |
std::string | messageBuffer |
The buffer to store the output message through TRestStringOutput in this class. More... | |
endl_t | RESTendl |
Termination flag object for TRestStringOutput. More... | |
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 | |
![]() | |
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. More... | |
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". More... | |
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". More... | |
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. More... | |
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. More... | |
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. More... | |
TString | GetSearchPath () |
virtual void | InitFromConfigFile () |
To make settings from rml file. This method must be implemented in the derived class. More... | |
virtual void | InitFromRootFile () |
Method called after the object is retrieved from root file. More... | |
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. More... | |
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. More... | |
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. More... | |
TiXmlElement * | StringToElement (std::string definition) |
Parsing a string into TiXmlElement object. More... | |
TRestMetadata () | |
TRestMetadata default constructor. More... | |
TRestMetadata (const char *configFilename) | |
constructor More... | |
void | UnSetVersion () |
Resets the version of TRestRun to -1, in case the file is old REST file. Only TRestRun is allowed to update version. More... | |
|
inline |
Definition at line 195 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 199 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 85 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 84 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 87 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 88 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 86 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 81 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 83 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 82 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 80 of file TRestGeant4ParticleSource.h.
TVector3 TRestGeant4ParticleSource::GetDirection | ( | ) | const |
Definition at line 164 of file TRestGeant4ParticleSource.cxx.
|
inline |
Definition at line 92 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 76 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 75 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 78 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 77 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 72 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 74 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 73 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 71 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 96 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 98 of file TRestGeant4ParticleSource.h.
|
overridevirtual |
To make settings from rml file. This method must be implemented in the derived class.
Reimplemented from TRestMetadata.
Reimplemented in TRestGeant4ParticleSourceCosmics, TRestGeant4ParticleSourceCry, and TRestGeant4ParticleSourceDecay0.
Definition at line 130 of file TRestGeant4ParticleSource.cxx.
|
static |
Definition at line 108 of file TRestGeant4ParticleSource.cxx.
|
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 TRestGeant4ParticleSourceCry, and TRestGeant4ParticleSourceDecay0.
Definition at line 35 of file TRestGeant4ParticleSource.cxx.
|
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.
fName | The Decay0 filename located at REST_PATH/data/generator/ |
Definition at line 189 of file TRestGeant4ParticleSource.cxx.
|
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 201 of file TRestGeant4ParticleSource.cxx.
|
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 297 of file TRestGeant4ParticleSource.cxx.
|
inline |
Definition at line 197 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 198 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 136 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 142 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 129 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 100 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 139 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 114 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 110 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 183 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 172 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 176 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 165 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 175 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 153 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 149 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 191 of file TRestGeant4ParticleSource.h.
|
inline |
Definition at line 193 of file TRestGeant4ParticleSource.h.
|
virtual |
Reimplemented in TRestGeant4ParticleSourceCry.
Definition at line 151 of file TRestGeant4ParticleSource.cxx.
|
protected |
Definition at line 40 of file TRestGeant4ParticleSource.h.
|
protected |
Definition at line 42 of file TRestGeant4ParticleSource.h.
|
protected |
Definition at line 43 of file TRestGeant4ParticleSource.h.
|
protected |
Definition at line 45 of file TRestGeant4ParticleSource.h.
|
protected |
Definition at line 41 of file TRestGeant4ParticleSource.h.
|
protected |
Definition at line 44 of file TRestGeant4ParticleSource.h.
|
protected |
Definition at line 39 of file TRestGeant4ParticleSource.h.
|
protected |
Definition at line 54 of file TRestGeant4ParticleSource.h.
|
protected |
Definition at line 48 of file TRestGeant4ParticleSource.h.
|
protected |
Definition at line 50 of file TRestGeant4ParticleSource.h.
|
protected |
Definition at line 51 of file TRestGeant4ParticleSource.h.
|
protected |
Definition at line 49 of file TRestGeant4ParticleSource.h.
|
protected |
Definition at line 52 of file TRestGeant4ParticleSource.h.
|
protected |
Definition at line 47 of file TRestGeant4ParticleSource.h.
|
protected |
Definition at line 56 of file TRestGeant4ParticleSource.h.
|
protected |
Definition at line 58 of file TRestGeant4ParticleSource.h.
|
protected |
Definition at line 60 of file TRestGeant4ParticleSource.h.
|
protected |
Definition at line 62 of file TRestGeant4ParticleSource.h.