 |
REST-for-Physics
v2.3
Rare Event Searches ToolKit for Physics
|
|
REST-for-Physics
v2.3
Rare Event Searches ToolKit for Physics
|
It combines a number of experimental conditions allowing to calculate a combined experimental sensitivity.
Documentation TOBE written
REST-for-Physics - Software for Rare Event Searches Toolkit
History of developments:
2022-December: First implementation of TRestSensitivity Javier Galan
Definition at line 29 of file TRestSensitivity.h.
#include <TRestSensitivity.h>
Public Member Functions | |
| void | AddCurve (const std::vector< Double_t > &curve) |
| ClassDefOverride (TRestSensitivity, 2) | |
| TCanvas * | DrawCurves () |
| TCanvas * | DrawLevelCurves () |
| void | ExportAveragedCurve (std::string fname, Double_t factor=1.e-10, Double_t power=0.25) |
| void | ExportCurve (std::string fname, Double_t factor=1.e-10, Double_t power=0.25, int n=0) |
| void | ExtractExperimentParameterizationNodes (Bool_t rescan=false) |
| It scans all the experiment signals parametric nodes to build a complete list of nodes used to build a complete sensitivity curve. Some experiments may be sensitivy to a particular node, while others may be sensitivy to another. If more than one experiment is sensitivy to a given node, the sensitivity will be combined later on. | |
| void | Freeze () |
| void | GenerateCurve () |
| void | GenerateCurves (Int_t N) |
| std::vector< Double_t > | GetAveragedCurve () |
| Double_t | GetCoupling (Double_t node, Double_t sigma=2, Double_t precision=0.01) |
| It will return the coupling value for which Chi=sigma. | |
| std::vector< Double_t > | GetCurve (size_t n=0) |
| TRestExperiment * | GetExperiment (const size_t &n) |
| std::vector< TRestExperiment * > | GetExperiments () |
| std::vector< std::vector< Double_t > > | GetLevelCurves (const std::vector< Double_t > &levels) |
| This method is used to obtain the list of curves that satisfy that each value inside the curve is placed at a specified level. E.g. if we provide a level 0.5, then the corresponding curve will be constructed with the central value extracted at each parameter point. More... | |
| size_t | GetNumberOfCurves () |
| size_t | GetNumberOfExperiments () |
| size_t | GetNumberOfNodes () |
| std::vector< Double_t > | GetParameterizationNodes () |
| void | ImportCurve (const std::vector< Double_t > &curve) |
| void | Initialize () override |
| It will initialize the data frame with the filelist and column names (or observables) that have been defined by the user. | |
| void | PrintMetadata () override |
| Prints on screen the information about the metadata members of TRestAxionSolarFlux. | |
| void | PrintParameterizationNodes () |
| TH1D * | SignalStatisticalTest (Double_t node, Int_t N) |
| TRestSensitivity () | |
| Default constructor. | |
| TRestSensitivity (const char *cfgFileName, const std::string &name="") | |
| Constructor loading data from a config file. More... | |
| ~TRestSensitivity () | |
| 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. | |
Protected Member Functions | |
| Double_t | ApproachByFactor (Double_t node, Double_t g4, Double_t chi0, Double_t target, Double_t factor) |
| It will return a value of the coupling, g4, such that (chi-chi0) gets closer to the target value given by argument. The factor will be used to increase or decrease the coupling, and evaluate the likelihood. More... | |
| void | InitFromConfigFile () override |
| It customizes the retrieval of XML data values of this class. | |
| Double_t | UnbinnedLogLikelihood (const TRestExperiment *experiment, Double_t node, Double_t g4=0) |
| It returns the Log(L) for the experiment and coupling given by argument. 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. | |
Private Attributes | |
| TCanvas * | fCanvas = nullptr |
| A canvas to draw. | |
| std::vector< std::vector< Double_t > > | fCurves |
| A vector of calculated sensitivity curves defined as a funtion of the parametric node. | |
| std::vector< TRestExperiment * > | fExperiments |
| A list of experimental conditions included to get a final sensitivity plot. | |
| Bool_t | fFrozen = false |
| A flag that will frozen adding more experiments in the future. | |
| std::vector< Double_t > | fParameterizationNodes |
| The fusioned list of parameterization nodes found at each experiment signal. | |
| TH1D * | fSignalTest = nullptr |
| It is used to generate a histogram with the signal distribution produced with different signal samples. | |
Additional Inherited Members | |
| 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. | |
| TRestSensitivity::TRestSensitivity | ( | const char * | cfgFileName, |
| const 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 70 of file TRestSensitivity.cxx.
|
protected |
It will return a value of the coupling, g4, such that (chi-chi0) gets closer to the target value given by argument. The factor will be used to increase or decrease the coupling, and evaluate the likelihood.
Coarse movement to get to Chi2 above target
Coarse movement to get to Chi2 below target (/2)
Definition at line 86 of file TRestSensitivity.cxx.
| std::vector< std::vector< Double_t > > TRestSensitivity::GetLevelCurves | ( | const std::vector< Double_t > & | levels | ) |
This method is used to obtain the list of curves that satisfy that each value inside the curve is placed at a specified level. E.g. if we provide a level 0.5, then the corresponding curve will be constructed with the central value extracted at each parameter point.
We may then construct the profile of the sensitivity curves at 98%, 95% and 68% C.L. as follows:
Definition at line 382 of file TRestSensitivity.cxx.
|
protected |
It returns the Log(L) for the experiment and coupling given by argument.
We check if the signal component is sensitive to that particular node If not, this experiment will not contribute to that node
We could check if background has also components, but for the moment we do not have a background for each node, although it could be the case, if for example the background depends on the detector conditions. For example, higher pressure inside the detector gains in signal sensitivity but it will produce also higher background.
Definition at line 257 of file TRestSensitivity.cxx.
1.9.1