English Français

Documentation / Developer's manual

Available modules

Calibration,  DataServer,  Launcher,  MetaModelOptim,  Modeler,  Optimizer,  ReLauncher,  Reliability,  ReOptimizer,  Sampler,  Sensitivity,  UncertModeler,  XmlProblem,   Uranie / Sensitivity: URANIE::Sensitivity::TFast Class Reference
Uranie / Sensitivity v4.9.0
/* @license-end */
URANIE::Sensitivity::TFast Class Reference

Description of the class TFast. More...

#include <TFast.h>

Inheritance diagram for URANIE::Sensitivity::TFast:
Collaboration diagram for URANIE::Sensitivity::TFast:

Public Types

enum  EFunction { kCukier , kSaltelliA , kSaltelliB }
 
- Public Types inherited from URANIE::Sensitivity::TSensitivity
enum  ELauncher {
  kCode , kCodeRemote , kFunction , kRun ,
  kUnknown
}
 

Public Member Functions

Constructor and Destructor
 TFast ()
 Default constructor.
 
 TFast (URANIE::DataServer::TDataServer *tds, void(*fcn)(Double_t *, Double_t *), const char *varexpinput, const char *varexpoutput, Int_t ns=100)
 Default constructor with a function.
 
 TFast (URANIE::DataServer::TDataServer *tds, const char *fcn, Int_t ns=100, const char *varexpinput="", const char *varexpoutput="")
 Default constructor with a function name.
 
 TFast (URANIE::DataServer::TDataServer *tds, URANIE::Launcher::TCode *fcode, Int_t ns)
 Default constructor with a tcode.
 
 TFast (URANIE::DataServer::TDataServer *tds, URANIE::Relauncher::TRun *run, Int_t ns)
 Default constructor with a trun.
 
virtual ~TFast ()
 Default destructor.
 
Functions to the frequencies and the transformed

The Fast method is to choose a frequency to each uncertainty attribute and a transform function to "space filling"

void setFrequencies (Int_t nfreq, Int_t *valfreq)
 Sets the frequencies array.
 
void setTransformFunction (EFunction ntype)
 Sets the Transform fonction.
 
EFunction getTransformFunction ()
 Gets the transform function.
 
void setM (Int_t m)
 Sets the max number of harmonic.
 
Int_t getM ()
 Returns the max number of harmonic to consider.
 
Parse the option
virtual void parseOption (Option_t *option="")
 Read option specific to TSobol.
 
Generation of the sample
virtual void generateSample (Option_t *option="")
 
Computes the indexes
virtual void evaluateIndexes (Option_t *option="")
 Evaluates the index from the dataserver.
 
Printing Log
virtual void printLog (Option_t *option="")
 
- Public Member Functions inherited from URANIE::Sensitivity::TSensitivity
 TSensitivity ()
 Default constructor.
 
 TSensitivity (URANIE::DataServer::TDataServer *tds, const char *fcn, Int_t ns, const char *varexpinput="", const char *varexpoutput="", Option_t *option="")
 Default constructor with the name of a function.
 
 TSensitivity (URANIE::DataServer::TDataServer *tds, void(*fcn)(Double_t *, Double_t *), const char *varexpinput, const char *varexpoutput, Int_t ns, Option_t *option="")
 
 TSensitivity (URANIE::DataServer::TDataServer *tds, const char *varexpinput, const char *varexpoutput, Option_t *option="")
 Default constructor.
 
 TSensitivity (URANIE::DataServer::TDataServer *tds, URANIE::Launcher::TCode *code, Int_t ns, Option_t *option="")
 Default constructor with TCode arg.
 
 TSensitivity (URANIE::DataServer::TDataServer *tds, URANIE::Relauncher::TRun *run, Int_t ns, Option_t *option="")
 Default constructor with TRun arg.
 
virtual ~TSensitivity ()
 Default destructor.
 
Int_t getID ()
 
virtual TTree * getResultTuple (bool commonresulttuple=true)
 Get the result ntuple (default parameter unused but for Morris method)
 
double getValue (const char *sorder="", const char *sinputname="", const char *sselect="")
 
vector< int > * getAttributeElements (string str)
 
void setFunction (void(*fct)(Double_t *, Double_t *), Int_t nx=-1, Int_t ny=1)
 
TString getFunctionName ()
 
void setSeed (UInt_t nval)
 
UInt_t getSeed ()
 
virtual void setMethodName (const char *str)
 Set the Method name.
 
const char * getMethodName ()
 Get the method name.
 
Bool_t getNoIntermediateSaved ()
 Get the noIntermediateSaved flag.
 
const char * getIteratorName ()
 Get the name of the iterator attribut of the method.
 
void setSensitivityIteratorName (const char *str)
 Set the iterator name devoted to compute sensitivity indexes.
 
void setTimeName (TString sname)
 Set the name of the time attribute (only one)
 
TString getTimeName ()
 Get the name of the time attribute.
 
virtual void setDrawProgressBar (Bool_t bbool=kTRUE)
 Set the "draw progress bar" flag.
 
void setUsingErrors (bool thebool)
 Set the "using error results anyway" option.
 
Bool_t getDrawProgressBar ()
 Get the clean flag.
 
Bool_t isInputCorrelated ()
 
TMatrixD getMatrixInputCorrelation ()
 
Int_t getNInput ()
 Get the number of input attributes.
 
Int_t getNOutput ()
 Get the number of output attributes.
 
void setInputCorrelationMatrix (TMatrixD Corr)
 
void checkOutputRequested (string attlist, bool fromoption=false)
 Check the output list requested by the user.
 
void computeIndexes (Option_t *option="")
 Compute the Sensitivity Indexes.
 
void fillIndex (const char *sinputname, const char *sorder, Double_t dval, const char *algo="", Double_t dvalCILower=-1.0, Double_t dvalCIUpper=-1.0)
 Method to fill in the tree the value of Sensitivity indexes for an input attribute.
 
virtual void createTuple (Option_t *option="")
 
virtual void drawIndexes (TString sTitre, const char *select="", Option_t *option="")
 Draws the indexes.
 
virtual void setLog ()
 
void unsetLog ()
 
void changeLog ()
 
Bool_t getLog ()
 
void setNLauncher (ELauncher codeLauncher)
 

Public Attributes

Int_t * _nValFreq
 The array of frequences.
 
Int_t _nM
 The max harmonic to consider.
 
bool b_plotgraph
 Plot the graph.
 
- Public Attributes inherited from URANIE::Sensitivity::TSensitivity
URANIE::DataServer::TDataServer * _tds
 Pointeur vers un TDS.
 
TList * _listOfInputAttributes
 List of the input branches.
 
TList * _listOfOutputAttributes
 List of the input branches.
 
TString _sTimeAttribute
 The name of the Time attribute.
 
Int_t _nS
 The number of simulation or other information depend on the used method.
 
Int_t _nX
 Dimension of the input.
 
UInt_t _nY
 Dimension of the target.
 
UInt_t _nElY
 Number of element for one selected output.
 
Int_t _nbOut
 Total number of Output to be considered.
 
Int_t _iOut
 counter for output
 
unsigned int _iy
 iterator over number of element
 
unsigned int _iely
 iterator over number of element
 
ELauncher _nLauncher
 The type of launcher.
 
TString _sFunctionName
 The Name of the evaluatuor.
 
URANIE::Launcher::TCode * _code
 The tcode.
 
URANIE::Relauncher::TRun * _run
 
TObjArray * _drawingGarbageCollector
 Garbage collector for prints.
 
Int_t _nSeed
 The seed of the random generator.
 
Bool_t _bChosenOutputs
 Fact that the input list is provided or not.
 
Bool_t _blog
 Boolean for edit the log.
 
Bool_t _bdrawProgressBar
 Boolean to know if the progress bar has to be drawn.
 
Bool_t _bnoIntermediateSaved
 Boolean to know if the progress bar has to be drawn.
 
TString _sIteratorName
 The specific iterator attribute for the method.
 
TString _sMethodName
 The method name.
 
TString _sSelectedOutput
 The output.
 
TString _sSelectedInput
 The input.
 
map< string, unsigned int > _mAttributeSize
 Map of size of element for attribute;.
 
map< string, vector< int > > _mAttributeElements
 Map of Elements number to run (if vector subselection is requested)
 
vector< string > _vOutputNames
 Name of the output.
 
TCanvas * _canvas
 Canvas object to deal with.
 
void(* _pFunction )(double *, double *)
 
TTree * _ntresult
 The TTree of results.
 

Private Member Functions

void stdInit ()
 

Private Attributes

EFunction _nFunction
 The function G.
 

Additional Inherited Members

- Protected Member Functions inherited from URANIE::Sensitivity::TSensitivity
void checkCanvasCreation (bool newcan)
 Create a canvas if needed.
 
void drawIndexesHistogram (TString sTitre, const char *select="", Option_t *option="")
 Draws indexes with an histogram.
 
void drawIndexesPie (TString sTitre, const char *select="", Option_t *option="")
 Draws indexes with an pie chart.
 
virtual void preTreatment ()
 PreTreatment for every output.
 
virtual void postTreatment ()
 PostTreatment for every output.
 
void setNoIntermediateSaved (Bool_t bbool=kTRUE)
 Set the "only final file" flag.
 
- Protected Attributes inherited from URANIE::Sensitivity::TSensitivity
Char_t _sOutputAttribute [MAXLENGTHSTRING]
 The name of the output attribute.
 
Char_t _sInputAttribute [MAXLENGTHSTRING]
 The name of the input attribute.
 
Char_t _sOrder [MAXLENGTHSTRING]
 The order of sensitivity indexes.
 
Char_t _sMethod [MAXLENGTHSTRING]
 The name of the method.
 
Char_t _sAlgorithm [MAXLENGTHSTRING]
 The name of the algorithm to compute the index.
 
Double_t _valSobolCrt
 The value of sensitivity indexes.
 
Double_t _valSobolCILower
 The value of lower Condidence Interval (95)
 
Double_t _valSobolCIUpper
 The value of upper Condidence Interval (95)
 
TMatrixD _minputCorr
 Input correlation matrix if sample needs to be correlated.
 
Bool_t _bisInputCorrelated
 State whether the input correlation matrix is set.
 
Bool_t _bgoingThroughError
 State whether the error must not block the computation.
 

Detailed Description

Description of the class TFast.

To be written by the developper.

Member Enumeration Documentation

◆ EFunction

Enumerator
kCukier 
kSaltelliA 
kSaltelliB 

Constructor & Destructor Documentation

◆ TFast() [1/5]

URANIE::Sensitivity::TFast::TFast ( )

Default constructor.

Referenced by ClassImp().

◆ TFast() [2/5]

URANIE::Sensitivity::TFast::TFast ( URANIE::DataServer::TDataServer *  tds,
void(*)(Double_t *, Double_t *)  fcn,
const char *  varexpinput,
const char *  varexpoutput,
Int_t  ns = 100 
)

Default constructor with a function.

◆ TFast() [3/5]

URANIE::Sensitivity::TFast::TFast ( URANIE::DataServer::TDataServer *  tds,
const char *  fcn,
Int_t  ns = 100,
const char *  varexpinput = "",
const char *  varexpoutput = "" 
)

Default constructor with a function name.

◆ TFast() [4/5]

URANIE::Sensitivity::TFast::TFast ( URANIE::DataServer::TDataServer *  tds,
URANIE::Launcher::TCode *  fcode,
Int_t  ns 
)

Default constructor with a tcode.

◆ TFast() [5/5]

URANIE::Sensitivity::TFast::TFast ( URANIE::DataServer::TDataServer *  tds,
URANIE::Relauncher::TRun *  run,
Int_t  ns 
)

Default constructor with a trun.

◆ ~TFast()

virtual URANIE::Sensitivity::TFast::~TFast ( )
virtual

Default destructor.

Referenced by ClassImp().

Member Function Documentation

◆ evaluateIndexes()

virtual void URANIE::Sensitivity::TFast::evaluateIndexes ( Option_t *  option = "")
virtual

Evaluates the index from the dataserver.

Implements URANIE::Sensitivity::TSensitivity.

Reimplemented in URANIE::Sensitivity::TRBD.

Referenced by ClassImp().

◆ generateSample()

virtual void URANIE::Sensitivity::TFast::generateSample ( Option_t *  option = "")
virtual

Implements URANIE::Sensitivity::TSensitivity.

Reimplemented in URANIE::Sensitivity::TRBD.

Referenced by ClassImp(), and ClassImp().

◆ getM()

Int_t URANIE::Sensitivity::TFast::getM ( )
inline

Returns the max number of harmonic to consider.

References _nM.

◆ getTransformFunction()

EFunction URANIE::Sensitivity::TFast::getTransformFunction ( )
inline

Gets the transform function.

References _nFunction.

◆ parseOption()

virtual void URANIE::Sensitivity::TFast::parseOption ( Option_t *  option = "")
virtual

Read option specific to TSobol.

Possible options specific to this methods are

  • "graph": do the graph of the used frequencies

Reimplemented from URANIE::Sensitivity::TSensitivity.

Referenced by ClassImp().

◆ printLog()

virtual void URANIE::Sensitivity::TFast::printLog ( Option_t *  option = "")
virtual

Reimplemented from URANIE::Sensitivity::TSensitivity.

Reimplemented in URANIE::Sensitivity::TRBD.

Referenced by ClassImp(), and ClassImp().

◆ setFrequencies()

void URANIE::Sensitivity::TFast::setFrequencies ( Int_t  nfreq,
Int_t *  valfreq 
)

Sets the frequencies array.

Referenced by ClassImp().

◆ setM()

void URANIE::Sensitivity::TFast::setM ( Int_t  m)
inline

Sets the max number of harmonic.

References _nM.

◆ setTransformFunction()

void URANIE::Sensitivity::TFast::setTransformFunction ( EFunction  ntype)
inline

Sets the Transform fonction.

References _nFunction.

◆ stdInit()

void URANIE::Sensitivity::TFast::stdInit ( )
private

Referenced by ClassImp().

Member Data Documentation

◆ _nFunction

EFunction URANIE::Sensitivity::TFast::_nFunction
private

The function G.

Referenced by ClassImp(), getTransformFunction(), and setTransformFunction().

◆ _nM

Int_t URANIE::Sensitivity::TFast::_nM

The max harmonic to consider.

Referenced by ClassImp(), ClassImp(), getM(), and setM().

◆ _nValFreq

Int_t* URANIE::Sensitivity::TFast::_nValFreq

The array of frequences.

Referenced by ClassImp(), and ClassImp().

◆ b_plotgraph

bool URANIE::Sensitivity::TFast::b_plotgraph

Plot the graph.

Referenced by ClassImp(), and ClassImp().