URANIE::Sensitivity::TDGSM Class Reference

Description of the class TDGSM. More...

#include <TDGSM.h>

Inheritance diagram for URANIE::Sensitivity::TDGSM:

Collaboration diagram for URANIE::Sensitivity::TDGSM:

Public Member Functions
Constructor and Destructor
	TDGSM ()
	Default constructor.
	TDGSM (TDataServer *tdsNominal, void(*fcn)(Double_t *, Double_t *), Int_t ns, TString sensitiveAtt, TString outputAtt, TString samplingOption="steps=1%")
	Constructor with the TDataServer and function.
	TDGSM (TDataServer *tdsNominal, const char *fcn, Int_t ns, TString sensitiveAtt, TString outputAtt, TString samplingOption)
	Constructor with the TDataServer and function name.
	TDGSM (TDataServer *tdsNominal, URANIE::Launcher::TCode *fcode, Int_t ns, TString sensitiveAtt="", TString samplingOption="steps=1%")
	Constructor with the TDataServer and a TCode.
	TDGSM (TDataServer *tdsNominal, URANIE::Relauncher::TRun *run, Int_t ns, TString sensitiveAtt="", TString samplingOption="steps=1%")
	Constructor with the TDataServer and a TRun.
	TDGSM (TDataServer *tdsNominal, TString inputAtt, TString outputAtt, TString sensitiveAtt=TString(""))
	Constructor with a loaded data server.
virtual	~TDGSM ()
	Default destructor.
Setting and Getting attributs
virtual Double_t	getStepSizeParameter ()
	Get the step size parameter.
TMatrixD	getSensitivityMatrix ()
	Returns the sensitivity matrix.
TDataServer *	getDataServer ()
	Returns a pointer to the internal data server.
Generation of the sample
virtual void	generateSample (Option_t *option="")
	Generates the OAT sampling.
void	generateSampleByOATDesign (Option_t *option="")
void	initSample (Int_t ns, Option_t *option="")
	initSample
virtual void	parseOption (Option_t *option="")
	Read the possible options.
Compute the indexes
void	evaluateIndexes (Option_t *option="")
	Compute the sensitivity matrix.
Printing Log
virtual void	printLog ()
	printLog
Public Member Functions inherited from URANIE::Sensitivity::TFiniteDifferences
	TFiniteDifferences ()
	Default constructor.
	TFiniteDifferences (TDataServer *tdsNominal, void(*fcn)(Double_t *, Double_t *), TString sensitiveAtt, TString outputAtt, TString samplingOption="steps=1%")
	Constructor with the TDataServer and function.
	TFiniteDifferences (TDataServer *tdsNominal, const char *fcn, TString sensitiveAtt, TString outputAtt, TString samplingOption)
	Constructor with the TDataServer and function name.
	TFiniteDifferences (TDataServer *tdsNominal, URANIE::Launcher::TCode *fcode, TString sensitiveAtt="", TString samplingOption="steps=1%")
	Constructor with the TDataServer and code.
	TFiniteDifferences (TDataServer *tdsNominal, URANIE::Relauncher::TRun *run, TString sensitiveAtt="", TString samplingOption="steps=1%")
	Constructor with the TDataServer and TRun.
	TFiniteDifferences (TDataServer *tdsNominal, TString inputAtt, TString outputAtt, TString sensitiveAtt=TString(""))
	Constructor with a loaded data server.
virtual	~TFiniteDifferences ()
	Default destructor.
	TFiniteDifferences ()
	Default constructor.
	TFiniteDifferences (TDataServer *tdsNominal, void *fcn, TString sensitiveAtt, TString ranges, TString inputAtt, TString outputAtt)
	Constructor with the TDataServer and function.
	TFiniteDifferences (TDataServer *tdsNominal, URANIE::Launcher::TCode *fcode, TString sensitiveAtt, TString ranges)
	Constructor with the TDataServer and code.
	TFiniteDifferences (TDataServer *tdsNominal, TString sensitiveAtt, TString inputAtt, TString outputAtt)
	Constructor with a loaded data server.
virtual	~TFiniteDifferences ()
	Default destructor.
TMatrixD	getSensitivityMatrix ()
	Returns the sensitivity matrix.
TDataServer *	getDataServer ()
	Returns a pointer to the internal data server.
TMatrixD	getSensitivityMatrix ()
	Returns the sensitivity matrix.
TDataServer *	getOATDataServer ()
	Returns a pointer to the internal data server.
void	evaluateIndexes (Option_t *option="")
	Compute the sensitivity matrix.
void	preTreatment ()
	Resize the matrix results at the very beginning of the algo to the number of output/input.
void	computeIndexes (Option_t *option="")
	Compute the sensitivity matrix.
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 ()
virtual void	printLog (Option_t *option="")
void	setNLauncher (ELauncher codeLauncher)

Additional Inherited Members
Public Types inherited from URANIE::Sensitivity::TSensitivity
enum	ELauncher {   kCode , kCodeRemote , kFunction , kRun ,   kUnknown }
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.
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	postTreatment ()
	PostTreatment for every output.
void	setNoIntermediateSaved (Bool_t bbool=kTRUE)
	Set the "only final file" flag.
Protected Attributes inherited from URANIE::Sensitivity::TFiniteDifferences
TMatrixD	_sMatrix
	The sensitivity matrix.
TString	_sSensitiveAtt
	The list of sensitive attributes.
TString	_sSamplingOption
	the options for the OAT sampling
Int_t	_nbIn
	the number of sensitive inputs
Int_t	_nbAux
	the number of non sensitive inputs
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 TDGSM.

Constructor & Destructor Documentation

TDGSM() [1/6]

URANIE::Sensitivity::TDGSM::TDGSM

(

)

Default constructor.

Referenced by ClassImp().

TDGSM() [2/6]

URANIE::Sensitivity::TDGSM::TDGSM	(	TDataServer *	tdsNominal,
		void(*)(Double_t *, Double_t *)	fcn,
		Int_t	ns,
		TString	sensitiveAtt,
		TString	outputAtt,
		TString	samplingOption = "steps=1%"
	)

Constructor with the TDataServer and function.

Parameters

tdsNominal
sensitiveAtt
outputAtt
samplingOption

TDGSM() [3/6]

URANIE::Sensitivity::TDGSM::TDGSM	(	TDataServer *	tdsNominal,
		const char *	fcn,
		Int_t	ns,
		TString	sensitiveAtt,
		TString	outputAtt,
		TString	samplingOption
	)

Constructor with the TDataServer and function name.

Parameters

tdsNominal
fcn
sensitiveAtt
outputAtt
samplingOption

TDGSM() [4/6]

URANIE::Sensitivity::TDGSM::TDGSM	(	TDataServer *	tdsNominal,
		URANIE::Launcher::TCode *	fcode,
		Int_t	ns,
		TString	sensitiveAtt = "",
		TString	samplingOption = "steps=1%"
	)

Constructor with the TDataServer and a TCode.

Parameters

tdsNominal
fcode
sensitiveAtt
samplingOption

TDGSM() [5/6]

URANIE::Sensitivity::TDGSM::TDGSM	(	TDataServer *	tdsNominal,
		URANIE::Relauncher::TRun *	run,
		Int_t	ns,
		TString	sensitiveAtt = "",
		TString	samplingOption = "steps=1%"
	)

Constructor with the TDataServer and a TRun.

Parameters

tdsNominal
run
sensitiveAtt
samplingOption

TDGSM() [6/6]

URANIE::Sensitivity::TDGSM::TDGSM	(	TDataServer *	tdsNominal,
		TString	inputAtt,
		TString	outputAtt,
		TString	sensitiveAtt = TString("")
	)

Constructor with a loaded data server.

Parameters

tdsNominal
inputAtt
outputAtt
sensitiveAtt

~TDGSM()

virtual URANIE::Sensitivity::TDGSM::~TDGSM ( )

virtual

Default destructor.

Referenced by ClassImp().

Member Function Documentation

evaluateIndexes()

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

virtual

Compute the sensitivity matrix.

Parameters

option

Implements URANIE::Sensitivity::TSensitivity.

Referenced by ClassImp().

generateSample()

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

inlinevirtual

Generates the OAT sampling.

This function fills a TDS with appropriate variables, creates and uses a TOATSampling to generate the design of experiment.

Parameters

option

(Option_t *) just in case we need option in the future... (Default = "").

Reimplemented from URANIE::Sensitivity::TFiniteDifferences.

References generateSampleByOATDesign().

generateSampleByOATDesign()

void URANIE::Sensitivity::TDGSM::generateSampleByOATDesign

(

Option_t *

option = ""

)

Referenced by ClassImp(), and generateSample().

getDataServer()

TDataServer * URANIE::Sensitivity::TDGSM::getDataServer ( )

inline

Returns a pointer to the internal data server.

Returns

References URANIE::Sensitivity::TSensitivity::_tds.

getSensitivityMatrix()

TMatrixD URANIE::Sensitivity::TDGSM::getSensitivityMatrix

(

)

Returns the sensitivity matrix.

Returns

Referenced by ClassImp().

getStepSizeParameter()

virtual Double_t URANIE::Sensitivity::TDGSM::getStepSizeParameter ( )

inlinevirtual

Get the step size parameter.

initSample()

void URANIE::Sensitivity::TDGSM::initSample	(	Int_t	ns,
		Option_t *	option = ""
	)

initSample

Parameters

ns	(Int_t) size of the sample to generate
option	(Option_t) Possible options to generate the initial sample "srs": generate sample with SRS "lhs": generate sample with LHS "qmc=sobol": generate sample with QMC=SOBOL "qmc=halton": generate sample with QMC=HALTON

Referenced by ClassImp().

parseOption()

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

virtual

Read the possible options.

Reimplemented from URANIE::Sensitivity::TSensitivity.

Referenced by ClassImp().

printLog()

virtual void URANIE::Sensitivity::TDGSM::printLog ( )

virtual

printLog

Reimplemented from URANIE::Sensitivity::TFiniteDifferences.

Referenced by ClassImp().