DX GDO Design of Experiment

DX GDO Design of Experiment
This container holds Design of Experiment data for a Goal Driven Optimization.

Methods

ApproveGeneratedData

Approve generated data after nonparametric changes by keeping DX results. This command is recursive and applied with any component dependent on the first component.

Example

The following example shows how to approve generated data. 

    system1 = GetSystem(Name="RSO")
    designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
    designofExperiment1.ApproveGeneratedData()

GetModel

Get the DataReference of the Model. An exception is thrown if the entity is not found.

Return     The DataReference of the Model.
    Type     DataReference
Example

The following example shows how the user can get a Model to change one of its properties. 

    system1 = GetSystem(Name="RSO")
    designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
    dOEModel1 = designofExperiment1.GetModel()
    dOEModel1.DOEType = "eDOETYPE_OSFD"

Data Entities

BBDMethod

Entity which performs and manages the DesignXplorer Sampling Method Component

Properties

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type     string
Read Only    No

CCDMethod

Entity which performs and manages the DesignXplorer Sampling Method Component

Properties

CCDTemplateType

Template Type for CCD algorithm.

Type     CCDTemplateType
Read Only    No
CCDType

Design Type for CCD algorithm.

Type     CentralCompositeDesignType
Read Only    No
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type     string
Read Only    No

CustomDOEMethod

Entity which performs and manages the DesignXplorer Sampling Method Component

Properties

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type     string
Read Only    No

CustomDOEPlusSampling

Entity which performs and manages the DesignXplorer Sampling Method Component

Properties

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type     string
Read Only    No

DiscreteLevel

The data entity which describes a Discrete Level of an Input Parameter.

Properties

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type     string
Read Only    No
Index

Zero-based Index of the discrete level in the list of levels of the owning parameter.

Type     int
Read Only    No
Value

Value of the DiscreteLevel.

Type     Object
Read Only    No

Methods

SetValue

Sets the value of a discrete level entity. A discrete level can have an integer value (e.g. a number if holes, a number of turns, etc) or a string value (e.g. a material name or a geometry file name).

Required Arguments

Value    Value set to the discrete level entity.
    Type     Object
Example

The following example shows how to retrieve a discrete level from an input parameter and then change its value. 

    container = system1.GetContainer(ComponentName="Design of Experiment")
    model = container.GetModel()
    DiscreteInputParameter = model.GetParameter(Name="P2")
    level1 = DiscreteInputParameter.GetDiscreteLevel(Name="Level 1")
    level1.SetValue( Value="2500" )

DistributionChart

The entity which describes a parameter's Distribution chart. This chart is always associated with an uncertainty parameter and allows you to visualize the statistical distribution defined or calculated for this parameter.

Properties

DisplayParameterFullName

If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short name such as "P1".

Type     bool
Read Only    No
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type     string
Read Only    No
IsUpToDate

True if the entity is up-to-date.

Type     bool
Read Only    No
Parameter

The parameter entity associated with the chart.

Type     DataReference
Read Only    No

Methods

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName    The exported file name.
    Type     string

Optional Arguments

AppendMode    True to append to an existing csv file, False to overwrite it.
    Type     bool
    Default Value    False
Example

The following example shows how the user can export the table of Design Points and then the Parameters Parallel chart of a Design of Experiments component. 

    container = system1.GetContainer(ComponentName="Design of Experiment")
    model = container.GetModel()
    parametricTable = model.GetParametricTable(Name="DesignPoints")
    parametricTable.ExportData(FileName="doe.csv")
    chart = model.GetChart(Name="DesignPointsParallel")
    chart.ExportData(FileName="doe.csv", AppendMode=True)

Update

Updates the chart by generating all results or data required to plot it. If the chart is already up-to-date, nothing is done by default.

Example

The following example shows how to update a Tradeoff chart. The same code applies to all other types of charts. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    chart = model.GetChart(Name="TradeoffChart 1")
    chart.Update()

DOEModel

Entity which performs and manages the DesignXplorer Design Of Experiments Component

Properties

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type     string
Read Only    No
ExportDesignPoints

If True and PreserveDesignPoints is True as well, export project for each preserved Design Point.

Type     bool
Read Only    No
Method

Optimization Method

Type     DataReference
Read Only    No
MethodName

Type of the Design of Experiments

Type     string
Read Only    No
NumberOfRetries

Indicates the number of times DX will try to update the failed design points.

Type     int
Read Only    No
PreserveDesignPoints

If True, preserve the Design Points at the project level after the component Update.

Type     bool
Read Only    No
RetainDesignPoints

If True and PreserveDesignPoints is True as well, retain data for each preserved Design Point.

Type     bool
Read Only    No
RetryDelay

Indicates how much time will elapse between tries. This option is only applicable when NumberOfRetries is greater than 0, otherwise it has no effect.

Type     Quantity
Read Only    No
RomMeshFile

ROM mesh file manually selected by the user. Null in a non-ROM context or if the default generated one is used.

Type     DataReference
Read Only    No

Methods

CreateChart

Creates a Chart entity. The chart must be updated once after its creation by invoking its Update method. Then changes to its properties will update the chart automatically.

Return     The DataReference of the Chart.
    Type     DataReference

Required Arguments

ChartType    Type of chart to be created. The possible values depend on the type of Model. For instance, a ResponseSurface model accepts Spider, LocalSensitivity and Response chart while a CorrelationModel accepts CorrelationMatrix, DeterminationMatrix and CorrelationScatter charts.
    Type     ChartType

Optional Arguments

DisplayText    Displayed name of the chart. If not specified, a default name is applied, depending on the value of ChartType.
    Type     string
Example

The following example shows how to create a chart. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    TradeoffChart = model.CreateChart(ChartType="eChartTradeoff")
    TradeoffChart.Update()

DeleteCharts

Deletes a list of Chart entities.

Required Arguments

Charts    List of Chart entities to delete.
    Type     List<DataReference>
Example

The following example shows how to delete existing charts. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    chart1 = model.GetChart(Name="TradeoffChart 1")
    chart2 = model.GetChart(Name="SamplesChart 1")
    model.DeleteCharts(Charts=[chart1, chart2])

DuplicateChart

Duplicates a Chart entity. The chart must be updated once after its creation by invoking its Update method. Then changes to its properties will update the chart automatically.

Return     The DataReference of the Chart.
    Type     DataReference

Required Arguments

Chart    The source chart to duplicate.
    Type     DataReference

Optional Arguments

DisplayText    Displayed name of the chart. If not specified, a default name is applied, depending on the value of ChartType.
    Type     string
TargetModel    The model on which the duplicated chart is created. If this parameter is not set, the model of the source chart is used.
    Type     DataReference
TargetResponsePoint    Parent TargetResponsePoint of the chart. If this parameter is not set, the response point of the source chart is used if applicable.
    Type     DataReference
Example

The following example shows how to duplicate a chart. 

    designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
    dOEModel1 = designofExperiment1.GetModel()
    designPointsCurvesChart1 = dOEModel1.GetChart(Name="DesignPointsCurves")
    chart1 = dOEModel1.DuplicateChart(Chart=designPointsCurvesChart1)
    chart1.Update()

GetChart

Query to return the chart reference for a given model and chart name.

Return     The DataReference of the chart.
    Type     DataReference

Required Arguments

Name    Name of the chart.
    Type     string
GetDesignPointReportSetting

Get the DataReference of a DesignPointReportSetting entity associated with a Model. An exception is thrown if the entity is not found.

Return     The DataReference of the DesignPointReportSetting.
    Type     DataReference
Example

The following example shows how the user can get a DesignPointReportSetting to change one of its properties. 

    system1 = GetSystem(Name="GDO")
    designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
    dOEModel1 = designofExperiment1.GetModel()
    designPointReportSettingEntity1 = dOEModel1.GetDesignPointReportSetting()
    designPointReportSettingEntity1.DesignPointReportImage = "FFF-Results:Figure001.png"

GetParameter

Get the DataReference of a Parameter. An exception is thrown if the entity is not found.

Return     The DataReference of the Parameter.
    Type     DataReference

Required Arguments

Name    Name of the Parameter.
    Type     string
Example

The following example shows how the user can get a parameter of a model to change one of its properties. 

    system1 = GetSystem(Name="RSO")
    designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
    dOEModel1 = designofExperiment1.GetModel()
    inputParameter1 = dOEModel1.GetParameter(Name="P1")
    inputParameter1.LowerBound = 1

GetParameters

Get the DataReferences of the InputParameter and OutputParameter of the model. If the optional argument InputParameters is not specified, the query returns all parameters. If it is specified and True, the query returns only input parameters. If it is False, the query returns only output parameters.

Return     The DataReferences of the Parameters
    Type     DataReferenceSet

Optional Arguments

InputParameters    If True, the query returns only input parameters. If False, the query returns only output parameters. If the argument is ommitted, the query returns all parameters.
    Type     bool
Example

The following example shows how the user can get the parameters of a model. 

    system1 = GetSystem(Name="RSO")
    designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
    dOEModel1 = designofExperiment1.GetModel()
    parameters = dOEModel1.GetParameters()

GetParametricTable

Get the DataReference of ParametricTable. An exception is thrown if the entity is not found. Names of the tables generated internally are: "DesignPoints", "CorrelationMatrix", "CorrelationScatter", "MinDesignPoints", "MaxDesignPoints", "ResponsePoints", "DeterminationMatrix".

Return     The DataReference of the ParametricTable
    Type     DataReference

Required Arguments

Name    Name of the ParametricTable
    Type     string
Example

The following example shows how the user can get a ParametricTable to add a new row and set values. 

    system1 = GetSystem(Name="RSO")
    designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
    dOEModel1 = designofExperiment1.GetModel()
    parametricTable = dOEModel1.GetParametricTable(Name="DesignPoints")
    parametricTable.AddRow()
    parametricTable.SetCellValue(RowIndex=9,ColumnIndex=0,Value="2.1")

ImportDesignPoints

Import existing Design Point entities in a custom Design of Experiments or Correlation model. If a Design Point is solved, the output parameter values are also imported if the customized model is not a Correlation model linked to a Response Surface model.

Optional Arguments

DesignPoints    List of the existing Design Point entities to import. If not specified, all the Design Point entities found in the Parametric container are imported.
    Type     List<DataReference>
ExpandRanges    If true, the command expands the range of variation of the input parameters based on the imported design points. This is done by modifying automatically the upper and lower bounds of the input parameters. If false, the design points which are not contained in the actual variation ranges are not imported. This option is not supported in the context of: - a DOE for a Six Sigma Analysis. - a Correlation based on a Response Surface.
    Type     bool
    Default Value    False
ShrinkRanges    If true, the command shrinks the range of variation of the input parameters based on the imported design points. This is done by modifying automatically the upper and lower bounds of the input parameters. If false, the design points which are not contained in the actual variation ranges are not imported. This option is not supported in the context of: - a DOE for a Six Sigma Analysis. - a Correlation based on a Response Surface.
    Type     bool
    Default Value    False
Example

The following example shows how the user can import all design points or a list of design points into a Design of Experiments model. 

    container = system1.GetContainer(ComponentName="Design of Experiment")
    model = container.GetModel()
    model.DOEType = "eDOETYPE_USER"
    model.ImportDesignPoints()
    designPoint0 = Parameters.GetDesignPoint(Name="0")
    designPoint1 = Parameters.GetDesignPoint(Name="1")
    designPoint2 = Parameters.GetDesignPoint(Name="2")
    model.ImportDesignPoints(DesignPoints=[designPoint0, designPoint1, designPoint2])
    model.ImportDesignPoints(DesignPoints=[designPoint1])

ImportDesignPointsFromArchive

Import Design Point values in a custom Design of Experiments model from an archive file.

Required Arguments

ArchivePath    The archive path.
    Type     string
ReuseSnapshotFiles    If true, reuse existing snapshot files of ROM production folder when they correspond to referenced snapshots of the archive. If false, copy all the snapshot files referenced in the archive (and rename them when they exist already in the ROM production folder).
    Type     bool

Optional Arguments

ExpandRanges    If true, the command expands the range of variation of the input parameters based on the imported design points. This is done by modifying automatically the upper and lower bounds of the input parameters. If false, the design points which are not contained in the actual variation ranges are not imported. This option is not supported in the context of a DOE for a Six Sigma Analysis.
    Type     bool
    Default Value    False
ShrinkRanges    If true, the command shrinks the range of variation of the input parameters based on the imported design points. This is done by modifying automatically the upper and lower bounds of the input parameters. If false, the design points which are not contained in the actual variation ranges are not imported. This option is not supported in the context of a DOE for a Six Sigma Analysis.
    Type     bool
    Default Value    False
Example

The following example shows how the user can import design points from a valid archive file. 

    system = GetSystem(Name="RBU")
    designofExperiment = system.GetContainer(ComponentName="Design of Experiment")
    dOEModel = designofExperiment.GetModel()
    dOEModel.MethodName = "ANSYS_USER"
    dOEModel.ImportDesignPointsFromArchive(FileName="E:/temp/doesnapshots2.snpz",OverwriteSnapshotFile=False)

ImportDesignPointsFromDps

Import Design Point values in a custom Design of Experiments or Correlation model with a query to the DPS.

Required Arguments

QueryString    The query.
    Type     string

Optional Arguments

ExpandRanges    If true, the command expands the range of variation of the input parameters based on the imported design points. This is done by modifying automatically the upper and lower bounds of the input parameters. If false, the design points which are not contained in the actual variation ranges are not imported. This option is not supported in the context of: - a DOE for a Six Sigma Analysis. - a Correlation based on a Response Surface.
    Type     bool
    Default Value    False
ShrinkRanges    If true, the command shrinks the range of variation of the input parameters based on the imported design points. This is done by modifying automatically the upper and lower bounds of the input parameters. If false, the design points which are not contained in the actual variation ranges are not imported. This option is not supported in the context of: - a DOE for a Six Sigma Analysis. - a Correlation based on a Response Surface.
    Type     bool
    Default Value    False
Example

The following example shows how the user can import the design point with the ID equal to 1. 

    container = system1.GetContainer(ComponentName="Design of Experiment")
    model = container.GetModel()
    model.DOEType = "eDOETYPE_USER"
    model.ImportDesignPointsFromDps(QueryString="?id=1", ExpandRanges=True)

ImportDesignPointsFromFile

Import Design Point values in a custom Design of Experiments model or in a custom Correlation model from a csv file.

Required Arguments

FileName    The imported file name.
    Type     string

Optional Arguments

ExpandRanges    If true, the command expands the range of variation of the input parameters based on the imported design points. This is done by modifying automatically the upper and lower bounds of the input parameters. If false, the design points which are not contained in the actual variation ranges are not imported. This option is not supported in the context of: - a DOE for a Six Sigma Analysis. - a Correlation based on a Response Surface.
    Type     bool
    Default Value    False
ShrinkRanges    If true, the command shrinks the range of variation of the input parameters based on the imported design points. This is done by modifying automatically the upper and lower bounds of the input parameters. If false, the design points which are not contained in the actual variation ranges are not imported. This option is not supported in the context of: - a DOE for a Six Sigma Analysis. - a Correlation based on a Response Surface.
    Type     bool
    Default Value    False
Example

The following example shows how the user can import design points from a valid csv file in a custom Correlation model. 

    container = system1.GetContainer(ComponentName="Correlation")
    model = container.GetModel()
    model.SamplingType = "Manual"
    model.ImportDesignPointsFromFile(FilePath="designs.csv", ExpandRanges=True)

PreviewDesignPoints

Previews the Design Points of a model, without actually updating them, so that the user can adjust settings before launching a long update operation. This command applies to a Design of Experiments model, or the Refinement Points of a Kriging Response Surface, or a Parameters Correlation model. The command returns the table of the generated points.

Return     The DataReference of the ParametricTable containing the generated data.
    Type     DataReference
Example

The following example shows how to preview a DOE model. 

    container = system1.GetContainer(ComponentName="Design of Experiment")
    model = container.GetModel()
    DOEMatrix = model.PreviewDesignPoints()

SetCustomRomMeshFile

Choose a custom mesh file for visualizing ROM. This mesh file will be used when opening ROM Viewer, and be included in the exported ROMs. If not already done, a processing step will be done for the mesh file, and the file will be renamed. Any existing file with the same name will be overwritten.

Required Arguments

KeepOriginal    If true, then the original file will be kept. If MeshPath is already in the DesignXplorer folder, this parameter is ignored.
    Type     bool
MeshPath    Path to the mesh file to set. If this file is outside of the DesignXplorer folder, it will be moved into it. Null or empty to clear the custom mesh, and use the one generated automatically from the Workbench project.
    Type     string
SetCustomRomSnapshotFile

Manually set a ROM snapshot file generated from an external solve.

Required Arguments

KeepOriginal    If true, then the original file will be copied. If false it will be moved. If SnapshotPath is already in the DesignXplorer folder then this parameter is ignored. If a snapshot with the same name is already in the DesignXplorer folder and ReuseSnapshot is set to "true" then this parameter is ignored.
    Type     bool
ReuseSnapshot    If true and there is already a snapshot with the same name in the DesignXplorer directory, then it will be reused and any copy or move operation will be skipped. If false and there is already a snapshot with the same name in the DesignXplorer directory, then a new name will be automatically assigned to the snapshot. If SnapshotPath is already in the DesignXplorer folder then this parameter is ignored. If there is no snapshot with the same name, this parameter is ignored.
    Type     bool
RowIndex    Zero-based row index of the cell.
    Type     int
SnapshotPath    Path to the snapshot file to set. If this file is outside of the DesignXplorer folder, it will be moved into it.
    Type     string
SolverSystem    System ID that produced the snapshot.
    Type     string
Example

The following example shows how to set the ROM Snapshot file for the DesignPoints table in a Design of Experiments model. 

    system1 = GetSystem(Name="RBU")
    designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
    dOEModel1 = designofExperiment1.GetModel()
    parametricTable1 = dOEModel1.GetParametricTable(Name="DesignPoints")
    parametricTable1.SetOutputValuesEditable(Editable=True,RowIndices=[1])
    Parameters.SetCustomRomSnapshotFile(
        ParametricTable=parametricTable1,
        RowIndex=0,
        SolverSystem="FLU",
        SnapshotPath="D:/ROM/snp_1.romsnp",
        KeepOriginal=True,
        ReuseSnapshot=False)

InputParameter

The data entity which describes an Input Parameter in DesignXplorer.

Properties

Attribute1

First editable attribute of the distribution for an uncertainty parameter. The nature of the attribute depends on the distribution type. For instance, the first attribute of a Normal distribution is the Mean value.

Type     double
Read Only    No
Attribute2

Second editable attribute of the distribution for an uncertainty parameter. The nature of the attribute depends on the distribution type. For instance, the second attribute of a Normal distribution is the Standard Deviation value. Some distribution type do not have a second attribute.

Type     double
Read Only    No
ConstantValue

Constant value of the Parameter when it is disabled.

Type     Object
Read Only    No
CustomDefinitionList

Custom Definition List

Type     List<DataReference>
Read Only    No
DiscreteLevels

List of the discrete levels.

Type     List<DataReference>
Read Only    Yes
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type     string
Read Only    No
DistributionLowerBound

Distribution lower bound of the variation range for an uncertainty Parameter.

Type     double
Read Only    No
DistributionType

Distribution type for an uncertainty parameter.

Type     DistributionType
Read Only    No
DistributionUpperBound

Distribution upper bound of the variation range for an uncertainty Parameter.

Type     double
Read Only    No
Enabled

True if the Parameter is enabled for the current study.

Type     bool
Read Only    No
Kurtosis

Kurtosis value of the distribution for an uncertainty parameter.

Type     double
Read Only    Yes
LowerBound

Lower bound of the variation range for a Continuous Parameter.

Type     double
Read Only    No
Mean

Mean value of the distribution for an uncertainty parameter.

Type     double
Read Only    Yes
Nature

Nature of the Parameter.

Type     ParameterNature
Read Only    No
NumberOfLevels

Number of levels if the parameter nature is Discrete, or the parameter nature is Continuous and the UseManufacturableValues property is set to True.

Type     int
Read Only    Yes
Skewness

Skewness value of the distribution for an uncertainty parameter.

Type     double
Read Only    Yes
StandardDeviation

Standard deviation value of the distribution for an uncertainty parameter.

Type     double
Read Only    Yes
Type

Type of the Parameter, either a DesignVariable in a GDO context, or an UncertaintyVariable in a SixSigma Analysis context.

Type     SimulationType
Read Only    Yes
Units

Units

Type     string
Read Only    Yes
UpperBound

Upper bound of the variation range for a Continuous Parameter.

Type     double
Read Only    No
UseManufacturableValues

True to restrict the variation of the parameter to defined Manufacturable Values.

Type     bool
Read Only    No

Methods

AddDiscreteLevel

Adds a Discrete Level entity on a discrete input parameter. A discrete level can have an integer value (e.g. a number of holes, a number of turns, etc) or a string value (e.g. a material name or a geometry file name). The command has optional arguments to specify the Name of the level and its Index in the list of levels of the parameter. By default, the new level is added to the end of the list. The various discrete levels of an input parameter represent independent configurations of the project, processed in the order of their creation.

Return     The created entity.
    Type     DataReference

Required Arguments

Value    The value of the discrete level. Value can be an integer or a string.
    Type     Object

Optional Arguments

DisplayText    DisplayText of the created entity. If not specified, a default name of the form "Level [#]" is used.
    Type     string
Index    The position of the new level in the list of discrete levels of the parameter. Index is zero-based. If it is not specified, the new level is appended to the list.
    Type     int
    Default Value    -1
Example

The following example shows how to add new discrete levels on a discrete input parameter. The third level is inserted between the two others. 

    container = system1.GetContainer(ComponentName="Design of Experiment")
    model = container.GetModel()
    DiscreteInputParameter = model.GetParameter(Name="P2")
    DiscreteInputParameter.AddDiscreteLevel(Value=3000, DisplayText="Three thousand turns")
    DiscreteInputParameter.AddDiscreteLevel(Value=2000, DisplayText="Two thousand turns")
    DiscreteInputParameter.AddDiscreteLevel(Value=5000, Index="1")

AddLevels

Adds a list of levels to a continuous input parameter. Each level is a quantity or a real number corresponding to a manufacturable value. The list of levels forms a restriction filter used when post-processing the input parameter. If levels are added outside of the variation range, the lower and upper bounds are adjusted accordingly.

Required Arguments

Levels    List of added levels.
    Type     List<string>

Optional Arguments

Overwrite    True in order to overwrite the existing levels, False by default.
    Type     bool
Example

The following example shows how to overwrite the manufacturable values of an input parameter and how to define an additional value later. 

    container = system1.GetContainer(ComponentName="Design of Experiment")
    model = container.GetModel()
    InputParameter = model.GetParameter(Name="P1")
    InputParameter.UseManufacturableValues = True
    InputParameter.AddLevels(Levels=["0.3 [mm]", "0.5 [mm]", "1e-3 [m]"], Overwrite=True)
    InputParameter.AddLevels(Levels="7 [mm]")

CreateOptimizationCriterion

Creates an OptimizationCriterion entity associated to a parameter.

Return     The DataReference of the OptimizationCriterion.
    Type     DataReference

Required Arguments

Parameter    The parameter on which the criterion is created.
    Type     DataReference
Example

The following example shows how to create an OptimizationCriterion entity. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    parameter1 = model.GetParameter(Name="P1")
    optimizationCriterion = parameter1.CreateOptimizationCriterion()

DeleteDiscreteLevels

Deletes a list of levels from a discrete input parameter.

Required Arguments

DiscreteLevels    List of the DiscreteLevel entities to delete.
    Type     List<DataReference>
Example

The following example shows how to add and then delete one or more levels from a discrete input parameter. 

    container = system1.GetContainer(ComponentName="Design of Experiment")
    model = container.GetModel()
    DiscreteInputParameter = model.GetParameter(Name="P1")
    level1 = DiscreteInputParameter.AddDiscreteLevel(Value=3000, DisplayText="Three thousand turns")
    level2 = DiscreteInputParameter.AddDiscreteLevel(Value=2000, DisplayText="Two thousand turns")
    level3 = DiscreteInputParameter.AddDiscreteLevel(Value=5000, Index="1")
    DiscreteInputParameter.DeleteDiscreteLevels(DiscreteLevels=[level1, level2])

DeleteLevels

Deletes a list of levels from a continuous input parameter.

Required Arguments

Indices    Indices of the items to remove from the levels list
    Type     List<int>
Example

The following example shows how to add and then delete one or more levels from a continuous input parameter for which the UseManufacturableValues property is set to True. 

    container = system1.GetContainer(ComponentName="Design of Experiment")
    model = container.GetModel()
    InputParameter = model.GetParameter(Name="P1")
    InputParameter.UseManufacturableValues = True
    InputParameter.AddLevels(Levels=["0.3 [mmm]", "0.5 [mm]", "1e-3 [m]"], Overwrite=True)
    InputParameter.DeleteLevels( Indices=[0, 1] )

ExportData

Export the data of a DesignXplorer entity to a csv file. The entity can be one of the DesignXplorer chart entities, a ParametricTable or an InputParameter entity.

Required Arguments

FileName    The exported file name.
    Type     string

Optional Arguments

AppendMode    True to append to an existing csv file, False to overwrite it.
    Type     bool
    Default Value    False
Example

The following example shows how the user can export the table of Design Points and then the Parameters Parallel chart of a Design of Experiments component. 

    container = system1.GetContainer(ComponentName="Design of Experiment")
    model = container.GetModel()
    parametricTable = model.GetParametricTable(Name="DesignPoints")
    parametricTable.ExportData(FileName="doe.csv")
    chart = model.GetChart(Name="DesignPointsParallel")
    chart.ExportData(FileName="doe.csv", AppendMode=True)

GetCustomParameterDefinition

Get the DataReference of a CustomParameterProperties entity associated with an Input Parameter. An exception is thrown if the entity is not found.

Return     The DataReference of the CustomParameterProperties.
    Type     DataReference

Required Arguments

ExtensionName    Extension's Name.
    Type     string
Example

The following example shows how the user can get a CustomParameterProperties. 

    system1 = GetSystem(Name="DOP")
    optimization1 = system1.GetContainer(ComponentName="Optimization")
    optimizationModel1 = optimization1.GetModel()
    inputParameter1 = optimizationModel1.GetParameter(Name="P1")
    customParameterDefinition1 = inputParameter1.GetCustomParameterDefinition(ExtensionName="UncertaintyParameterDefiniton@PythonOptimizer")
    customParameterDefinition1.Distribution = "Triangular"

GetDiscreteLevel

Get a discrete level by name from an input parameter. The parameter's full and ordered list of discrete levels is available as its "DiscreteLevels" property.

Return     The DataReference of the discrete level entity.
    Type     DataReference

Required Arguments

Name    The name of the discrete level.
    Type     string
Example

The following example shows how the user can retrieve a discrete level of a discrete input parameter by its name. 

    system1 = GetSystem(Name="RSO")
    designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
    dOEModel1 = designofExperiment1.GetModel()
    DiscreteInputParameter1 = dOEModel1.GetParameter(Name="P1")
    level = DiscreteInputParameter1.GetDiscreteLevel(Name="Level 1")

GetOptimizationCriterion

Get the DataReference of the OptimizationCriterion associated with a Parameter. An exception is thrown if the entity is not found.

Return     The DataReference of the OptimizationCriterion.
    Type     DataReference

Required Arguments

Parameter    Parent Parameter.
    Type     DataReference
Example

The following example shows how the user can get a OptimizationCriterion to change one of its properties. 

    system1 = GetSystem(Name="RSO")
    optimization1 = system1.GetContainer(ComponentName="Optimization")
    optimizationModel1 = optimization1.GetModel()
    parameter3 = optimizationModel1.GetParameter(Name="P3")
    optimizationCriterion = parameter3.GetOptimizationCriterion()
    optimizationCriterion.ObjectiveType = "eGT_MinimumPossible"

GetParameterStatistics

Get the DataReference of the ParameterStatistics entity associated with a Parameter.

Return     The DataReference of the ParameterStatistics entity.
    Type     DataReference
Example

The following example shows how the user can get a ParameterStatistics entity and examine its Mean property. 

    system1 = GetSystem(Name="SSA")
    sixSigmaAnalysis1 = system1.GetContainer(ComponentName="Six Sigma Analysis")
    sixSigmaModel1 = sixSigmaAnalysis1.GetModel()
    parameter4 = sixSigmaModel1.GetParameter(Name="P4")
    parameterStatistics1 = parameter4.GetParameterStatistics()
    mean = parameterStatistics1.Mean

LHSDMethod

Entity which performs and manages the DesignXplorer Sampling Method Component

Properties

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type     string
Read Only    No
NumSamp

Number of Samples for User-Defined LHSD algorithm.

Type     int
Read Only    No
RandomGeneratorSeed

Seed value for LHS and LHSD algorithm.

Type     int
Read Only    No
SampType

Samples Type for LHS and LHSD algorithm.

Type     NumSampType
Read Only    No

OSFDMethod

Entity which performs and manages the DesignXplorer Optimization Method Component

Properties

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type     string
Read Only    No
MaxNumCycles

Maximum Number Of Cycles for OSFD algorithm.

Type     int
Read Only    No
NumSamp

Number of Samples for User-Defined OSFD algorithm.

Type     int
Read Only    No
OSFDType

Design Type for OSFD algorithm.

Type     OptimalSpaceFillingType
Read Only    No
RandomGeneratorSeed

Seed value for LHS and OSFD algorithm.

Type     int
Read Only    No
SampType

Samples Type for LHS and OSFD algorithm.

Type     NumSampType
Read Only    No

OutputParameter

Output parameter entity for DesignXplorer.

Properties

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type     string
Read Only    No
EnableAutoRefinement

Determines whether the Auto Refinement is applicable to the output parameter.

Type     bool
Read Only    No
IgnoreForFiltering

Determines whether the parameter filtering is not applicable to the output parameter in the correlation context.

Type     bool
Read Only    No
InheritFromModelSettings

Determines whether the Maximum Predicted Relative Error defined at the Model level is applicable to the output parameter.

Type     bool
Read Only    No
LowerBound

Minimum value extracted from existing design points and/or sample sets.

Type     double
Read Only    Yes
MaximumPredictedError

Maximum Predicted Error for an output parameter with the GARS algorithm. This is the maximum predicted error for the selected output parameter.

Type     double
Read Only    Yes
MaxPredictedRelativeError

Maximum Relative Error targeted for an output parameter when refining with the Kriging algorithm. This is the maximum predicted relative error that is acceptable for the selected output parameter.

Type     double
Read Only    No
PredictedRelativeError

Current value of the Predicted Relative Error when refining with the Kriging algorithm

Type     double
Read Only    Yes
Scaling

Scaling

Type     bool
Read Only    No
Tolerance

Maximum Error targeted for an output parameter when refining with the GARS algorithm. This is the maximum predicted error that is acceptable for the selected output parameter.

Type     double
Read Only    No
TransformationType

Transformation Type

Type     TransformationType
Read Only    No
Units

Units

Type     string
Read Only    Yes
UpperBound

Maximum value extracted from existing design points and/or sample sets.

Type     double
Read Only    Yes

Methods

CreateOptimizationCriterion

Creates an OptimizationCriterion entity associated to a parameter.

Return     The DataReference of the OptimizationCriterion.
    Type     DataReference

Required Arguments

Parameter    The parameter on which the criterion is created.
    Type     DataReference
Example

The following example shows how to create an OptimizationCriterion entity. 

    container = system1.GetContainer(ComponentName="Optimization")
    model = container.GetModel()
    parameter1 = model.GetParameter(Name="P1")
    optimizationCriterion = parameter1.CreateOptimizationCriterion()

GetOptimizationCriterion

Get the DataReference of the OptimizationCriterion associated with a Parameter. An exception is thrown if the entity is not found.

Return     The DataReference of the OptimizationCriterion.
    Type     DataReference

Required Arguments

Parameter    Parent Parameter.
    Type     DataReference
Example

The following example shows how the user can get a OptimizationCriterion to change one of its properties. 

    system1 = GetSystem(Name="RSO")
    optimization1 = system1.GetContainer(ComponentName="Optimization")
    optimizationModel1 = optimization1.GetModel()
    parameter3 = optimizationModel1.GetParameter(Name="P3")
    optimizationCriterion = parameter3.GetOptimizationCriterion()
    optimizationCriterion.ObjectiveType = "eGT_MinimumPossible"

GetParameterStatistics

Get the DataReference of the ParameterStatistics entity associated with a Parameter.

Return     The DataReference of the ParameterStatistics entity.
    Type     DataReference
Example

The following example shows how the user can get a ParameterStatistics entity and examine its Mean property. 

    system1 = GetSystem(Name="SSA")
    sixSigmaAnalysis1 = system1.GetContainer(ComponentName="Six Sigma Analysis")
    sixSigmaModel1 = sixSigmaAnalysis1.GetModel()
    parameter4 = sixSigmaModel1.GetParameter(Name="P4")
    parameterStatistics1 = parameter4.GetParameterStatistics()
    mean = parameterStatistics1.Mean

SamplingMethod

Entity which wraps and manages the external Sampling Method for the Design of Experiments component

Properties

No Properties.

SPGDMethod

Entity which performs and manages the DesignXplorer Sampling Method Component

Properties

DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type     string
Read Only    No