DataModel

class persalys.DataModel(*args)

Create a data model from an imported dataset.

The interface allows the user to load data samples and analyse them. They are considered as data models.

DataModel(name, fileName, inputColumns, outputColumns, inputNames, outputNames)

DataModel(name, inputSample, outputSample)

Parameters:

name : str

Name

fileName : str

Name of a data file (.txt ot .csv) to load

inputColumns : sequence of int

Indices of columns of the input variables in file to consider

outputColumns : sequence of int

Indices of columns of the output variables in file to consider (optional)

inputNames : sequence of str

Names of the input variables (optional)

outputNames : sequence of str

Names of the output variables (optional)

inputSample : openturns.Sample

Input sample

outputSample : openturns.Sample

Output sample (optional)

Examples

>>> import openturns as ot
>>> import persalys
>>> ot.RandomGenerator.SetSeed(0)
>>> fileName = 'sample.csv'
>>> sample = ot.Normal(3).getSample(30)
>>> sample.exportToCSVFile(fileName)
>>> model = persalys.DataModel('dataModel', fileName, [0, 2], [1], ['var1', 'var2'], ['var3'])

Methods

getClassName()	Accessor to the object’s name.
getFileName()	File name accessor.
getId()	Accessor to the object’s id.
getInputColumns()	Columns of the input variables accessor.
getInputNames()	Names of the input variables accessor.
getInputSample()	Input sample accessor.
getListXMax()	List of input values.
getListXMin()	List of input values.
getName()	Accessor to the object’s name.
getOutputColumns()	Columns of the ouput variables accessor.
getOutputNames()	Names of the ouput variables accessor.
getOutputSample()	Output sample accessor.
getPhysicalModel()	Physical model accessor.
getPythonScript()	Python script accessor.
getSample()	Sample accessor.
getSampleFromFile()	Sample from the file accessor.
getShadowedId()	Accessor to the object’s shadowed id.
getVisibility()	Accessor to the object’s visibility state.
hasName()	Test if the object is named.
hasPhysicalModel()	Whether it contains a physical model.
hasVisibleName()	Test if the object has a distinguishable name.
initialize()	Empty the input and output samples.
isValid()	Whether the model is valid.
setColumns(inputColumns, inputNames, …)	Columns and names of variables accessor.
setFileName(fileName)	File name accessor.
setInputSample(sample)	Input sample accessor.
setName(name)	Accessor to the object’s name.
setOutputSample(sample)	Output sample accessor.
setShadowedId(id)	Accessor to the object’s shadowed id.
setVisibility(visible)	Accessor to the object’s visibility state.

__init__(*args)

getClassName()

Accessor to the object’s name.

Returns:

class_name : str

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

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

getInputNames()

Names of the input variables accessor.

Returns:

names : openturns.Description

Names of the input variables

getInputSample()

Input sample accessor.

Returns:

sample : openturns.Sample

Input sample

getListXMax()

List of input values.

Returns:

list : SampleCollection

List of input values

getListXMin()

List of input values.

Returns:

list : SampleCollection

List of input values

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getOutputColumns()

Columns of the ouput variables accessor.

Returns:

columns : openturns.Indices

Columns of the output variables

getOutputNames()

Names of the ouput variables accessor.

Returns:

names : openturns.Description

Names of the output variables

getOutputSample()

Output sample accessor.

Returns:

sample : openturns.Sample

Output sample

getPhysicalModel()

Physical model accessor.

Returns:

model : PhysicalModel

Physical model

getPythonScript()

Python script accessor.

Returns:

script : str

Python script to rebuild the design of experiments

getSample()

Sample accessor.

Returns:

sample : openturns.Sample

Input sample and output sample

getSampleFromFile()

Sample from the file accessor.

Returns:

sample : openturns.Sample

Sample from the file

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.

hasName()

Test if the object is named.

Returns:

hasName : bool

True if the name is not empty.

hasPhysicalModel()

Whether it contains a physical model.

Returns:

hasPhysicalModel : bool

Whether it contains a physical model

hasVisibleName()

Test if the object has a distinguishable name.

Returns:

hasVisibleName : bool

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

initialize()

Empty the input and output samples.

isValid()

Whether the model is valid.

Returns:

isValid : bool

Whether the model is valid

setColumns(inputColumns, inputNames, outputColumns, outputNames)

Columns and names of variables accessor.

Parameters:

inputColumns : sequence of int

Columns of input variables

inNames : sequence of str

Names of input variables

outputColumns : sequence of int, optional

Columns of output variables

outNames : sequence of str

Names of output variables

setFileName(fileName)

File name accessor.

Parameters:

fileName : str

Name of the file containing data

setInputSample(sample)

Input sample accessor.

Parameters:

sample : openturns.Sample

Input sample

setName(name)

Accessor to the object’s name.

Parameters:

name : str

The name of the object.

setOutputSample(sample)

Output sample accessor.

Parameters:

sample : openturns.Sample

Output sample

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.