English Français

Documentation / Developer's manual

Available modules

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

Description of the class TMinimisation. More...

#include <TMinimisation.h>

Inheritance diagram for URANIE::Calibration::TMinimisation:
Collaboration diagram for URANIE::Calibration::TMinimisation:

Public Member Functions

Constructor and Destructor
 TMinimisation (URANIE::DataServer::TDataServer *tds, URANIE::Relauncher::TRun *run, int nS=1, Option_t *option="")
 
 TMinimisation (URANIE::DataServer::TDataServer *tds, void(*fcn)(Double_t *, Double_t *), const char *varexpinput, const char *varexpoutput, int ns=1, Option_t *option="")
 Default Calibration constructor with the function argument: it contains the assessor to be used.
 
 TMinimisation (URANIE::DataServer::TDataServer *tds, const char *fcn, const char *varexpinput, const char *varexpoutput, int ns=1, Option_t *option="")
 Default Calibration constructor with the function argument: it contains the assessor to be used.
 
 TMinimisation (URANIE::DataServer::TDataServer *tds, URANIE::Launcher::TCode *fcode, int ns=1, Option_t *option="")
 Default Calibration constructor with the code argument: it contains the assessor to be used.
 
 ~TMinimisation ()
 Default destructor.
 
Setting and Getting attributs
URANIE::Reoptimizer::TOptimShare * getOptimMaster ()
 
Parse the option
virtual void parseOption (Option_t *option="")
 Read the possible options.
 
void computeParameters (Option_t *option="")
 Estimates the index from a Specific TDataServer.
 
void checktdsParContent ()
 
void printLog (Option_t *option="")
 
- Public Member Functions inherited from URANIE::Calibration::TCalibration
 TCalibration (URANIE::DataServer::TDataServer *tds, URANIE::Relauncher::TRun *run, int ns=1, Option_t *option="")
 Default constructor with the runner argument: it contains the assessor to be used.
 
 TCalibration (URANIE::DataServer::TDataServer *tds, void(*fcn)(Double_t *, Double_t *), const char *varexpinput, const char *varexpoutput, int ns=1, Option_t *option="")
 Default Calibration constructor with the function argument: it contains the assessor to be used.
 
 TCalibration (URANIE::DataServer::TDataServer *tds, const char *fcn, const char *varexpinput, const char *varexpoutput, int ns=1, Option_t *option="")
 Default Calibration constructor with the function argument: it contains the assessor to be used.
 
 TCalibration (URANIE::DataServer::TDataServer *tds, URANIE::Launcher::TCode *fcode, int ns=1, const char *option="")
 Default Calibration constructor with the code argument: it contains the assessor to be used.
 
virtual ~TCalibration ()
 Default destructor.
 
virtual void setDistanceAndReference (const char *funcName, URANIE::DataServer::TDataServer *tdsRef, const char *input, const char *reference, const char *weight="")
 Set the distance function and some needed informations.
 
virtual void setDistanceAndReference (URANIE::Calibration::TDistanceFunction *distFunc, URANIE::DataServer::TDataServer *tdsRef, const char *input, const char *reference, const char *weight="")
 Set the distance function and some needed informations.
 
void estimateParameters (Option_t *option="")
 
void estimateCustomResidues (string resName, int n_theta, double *theta)
 
void checkReference (URANIE::DataServer::TDataServer *tdsRef, const char *input, const char *output, const char *weight)
 Check the consistency of the formation provided.
 
virtual void drawParameters (TString sTitre, const char *variable="*", const char *select="1>0", Option_t *option="")
 
void drawResidues (TString sTitre, const char *variable="*", const char *select="1>0", Option_t *option="")
 
void setLog ()
 
void unsetLog ()
 
void changeLog ()
 
Bool_t getLog ()
 
Int_t getID ()
 
void setSeed (UInt_t nval)
 Set the seed of the random generator if one is used.
 
UInt_t getSeed ()
 Get the seed of the random generator if one is used.
 
const char * getMethodName ()
 Get the method name.
 
void setObservationCovarianceMatrix (TMatrixD &mat)
 Set the observatiton covariance matrix.
 
URANIE::Calibration::TDistanceFunctiongetDistanceFunction ()
 Return the distance function.
 
Int_t getNPar ()
 Get the number of parameters to be calibrated.
 
URANIE::DataServer::TDataServer * getEvaluationTDS ()
 Get the tds in which evaluation will be performed.
 

Public Attributes

Public attributes
URANIE::Relauncher::TRun * _optimRun
 Optimisation runner.
 
URANIE::Reoptimizer::TOptimShare * _optimMaster
 Optimisation runner.
 
- Public Attributes inherited from URANIE::Calibration::TCalibration
URANIE::DataServer::TDataServer * _tdsPar
 TDS containing parameters properties (parameters that should be calibrated)
 
URANIE::DataServer::TDataServer * _tdsObs
 TDS containing observations used for calibration.
 
URANIE::DataServer::TDataServer * _tdsEval
 TDS containing a priori / a posteriori evaluations.
 
ELauncher _nLauncher
 The type of launcher.
 
TString _sFunctionName
 The Name of the evaluatuor.
 
TString _sEI
 The Name of input.
 
TString _sEO
 The Name of output.
 
URANIE::Launcher::TCode * _code
 The tcode.
 
URANIE::Relauncher::TRun * _run
 Pointer to the runner to be used.
 
void(* _pFunction )(double *, double *)
 Function pointer.
 
vector< URANIE::DataServer::TStochasticAttribute * > _vatt
 internal vector of stochastic attribute for some methods
 

Additional Inherited Members

- Public Types inherited from URANIE::Calibration::TCalibration
enum  ELauncher { kCode , kFunction , kRun , kUnknown }
 
- Protected Member Functions inherited from URANIE::Calibration::TCalibration
void checkCanvasCreation (bool newcan)
 Create a canvas if needed.
 
void initInputs ()
 Initialise some common inputs.
 
void initResults (vector< string > *ParsedLines)
 Initialise some common inputs.
 
void computeAPosterioriForDistribution ()
 Compute the a posteriori residual for many-solutions method.
 
void setMethodName (const char *str)
 Set the Method name.
 
- Protected Attributes inherited from URANIE::Calibration::TCalibration
URANIE::Calibration::TDistanceFunction_dFunc
 Pointer to chosen distance function.
 
URANIE::DataServer::TDSNtupleD * _evTuple
 Pointer to the eval ntuple.
 
TList * _listOfParameters
 List of the parameters to be calibrated.
 
TCanvas * _canvas
 Canvas object to deal with.
 
TObjArray * _drawingGarbageCollector
 Garbage collector for prints.
 
int _nSam
 The number of sample in a posteriori distributions.
 
int _nObs
 The number of observations in the reference database.
 
int _nIterMax
 The maximum number of iteration allowed (meaning total number of code estimation is _nIterMax * _nObs)
 
int _nPar
 Dimension of the parameters.
 
int _nVar
 Dimension of the output and references to be compared with.
 
int _nSeed
 The seed of the random generator.
 
TString _sMethodName
 The method name.
 
TString _referenceName
 The reference name.
 
TString _outputName
 The output name.
 
vector< string > _vrefName
 The reference names.
 
vector< string > _voutName
 The output names.
 
TString _weightName
 The weight name.
 
TMatrixD _mObsCovMat
 Observation Covariance matrix.
 
bool _buseMatrix
 Use matrix instead of vectors in the Distance Function.
 
bool _bsaveAll
 Whether all evaluations should be saved, not only a priori and a posteriori.
 
bool _bdontKeepAgreement
 Remove the agreement attribute from the tdsPar object.
 
bool _buseMode
 Use Mode instead of Mean.
 
Bool_t _blog
 Boolean for edit the log.
 

Detailed Description

Description of the class TMinimisation.

Constructor & Destructor Documentation

◆ TMinimisation() [1/4]

URANIE::Calibration::TMinimisation::TMinimisation ( URANIE::DataServer::TDataServer *  tds,
URANIE::Relauncher::TRun *  run,
int  nS = 1,
Option_t *  option = "" 
)

Constructor usual where nS is set to be the number of sample produced by the algorithm.

Parameters
tdsthe pointer of the TDataServer. It must contains attribuutes that inherit from TStochasticAttribute
runthe runner that would be used to produce evaluations
nSuseless with this respect

Referenced by ClassImp().

◆ TMinimisation() [2/4]

URANIE::Calibration::TMinimisation::TMinimisation ( URANIE::DataServer::TDataServer *  tds,
void(*)(Double_t *, Double_t *)  fcn,
const char *  varexpinput,
const char *  varexpoutput,
int  ns = 1,
Option_t *  option = "" 
)

Default Calibration constructor with the function argument: it contains the assessor to be used.

Parameters
tds: the dataserver that contains no data but only one attribute per parameter to be calibrated
fcn: the pointer to a function
ns: number of sample to be generated (depending on the method)
varexpinput: the input variable for the function in the correct order (both input and parameters)
varexpoutput: the output of the function in the correct order

◆ TMinimisation() [3/4]

URANIE::Calibration::TMinimisation::TMinimisation ( URANIE::DataServer::TDataServer *  tds,
const char *  fcn,
const char *  varexpinput,
const char *  varexpoutput,
int  ns = 1,
Option_t *  option = "" 
)

Default Calibration constructor with the function argument: it contains the assessor to be used.

Parameters
tds: the dataserver that contains no data but only one attribute per parameter to be calibrated
fcn: the name of the function
ns: number of sample to be generated (depending on the method)
varexpinput: the input variable for the function in the correct order (both input and parameters)
varexpoutput: the output of the function in the correct order

◆ TMinimisation() [4/4]

URANIE::Calibration::TMinimisation::TMinimisation ( URANIE::DataServer::TDataServer *  tds,
URANIE::Launcher::TCode *  fcode,
int  ns = 1,
Option_t *  option = "" 
)

Default Calibration constructor with the code argument: it contains the assessor to be used.

Parameters
tds: the dataserver that contains no data but only one attribute per parameter to be calibrated
code: the code object that will be runned
ns: number of sample to be generated (depending on the method)

◆ ~TMinimisation()

URANIE::Calibration::TMinimisation::~TMinimisation ( )

Default destructor.

Referenced by ClassImp().

Member Function Documentation

◆ checktdsParContent()

void URANIE::Calibration::TMinimisation::checktdsParContent ( )
inlinevirtual

Check the content of the input dataserver

Implements URANIE::Calibration::TCalibration.

◆ computeParameters()

void URANIE::Calibration::TMinimisation::computeParameters ( Option_t *  option = "")
virtual

Estimates the index from a Specific TDataServer.

Implements URANIE::Calibration::TCalibration.

Referenced by ClassImp().

◆ getOptimMaster()

URANIE::Reoptimizer::TOptimShare * URANIE::Calibration::TMinimisation::getOptimMaster ( )
inline

References _optimMaster.

◆ parseOption()

virtual void URANIE::Calibration::TMinimisation::parseOption ( Option_t *  option = "")
virtual

Read the possible options.

Reimplemented from URANIE::Calibration::TCalibration.

Referenced by ClassImp().

◆ printLog()

void URANIE::Calibration::TMinimisation::printLog ( Option_t *  option = "")
virtual

Reimplemented from URANIE::Calibration::TCalibration.

Referenced by ClassImp().

Member Data Documentation

◆ _optimMaster

URANIE::Reoptimizer::TOptimShare* URANIE::Calibration::TMinimisation::_optimMaster

Optimisation runner.

Referenced by ClassImp(), and getOptimMaster().

◆ _optimRun

URANIE::Relauncher::TRun* URANIE::Calibration::TMinimisation::_optimRun

Optimisation runner.

Referenced by ClassImp().