ImportedDesignOfExperiment

class persalys.ImportedDesignOfExperiment(*args)

Create a design of experiments, using an imported design.

Available constructors:

ImportedDesignOfExperiment(name, physicalModel, fileName, columns)

Parameters:

name : str

Name

physicalModel : PhysicalModel

Physical model

fileName : str

Name of a data file to load

columns : sequence 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.
getId()	Accessor to the object’s id.
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 ouput variables accessor.
getPhysicalModel()	Physical model accessor.
getPythonScript()	Physical model accessor.
getResult()
getSampleFromFile()	Sample from the file accessor.
getSeed()	Seed accessor.
getShadowedId()	Accessor to the object’s shadowed id.
getVisibility()	Accessor to the object’s visibility state.
getWarningMessage()	Warning message accessor.
hasName()	Test if the object is named.
hasValidResult()	Whether the analysis has been run.
hasVisibleName()	Test if the object has a distinguishable name.
isReliabilityAnalysis()	Whether the analysis involves reliability.
isRunning()	Whether the analysis is running.
run()	Launch the analysis.
setBlockSize(size)	Block size accessor.
setFileName(fileName)	File name accessor.
setInputColumns(inputColumns)	Input columns accessor.
setInterestVariables(variablesNames)	Set the variables to analyse.
setName(name)	Accessor to the object’s name.
setSeed(seed)	Seed accessor.
setShadowedId(id)	Accessor to the object’s shadowed id.
setVisibility(visible)	Accessor to the object’s visibility state.

__init__(*args)

getBlockSize()

Block size accessor.

Returns:

blockSize : positive int

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

getClassName()

Accessor to the object’s name.

Returns:

class_name : str

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

getErrorMessage()

Error message accessor.

Returns:

message : str

Error message if the analysis failed

getFailedInputSample()

Failed input sample accessor.

Returns:

sample : openturns.Sample

Sample with the failed input values

getFileName()

File name accessor.

Returns:

fileName : str

Name of the file containing data

getId()

Accessor to the object’s id.

Returns:

id : int

Internal unique identifier.

getInputColumns()

Columns of the input variables accessor.

Returns:

columns : openturns.Indices

Columns of the input variables

getInterestVariables()

Get the variables to analyse.

Returns:

variablesNames : sequence of str

Names of the variables to analyse

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getNotEvaluatedInputSample()

Not evaluated input sample accessor.

Returns:

sample : openturns.Sample

Points of the design of experiments which were not evaluated

getOriginalInputSample()

Input sample accessor.

Returns:

sample : openturns.Sample

Input sample.

getOutputColumns()

Columns of the ouput variables accessor.

Returns:

columns : openturns.Indices

Columns of the output variables

getPhysicalModel()

Physical model accessor.

Returns:

model : PhysicalModel

Physical model

getPythonScript()

Physical model accessor.

Returns:

script : str

Python script to replay the analysis

getSampleFromFile()

Sample from the file accessor.

Returns:

sample : openturns.Sample

Sample from the file

getSeed()

Seed accessor.

Returns:

seed : int

Seed value

getShadowedId()

Accessor to the object’s shadowed id.

Returns:

id : int

Internal unique identifier.

getVisibility()

Accessor to the object’s visibility state.

Returns:

visible : bool

Visibility flag.

getWarningMessage()

Warning message accessor.

Returns:

message : str

Warning message which can appear during the analysis computation

hasName()

Test if the object is named.

Returns:

hasName : bool

True if the name is not empty.

hasValidResult()

Whether the analysis has been run.

Returns:

hasValidResult : bool

Whether the analysis has already been run

hasVisibleName()

Test if the object has a distinguishable name.

Returns:

hasVisibleName : bool

True if the name is not empty and not the default one.

isReliabilityAnalysis()

Whether the analysis involves reliability.

Returns:

isReliabilityAnalysis : bool

Whether the analysis involves a reliability analysis

isRunning()

Whether the analysis is running.

Returns:

isRunning : bool

Whether the analysis is running

run()

Launch the analysis.

setBlockSize(size)

Block size accessor.

Parameters:

blockSize : positive int

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

setFileName(fileName)

File name accessor.

Parameters:

fileName : str

Name of the file containing data

setInputColumns(inputColumns)

Input columns accessor.

Parameters:

columns : sequence of int

Columns of the input variables

setInterestVariables(variablesNames)

Set the variables to analyse.

Parameters:

variablesNames : sequence of str

Names of the variables to analyse

setName(name)

Accessor to the object’s name.

Parameters:

name : str

The name of the object.

setSeed(seed)

Seed accessor.

Parameters:

seed : int

Seed value

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:

id : int

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:

visible : bool

Visibility flag.