 |
REST-for-Physics
v2.3
Rare Event Searches ToolKit for Physics
|
|
REST-for-Physics
v2.3
Rare Event Searches ToolKit for Physics
|
A class to load optics response using MCPL files.
TRestAxionMCPLOptics is a class that inherits from TRestAxionOptics. It will load the optics response from a MCPL file, and inherit the common optics description.
This method will implement the pure virtual method PropagatePhoton, that will be responsible to move a particle to the exit plane of the optics. It may use the common methods defined at TRestAxionOptics.
We can add any number of magnetic volumes inside the RML definition as shown in the following piece of code,
Example 1:
RESTsoft - Software for Rare Event Searches with TPCs
History of developments:
2022-February: First concept and implementation of TRestAxionMCPLOptics class. Javier Galan
Definition at line 31 of file TRestAxionMCPLOptics.h.
#include <TRestAxionMCPLOptics.h>
Public Member Functions | |
| ClassDefOverride (TRestAxionMCPLOptics, 1) | |
| TPad * | DrawMirrors () override |
| A method to draw the mirrors. | |
| Double_t | GetEntrancePositionZ () override |
| It returns the entrance Z-position defined by the optical axis. | |
| Double_t | GetExitPositionZ () override |
| It returns the exit Z-position defined by the optical axis. | |
| std::pair< Double_t, Double_t > | GetRadialLimits () override |
| It returns the radial limits at the entrance of the optics. | |
| void | InitFromConfigFile () override |
| Initialization of TRestAxionMCPLOptics field members through a RML file. | |
| void | PrintMetadata () override |
| Prints on screen the information about the metadata members of TRestAxionMCPLOptics. | |
| void | SetMirror () override |
| It must be implemented at the inherited optics, making use of fEntrancePosition. | |
| TRestAxionMCPLOptics () | |
| Default constructor. | |
| TRestAxionMCPLOptics (const char *cfgFileName, std::string name="") | |
| Constructor loading data from a config file. More... | |
| ~TRestAxionMCPLOptics () | |
| Default destructor. | |
 Public Member Functions inherited from TRestAxionOptics | |
| Double_t | CalculateSpotSize (Double_t energy, Double_t z, Int_t particles=15000) |
| It measures the spot size through Monte Carlo at a given plane given by z. If z=0 this method will check for the spot size at the focal point, which is the default behaviour. More... | |
| TPad * | CreatePad (Int_t nx=1, Int_t ny=1) |
| A prototype method to be implemented by specific optics to draw an schematic including the mirrors geometry. | |
| TPad * | DrawDensityMaps (Double_t z, Double_t energy=0, Double_t deviation=0, Int_t particles=1000, Double_t focalHint=7500) |
| It implements a generic method to identify the optimum focal point. It can be reimplemented at each specific optics class. More... | |
| TPad * | DrawParticleTracks (Double_t deviation=0, Int_t particles=10) |
| A method to draw an optics schematic including the mirrors geometry, and few photon tracks. This method is intended for debugging the photon tracking implementation. More... | |
| TPad * | DrawScatterMaps (Double_t z, Double_t energy=0, Double_t deviation=0, Int_t particles=1000, Double_t focalHint=7500) |
| It implements a generic method to identify the optimum focal point. It can be reimplemented at each specific optics class. More... | |
| virtual Double_t | FindFocal (Double_t from, Double_t to, Double_t energy, Double_t precision=1, Bool_t recalculate=false, Int_t particles=5000) |
| It implements a generic method to identify the optimum focal point. It can be reimplemented at each specific optics class. More... | |
| Double_t | GetEntranceAngle () |
| It returns the entrance angle to the optical axis (in radians). | |
| TVector3 | GetEntranceDirection () |
| Returns the entrance position from the latest propagated photon. | |
| TRestCombinedMask *const & | GetEntranceMask () const |
| Returns a pointer to access directly the entrance mask information. | |
| TVector3 | GetEntrancePosition () |
| Returns the entrance position from the latest propagated photon. | |
| TVector3 | GetExitDirection () |
| Returns the exit position from the latest propagated photon. | |
| TRestCombinedMask *const & | GetExitMask () const |
| Returns a pointer to access directly the exit mask information. | |
| TVector3 | GetExitPosition () |
| Returns the exit position from the latest propagated photon. | |
| TVector3 | GetLastGoodDirection () |
| It returns the last valid particle direction known in the particle tracking. | |
| TVector3 | GetLastGoodPosition () |
| It returns the last valid particle position known in the particle tracking. | |
| TVector3 | GetMiddleDirection () |
| Returns the middle position from the latest propagated photon. | |
| TRestCombinedMask *const & | GetMiddleMask () const |
| Returns a pointer to access directly the middle mask information. | |
| TVector3 | GetMiddlePosition () |
| Returns the middle position from the latest propagated photon. | |
| TRestAxionOpticsMirror *const & | GetMirrorProperties () const |
| Returns a pointer to access directly the exit mask information. | |
| Int_t | GetNumberOfReflections () |
| It returns the total number of reflections. Considering maximum 1-reflection per mirror. | |
| void | InitFromConfigFile () |
| Initialization of TRestAxionOptics field members through a RML file. | |
| Bool_t | IsFirstMirrorReflection () |
| It returns true if the photon got reflected in the first mirror. | |
| Bool_t | IsSecondMirrorReflection () |
| It returns true if the photon got reflected in the second mirror. | |
| void | PrintEntranceMask () |
| Prints on screen the mask used on the entrance optics plane. | |
| void | PrintExitMask () |
| Prints on screen the mask used on the exit optics plane. | |
| void | PrintMasks () |
| Prints on screen the 3-optical masks used on the optics planes. | |
| void | PrintMetadata () |
| Prints on screen the information about the metadata members of TRestAxionOptics. | |
| void | PrintMiddleMask () |
| Prints on screen the mask used on the middle optics plane. | |
| void | PrintMirror () |
| Prints on screen the 3-optical masks used on the optics planes. | |
| void | PrintPhotonTrackingSummary () |
| Prints the positions taken by the photon after ray-tracing that should have been updated using the method PropagatePhoton. | |
| Double_t | PropagateMonteCarloPhoton (Double_t energy, Double_t deviation) |
It will produce a MonteCarlo photon spatially distributed in XY as defined by the GetRadialLimits method (extended by 50%), and with direction along the Z-axis with a maximum deviation angle fixed by the deviation input parameter. If deviation=0 the photons will always be parallel to the z-axis. The photons will be launched from z=-3*fMirrorLength. | |
| Double_t | PropagatePhoton (const TVector3 &pos, const TVector3 &dir, Double_t energy) |
| Propagating photon. More... | |
| ~TRestAxionOptics () | |
| Default destructor. | |
| 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. | |
| 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. | |
| 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. | |
Private Member Functions | |
| Int_t | FirstMirrorReflection (const TVector3 &pos, const TVector3 &dir) override |
| It updates the values fFirstInteractionPosition and fMiddleDirection. Returns 0 if is not in region. | |
| void | Initialize () override |
| Initialization of TRestAxionMCPLOptics members. | |
| Int_t | SecondMirrorReflection (const TVector3 &pos, const TVector3 &dir) override |
| It updates the values fSecondInteractionPosition and fExitDirection. Returns 0 if is not in region. | |
Private Attributes | |
| std::string | fInputMCPLFilename |
| The file containing the input particle list. | |
| std::string | fOutputMCPLFilename |
| The file containing the output particle list. | |
Additional Inherited Members | |
| Protected Member Functions inherited from TRestAxionOptics | |
| Int_t | GetMirror () |
| It returns the mirror index to be used in the photon reflection. | |
| Int_t | TransportToEntrance (const TVector3 &pos, const TVector3 &dir) |
| It moves the incoming particle at the entrance of the optics plane and returns the region number where the particle is entering. More... | |
| Int_t | TransportToExit (const TVector3 &pos, const TVector3 &dir) |
| It moves the incoming particle to the exit of the optics plane and returns the region number where the particle is entering. More... | |
| Int_t | TransportToMiddle (const TVector3 &pos, const TVector3 &dir) |
| It moves the incoming particle to the middle of the optics plane and returns the region number where the particle is entering. More... | |
| TRestAxionOptics () | |
| Default constructor. | |
| TRestAxionOptics (const char *cfgFileName, std::string name="") | |
| Constructor loading data from a config file. More... | |
| 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. | |
| Protected Attributes inherited from TRestAxionOptics | |
| Int_t | fCurrentMirror = -1 |
| During the photon propagation it keeps track of the active mirror shell. | |
| TVector3 | fEntranceDirection |
| The particle position at the optics plane entrance. | |
| TRestCombinedMask * | fEntranceMask = nullptr |
| The entrance optical mask that defines a pattern with regions identified with a number. | |
| TVector3 | fEntrancePosition |
| The particle position at the optics plane entrance. | |
| TVector3 | fExitDirection |
| The particle position at the optics plane exit. | |
| TRestCombinedMask * | fExitMask = nullptr |
| The exit optical mask that defines a pattern with regions identified with a number. | |
| TVector3 | fExitPosition |
| The particle position at the optics plane exit. | |
| Bool_t | fFirstInteraction = false |
| During the photon propagation it tells us if the photon interacted in the first mirror. | |
| TVector3 | fFirstInteractionPosition |
| The particle position at the front mirror interaction point. | |
| Double_t | fFocal = -1 |
| The calculated focal in mm. It is updated by the method TRestAxionOptics::FindFocal. | |
| TVector3 | fMiddleDirection |
| The particle position at the optics plane middle. | |
| TRestCombinedMask * | fMiddleMask = nullptr |
| The middle optical mask that defines a pattern with regions identified with a number. | |
| TVector3 | fMiddlePosition |
| The particle position at the optics plane middle. | |
| Double_t | fMirrorLength = 0 |
| The mirror length. If all mirrors got the same length. Otherwise will be zero. | |
| TRestAxionOpticsMirror * | fMirrorProperties = nullptr |
| The mirror properties. | |
| std::vector< std::vector< Double_t > > | fOpticsData |
| The optics data table extracted from fOpticsFile. | |
| std::string | fOpticsFile = "" |
| An optics file that contains all the specific optics parameters. | |
| TVector3 | fOriginPosition |
| The particle position at the origin. | |
| TPad * | fPad = nullptr |
| A pad pointer to be used by the drawing methods. | |
| TRandom3 * | fRandom = nullptr |
| Random number generator. | |
| Bool_t | fSecondInteraction = false |
| During the photon propagation it tells us if the photon interacted in the second mirror. | |
| TVector3 | fSecondInteractionPosition |
| The particle position at the back mirror interaction point. | |
| 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. | |
| TRestAxionMCPLOptics::TRestAxionMCPLOptics | ( | const char * | cfgFileName, |
| std::string | name = "" |
||
| ) |
Constructor loading data from a config file.
If no configuration path is defined using TRestMetadata::SetConfigFilePath the path to the config file must be specified using full path, absolute or relative.
The default behaviour is that the config file must be specified with full path, absolute or relative.
| cfgFileName | A const char* giving the path to an RML file. |
| name | The name of the specific metadata. It will be used to find the corresponding TRestAxionMagneticField section inside the RML. |
Definition at line 93 of file TRestAxionMCPLOptics.cxx.
1.9.1