Documentation / Manuel développeur
Modules disponibles
Calibration, DataServer, Launcher, MetaModelOptim, Modeler, Optimizer, ReLauncher, Reliability, ReOptimizer, Sampler, Sensitivity, UncertModeler, XmlProblem, |
Uranie / Sampler
v4.10.0
|
Description of a generation of sample by space filling (FAST). More...
#include <TSpaceFilling.h>
Public Types | |
| enum | EFunction { kCukier, kSaltelliA, kSaltelliB } |
Public Member Functions | |
Constructor and Destructor | |
| TSpaceFilling (URANIE::DataServer::TDataServer *tds, Option_t *option, Int_t nCalcul, EFunction=TSpaceFilling::kSaltelliA) | |
| Constructor from a TDataServer, the name of the method and the size of the sample. More... | |
| virtual | ~TSpaceFilling () |
| Default destructor. More... | |
Setting and Getting global informations | |
| void | setSize (Int_t n) |
| Sets the size of the matrice. More... | |
| void | setPermutation (Bool_t bpermute) |
| Set the permutation attribute. More... | |
| Bool_t | getPermutation () |
| Get the permutation attribute. More... | |
Methods for the frequencies | |
The Fast method needs a vector a frequencies for each uncertainty attributes | |
| void | setDefaultFrequencies () |
| Sets the default frequencies by an algorithm. More... | |
| void | setFrequencies (Int_t nfreq, Int_t *valfreq) |
| Sets the frequencies by an array. More... | |
| Int_t | getFrequency (Int_t i) |
| Returns the frequency. More... | |
Methods for the fransformation | |
The Fast method needs also a function to transform data in [0,1] | |
| void | setTransformFunction (EFunction ntype) |
| Sets the Transform fonction. More... | |
| EFunction | getTransformFunction () |
| Gets the transform function. More... | |
Generation of the sample | |
| virtual void | generateSample (Option_t *option="") |
| Generates the sample. More... | |
Printing Log | |
| virtual void | printLog (Option_t *option="") |
| Prints the log. More... | |
 Public Member Functions inherited from URANIE::Sampler::TSamplerDeterminist | |
| TSamplerDeterminist (URANIE::DataServer::TDataServer *tds, Option_t *option, Int_t ns) | |
| Constructor with a dataserver. More... | |
| virtual | ~TSamplerDeterminist () |
| Default destructor. More... | |
| Public Member Functions inherited from URANIE::Sampler::TSampler | |
| TSampler (URANIE::DataServer::TDataServer *tds, Option_t *option, Int_t nCalcul) | |
| Constructor with a TDataServer, the options and the size of the sample. More... | |
| virtual | ~TSampler () |
| Default destructor. More... | |
| Int_t | GetID () |
| Returns the ID of the class. More... | |
| void | setMethodName (TString str) |
| Sets the method name in a global variable. More... | |
| TString | getMethodName () |
| Gets the method name. More... | |
| virtual URANIE::DataServer::TDataServer * | getTDS () |
| Return the TDS filling by the sampling algorithm. More... | |
| void | parseOption (Option_t *option) |
| Parse the option. More... | |
| virtual void | createListOfAttributes () |
| Creates the List of attributes to simulate. More... | |
| virtual void | createTuple () |
| Creates the TDSNtupleD of data with only the TStochasticAttributes. More... | |
| URANIE::DataServer::TDSNtupleD * | getTuple () |
| Returns the TDSNtupleD of data. More... | |
| virtual void | fillOtherAttributes () |
| Fills the TDSNtupleD of data with other TFormulaAttributes. More... | |
| void | setLog () |
| void | unsetLog () |
| void | changeLog () |
| Bool_t | getLog () |
Private Attributes | |
| Int_t * | _nValFreq |
| EFunction | _nFunction |
| The function G. More... | |
| Bool_t | _bPermutation |
| the boolean to permute each attribute (default = kFALSE) More... | |
Additional Inherited Members | |
| Public Attributes inherited from URANIE::Sampler::TSampler | |
| Int_t | _nS |
| The size of the sample. More... | |
| Int_t | _nX |
| The size of attributes to sample. More... | |
| URANIE::DataServer::TDSNtupleD * | _ntsample |
| the tntuple of data More... | |
| TString | _sMethod |
| The title of the sampler method. More... | |
| Bool_t | _blog |
| Log Printing. More... | |
| Bool_t | _bupdateFile |
| Update the back up file when generating the attributeformula if there is some. More... | |
| URANIE::DataServer::TDataServer * | _tds |
| Pointer to a TDS. More... | |
| TList * | _lstOfAttributesToSample |
| The list of Stochastic Attributes to sample. More... | |
Detailed Description
Description of a generation of sample by space filling (FAST).
Method of sampling
Two methods are implemented
- Cukier (1973) algorithm
\[ x_{i} = \bar{x_{i}} \exp^{\bar{\gamma_i} \sin{(\omega_i s)}}\]
For normalisation, we take \( \bar{x_{i}} = \exp^{-\bar{\gamma_i}}\) with \( \gamma_i = 1\) . - Saltelli A (1999)
\[ x_{i} = \frac{1}{2} + \frac{1}{\pi} \arcsin{(\sin{(\omega_i s)})}\]
- Saltelli B (1999)
\[ x_{i} = \frac{1}{2} + \frac{1}{\pi} \arcsin{[\sin{(\omega_i s + \varphi_i)}]}\]
where \( \varphi_i \in [0,2\pi)\) randomly.
Use case
First of all, a pointer to a TDataServer is constructed
Then, a pointer to an object TSpaceFilling is constructed using the TDataServer, of the adopted sequence ("cukier"|"Saltelli A"|"Saltelli B"), and the method generateSample() is applied
Member Enumeration Documentation
◆ EFunction
Constructor & Destructor Documentation
◆ TSpaceFilling()
| URANIE::Sampler::TSpaceFilling::TSpaceFilling | ( | URANIE::DataServer::TDataServer * | tds, |
| Option_t * | option, | ||
| Int_t | nCalcul, | ||
| EFunction | = TSpaceFilling::kSaltelliA |
||
| ) |
Constructor from a TDataServer, the name of the method and the size of the sample.
Referenced by ClassImp().
◆ ~TSpaceFilling()
|
virtual |
Default destructor.
Referenced by ClassImp().
Member Function Documentation
◆ generateSample()
|
virtual |
Generates the sample.
- Todo:
- FGA 2011-12-15 10:10:20 Pass the seed in the option "seed=123456" for the kSaltelliB Transformation
Implements URANIE::Sampler::TSampler.
Referenced by ClassImp().
◆ getFrequency()
|
inline |
Returns the frequency.
References _nValFreq.
◆ getPermutation()
|
inline |
Get the permutation attribute.
References _bPermutation.
◆ getTransformFunction()
|
inline |
Gets the transform function.
References _nFunction.
◆ printLog()
|
virtual |
◆ setDefaultFrequencies()
| void URANIE::Sampler::TSpaceFilling::setDefaultFrequencies | ( | ) |
Sets the default frequencies by an algorithm.
Referenced by ClassImp().
◆ setFrequencies()
| void URANIE::Sampler::TSpaceFilling::setFrequencies | ( | Int_t | nfreq, |
| Int_t * | valfreq | ||
| ) |
Sets the frequencies by an array.
Referenced by ClassImp().
◆ setPermutation()
|
inline |
Set the permutation attribute.
References _bPermutation.
◆ setSize()
|
inline |
Sets the size of the matrice.
◆ setTransformFunction()
|
inline |
Sets the Transform fonction.
Member Data Documentation
◆ _bPermutation
|
private |
the boolean to permute each attribute (default = kFALSE)
Referenced by ClassImp(), getPermutation(), and setPermutation().
◆ _nFunction
|
private |
The function G.
Referenced by ClassImp(), and getTransformFunction().
◆ _nValFreq
|
private |
Referenced by ClassImp(), and getFrequency().