ImportedDesignOfExperiment

class persalys.ImportedDesignOfExperiment(*args)

Create a design of experiments, using an imported design.

Available constructors:

ImportedDesignOfExperiment(name, physicalModel, fileName, columns)

Parameters

namestr

Name

physicalModelPhysicalModel

Physical model

fileNamestr

Name of a data file to load

columnssequence of int

Indices of columns in files to consider

Examples

>>> import openturns as ot
>>> import persalys
>>> ot.RandomGenerator.SetSeed(0)

Create the model:

>>> X0 = persalys.Input('X0')
>>> X1 = persalys.Input('X1')
>>> Y0 = persalys.Output('Y0')
>>> model = persalys.SymbolicPhysicalModel('aModelPhys', [X0, X1], [Y0], ['sin(X0)+8*X1'])

Create the design of experiments:

>>> filename = 'normal.csv'
>>> ot.Normal(3).getSample(10).exportToCSVFile(filename)
>>> aDesign = persalys.ImportedDesignOfExperiment('aDesign', model, filename, [0, 2])

Methods

getBlockSize()	Block size accessor.
getClassName()	Accessor to the object's name.
getErrorMessage()	Error message accessor.
getFailedInputSample()	Failed input sample accessor.
getFileName()	File name accessor.
getInputColumns()	Columns of the input variables accessor.
getInterestVariables()	Get the variables to analyse.
getName()	Accessor to the object's name.
getNotEvaluatedInputSample()	Not evaluated input sample accessor.
getOriginalInputSample()	Input sample accessor.
getOutputColumns()	Columns of the output variables accessor.
getPhysicalModel()	Physical model accessor.
getPythonScript()	Physical model accessor.
getSampleFromFile()	Sample from the file accessor.
getSeed()	Seed accessor.
getWarningMessage()	Warning message accessor.
hasName()	Test if the object is named.
hasValidResult()	Whether the analysis has been run.
isReliabilityAnalysis()	Whether the analysis involves reliability.
isRunning()	Whether the analysis is running.
run()	Launch the analysis.
setBlockSize(size)	Block size accessor.
setColumns(*args)	Columns and names of variables accessor.
setFileName(fileName)	File name accessor.
setInterestVariables(variablesNames)	Set the variables to analyse.
setName(name)	Accessor to the object's name.
setSeed(seed)	Seed accessor.

StopRequested
canBeLaunched
getElapsedTime
getErrorDescription
getParentObserver
getResult

__init__(*args)

getBlockSize()

Block size accessor.

Returns

blockSizepositive int

Number of terms analysed together. It is set by default to 1.

getClassName()

Accessor to the object’s name.

Returns

class_namestr

The object class name (object.__class__.__name__).

getErrorMessage()

Error message accessor.

Returns

messagestr

Error message if the analysis failed

getFailedInputSample()

Failed input sample accessor.

Returns

sampleopenturns.Sample

Sample with the failed input values

getFileName()

File name accessor.

Returns

fileNamestr

Name of the file containing data

getInputColumns()

Columns of the input variables accessor.

Returns

columnsopenturns.Indices

Columns of the input variables

getInterestVariables()

Get the variables to analyse.

Returns

variablesNamessequence of str

Names of the variables to analyse

getName()

Accessor to the object’s name.

Returns

namestr

The name of the object.

getNotEvaluatedInputSample()

Not evaluated input sample accessor.

Returns

sampleopenturns.Sample

Points of the design of experiments which were not evaluated

getOriginalInputSample()

Input sample accessor.

Returns

sampleopenturns.Sample

Input sample.

getOutputColumns()

Columns of the output variables accessor.

Returns

columnsopenturns.Indices

Columns of the output variables

getPhysicalModel()

Physical model accessor.

Returns

modelPhysicalModel

Physical model

getPythonScript()

Physical model accessor.

Returns

scriptstr

Python script to replay the analysis

getSampleFromFile()

Sample from the file accessor.

Returns

sampleopenturns.Sample

Sample from the file

getSeed()

Seed accessor.

Returns

seedint

Seed value

getWarningMessage()

Warning message accessor.

Returns

messagestr

Warning message which can appear during the analysis computation

hasName()

Test if the object is named.

Returns

hasNamebool

True if the name is not empty.

hasValidResult()

Whether the analysis has been run.

Returns

hasValidResultbool

Whether the analysis has already been run

isReliabilityAnalysis()

Whether the analysis involves reliability.

Returns

isReliabilityAnalysisbool

Whether the analysis involves a reliability analysis

isRunning()

Whether the analysis is running.

Returns

isRunningbool

Whether the analysis is running

run()

Launch the analysis.

setBlockSize(size)

Block size accessor.

Parameters

blockSizepositive int

Number of terms analysed together. It is set by default to 1.

setColumns(*args)

Columns and names of variables accessor.

Parameters

inputColumnssequence of int

Columns of input variables

inNamessequence of str

Names of input variables

outputColumnssequence of int, optional

Columns of output variables

outNamessequence of str

Names of output variables

setFileName(fileName)

File name accessor.

Parameters

fileNamestr

Name of the file containing data

setInterestVariables(variablesNames)

Set the variables to analyse.

Parameters

variablesNamessequence of str

Names of the variables to analyse

setName(name)

Accessor to the object’s name.

Parameters

namestr

The name of the object.

setSeed(seed)

Seed accessor.

Parameters

seedint

Seed value