URANIE::Sampler::TEllipticalCopula Class Reference

Description of the class TEllipticalCopula. More...

#include <TEllipticalCopula.h>

Inheritance diagram for URANIE::Sampler::TEllipticalCopula:

Collaboration diagram for URANIE::Sampler::TEllipticalCopula:

Public Member Functions
Constructor and Destructor
	TEllipticalCopula (URANIE::DataServer::TDataServer *tds, Option_t *option, Int_t nCalcul)
	Default constructor.
virtual	~TEllipticalCopula ()
	Default destructor.
Correlation matrix
Methods to specify correlation between attributes
void	setUserCorrelation (Int_t indx, Int_t indy, double value)
	Defines a correlation between two attributes given by their indexes.
void	setUserCorrelation (TString xname, TString yname, double value)
	Defines a correlation between two attributes given by their names.
void	setUserCorrelation (URANIE::DataServer::TAttribute *x, URANIE::DataServer::TAttribute *y, Double_t value)
	Defines a correlation between two attributes.
TMatrixD	getCorrelationMatrix ()
	Retrieve the correlation matrix.
Printing Log
virtual void	printLog (Option_t *option="")
	Prints the log.
Public Member Functions inherited from URANIE::Sampler::TCopula
	TCopula (URANIE::DataServer::TDataServer *tds, Option_t *option, Int_t nCalcul)
	Constructor with a TDataServer, the options and the size of the sample.
virtual	~TCopula ()
	Default destructor.
void	generateSample (Option_t *option="")
	Generates the sample.
virtual void	generateUMatrix (Option_t *option)=0
	Generates the matrix of U.
Public Member Functions inherited from URANIE::Sampler::TSamplerStochastic
	TSamplerStochastic (URANIE::DataServer::TDataServer *tds, Option_t *option, Int_t nCalcul)
	Constructor with a dataserver.
virtual	~TSamplerStochastic ()
	Default destructor.
void	setSeed (Int_t ind=0)
	Init the seed.
Int_t	getSeed ()
	Returns the seed value.
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.
virtual	~TSampler ()
	Default destructor.
Int_t	GetID ()
	Returns the ID of the class.
void	setMethodName (TString str)
	Sets the method name in a global variable.
TString	getMethodName ()
	Gets the method name.
virtual URANIE::DataServer::TDataServer *	getTDS ()
	Return the TDS filling by the sampling algorithm.
void	parseOption (Option_t *option)
	Parse the option.
virtual void	createListOfAttributes ()
	Creates the List of attributes to simulate.
virtual void	createTuple ()
	Creates the TDSNtupleD of data with only the TStochasticAttributes.
URANIE::DataServer::TDSNtupleD *	getTuple ()
	Returns the TDSNtupleD of data.
virtual void	fillOtherAttributes ()
	Fills the TDSNtupleD of data with other TFormulaAttributes.
void	setLog ()
void	unsetLog ()
void	changeLog ()
Bool_t	getLog ()

Public Attributes
TMatrixD	_matCorrelation
	The correlation matrix.
Public Attributes inherited from URANIE::Sampler::TCopula
TMatrixD	_matUValue
	The matrix of U values
Public Attributes inherited from URANIE::Sampler::TSampler
Int_t	_nS
	The size of the sample.
Int_t	_nX
	The size of attributes to sample.
URANIE::DataServer::TDSNtupleD *	_ntsample
	the tntuple of data
TString	_sMethod
	The title of the sampler method.
Bool_t	_blog
	Log Printing.
Bool_t	_bupdateFile
	Update the back up file when generating the attributeformula if there is some.
URANIE::DataServer::TDataServer *	_tds
	Pointer to a TDS.
TList *	_lstOfAttributesToSample
	The list of Stochastic Attributes to sample.

Additional Inherited Members
Protected Member Functions inherited from URANIE::Sampler::TSamplerStochastic
virtual void	init ()
	The preprocessing step.
virtual void	terminate ()
	The post-processing step.
Protected Attributes inherited from URANIE::Sampler::TSamplerStochastic
Int_t	_nSeed

Detailed Description

Description of the class TEllipticalCopula.

this familly of copula contains Gaussian and Student copulae.

Constructor & Destructor Documentation

TEllipticalCopula()

URANIE::Sampler::TEllipticalCopula::TEllipticalCopula	(	URANIE::DataServer::TDataServer *	tds,
		Option_t *	option,
		Int_t	nCalcul
	)

Default constructor.

Referenced by ClassImp().

~TEllipticalCopula()

virtual URANIE::Sampler::TEllipticalCopula::~TEllipticalCopula ( )

virtual

Default destructor.

Referenced by ClassImp().

Member Function Documentation

getCorrelationMatrix()

TMatrixD URANIE::Sampler::TEllipticalCopula::getCorrelationMatrix ( )

inline

Retrieve the correlation matrix.

References _matCorrelation.

printLog()

virtual void URANIE::Sampler::TEllipticalCopula::printLog ( Option_t *  option = "" )

virtual

Prints the log.

Reimplemented from URANIE::Sampler::TCopula.

Reimplemented in URANIE::Sampler::TGaussianCopula.

Referenced by ClassImp().

setUserCorrelation() [1/3]

void URANIE::Sampler::TEllipticalCopula::setUserCorrelation	(	Int_t	indx,
		Int_t	indy,
		double	value
	)

Defines a correlation between two attributes given by their indexes.

Warning

The indexes begin 0 to n-1.

Parameters

indx	(Int_t) the index of the first attribute
indy	(Int_t) the index of the second attribute
value	(Double_t) the correlation factor between the two attributes

Referenced by ClassImp().

setUserCorrelation() [2/3]

void URANIE::Sampler::TEllipticalCopula::setUserCorrelation	(	TString	xname,
		TString	yname,
		double	value
	)

Defines a correlation between two attributes given by their names.

Parameters

xname	(TString) the first attribute
yname	(TString) the second attribute
value	(Double_t) the correlation factor between x and y

setUserCorrelation() [3/3]

void URANIE::Sampler::TEllipticalCopula::setUserCorrelation	(	URANIE::DataServer::TAttribute *	x,
		URANIE::DataServer::TAttribute *	y,
		Double_t	value
	)

Defines a correlation between two attributes.

The correlation factor is define as the

Parameters

x	(URANIE::DataServer::TAttribute *) the first attribute
y	(URANIE::DataServer::TAttribute *) the second attribute
value	(Double_t) the correlation factor between x and y

Member Data Documentation

_matCorrelation

TMatrixD URANIE::Sampler::TEllipticalCopula::_matCorrelation

The correlation matrix.

Referenced by ClassImp(), ClassImp(), and getCorrelationMatrix().