DX GDO Response Surface
This container holds Response Surface data for a Goal Driven Optimization.
Get the DataReference of the Model. An exception is thrown if the entity is not found.
Return
The DataReference of the Model.
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"
Entity which manages the Goodness Of Fit Information of a Response Surface for an Output Parameter
A Dictionary holding the values of all discrete input. Note: Discrete parameter values are level values, not indices.
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.
For the standard response surface only (Full second order Polynomials), creates an Advanced Goodness of Fit report for any direct output parameter.
Return
A string which contains the generated Advanced Goodness of Fit report.
Required Arguments
Optional Arguments
The following example shows how to create an Advanced Goodness of Fit report.
container = system1.GetContainer(ComponentName="Response Surface")
model = container.GetModel()
gof1 = model.GetGoodnessOfFit(Name="GoodnessOfFit")
outputParameter1 = model.GetParameter(Name="P4")
report1 = gof1.CreateAdvancedReport(Parameter=outputParameter1)
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
Optional Arguments
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)
Sets the Expression of a discrete input parameter in a GoodnessOfFit and updates the associated output parameter values. The chart entities depending on the GoodnessOfFit are updated as well.
Required Arguments
The following example shows how to set the expression for one discrete parameter in an existing GoodnessOfFit.
container = system1.GetContainer(ComponentName="Response Surface")
model = container.GetModel()
gof = model.GetGoodnessOfFit(Name="Goodness Of Fit")
inputParameter1 = model.GetParameter(Name="P1")
gof.SetDiscreteParameter(DiscreteParameter=inputParameter1, Expression="15")
Updates the goodness of fit and the results which depend on it. If the goodness of fit is already uptodate, nothing is done unless the Force flag is set to True.
Optional Arguments
The following example shows how to update an existing GoodnessOfFit.
container = system1.GetContainer(ComponentName="Response Surface")
model = container.GetModel()
gof1 = model.GetGoodnessOfFit(Name="GOF 1")
gof1.Update()
The data entity which describes an Input Parameter in DesignXplorer.
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.
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.
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.
Distribution lower bound of the variation range for an uncertainty Parameter.
Distribution upper bound of the variation range for an uncertainty Parameter.
Number of levels if the parameter nature is Discrete, or the parameter nature is Continuous and the UseManufacturableValues property is set to True.
Standard deviation value of the distribution for an uncertainty parameter.
Type of the Parameter, either a DesignVariable in a GDO context, or an UncertaintyVariable in a SixSigma Analysis context.
True to restrict the variation of the parameter to defined Manufacturable Values.
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.
Required Arguments
Optional Arguments
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")
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.
Optional Arguments
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]")
Creates an OptimizationCriterion entity associated to a parameter.
Return
The DataReference of the OptimizationCriterion.
Required Arguments
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()
Deletes a list of levels from a discrete input parameter.
Required Arguments
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])
Deletes a list of levels from a continuous input parameter.
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] )
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
Optional Arguments
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)
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.
Required Arguments
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"
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.
Required Arguments
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")
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.
Required Arguments
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"
Get the DataReference of the ParameterStatistics entity associated with a Parameter.
Return
The DataReference of the ParameterStatistics entity.
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
The data entity which described the MinMax Search option of a Response Surface Component.
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.
If True, performs a min-max search performed when the response surface is built.
Number of initial samples for the min-max search algorithm.
Output parameter entity for DesignXplorer.
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.
Determines whether the Auto Refinement is applicable to the output parameter.
Determines whether the parameter filtering is not applicable to the output parameter in the correlation context.
Determines whether the Maximum Predicted Relative Error defined at the Model level is applicable to the output parameter.
Minimum value extracted from existing design points and/or sample sets.
Maximum Predicted Error for an output parameter with the GARS algorithm. This is the maximum predicted error for the selected output parameter.
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.
Current value of the Predicted Relative Error when refining with the Kriging algorithm
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.
Maximum value extracted from existing design points and/or sample sets.
Creates an OptimizationCriterion entity associated to a parameter.
Return
The DataReference of the OptimizationCriterion.
Required Arguments
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()
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.
Required Arguments
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"
Get the DataReference of the ParameterStatistics entity associated with a Parameter.
Return
The DataReference of the ParameterStatistics entity.
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
ParametricTable entity used to encapsulate most of the evaluation results in a convenient 2D matrix format.
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.
Adds a row to the bottom of a ParametricTable entity.
The following example shows how to make a DOE editable, to retrieve the table of design points and add a new row to it.
container = system1.GetContainer(ComponentName="Design of Experiment")
model = container.GetModel()
model.DOEType = "eDOETYPE_USER"
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.AddRow()
Delete rows from a ParametricTable entity.
The following example shows how to delete rows from the DOEmatrix in a custom DOE context.
container = system1.GetContainer(ComponentName="Design of Experiment")
model = container.GetModel()
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.DeleteRows(Indices=[0,7,8,9])
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
Optional Arguments
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)
Get the Value of a ParametricTable's cell. An exception is thrown if the entity is not found.
Return
The value of the cell.
Required Arguments
The following example shows how the user can get the value of the ParametricTable's cell [0,3].
system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parametricTable = dOEModel1.GetParametricTable(Name="DesignPoints")
cellValue = parametricTable.GetCellValue(RowIndex=0,ColumnIndex=3)
Get the Update Order value of a row in a ParametricTable. An exception is thrown if the entity is not found.
Return
The value of the update order.
Required Arguments
The following example shows how to get the Update Order value of row [3] in the ParametricTable.
system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parametricTable = dOEModel1.GetParametricTable(Name="DesignPoints")
updateOrderValue = parametricTable.GetRowUpdateOrder(RowIndex=3)
Get the Values of a ParametricTable's row. An exception is thrown if the entity is not found.
Required Arguments
The following example shows how the user can get the values of the 4th ParametricTable's row.
system1 = GetSystem(Name="RSO")
designofExperiment1 = system1.GetContainer(ComponentName="Design of Experiment")
dOEModel1 = designofExperiment1.GetModel()
parametricTable = dOEModel1.GetParametricTable(Name="DesignPoints")
rowValues = parametricTable.GetRowValues(RowIndex=3)
Optimizes the Update Order of Design Points to minimize the number of modifications between two consecutive Design Points. This command applies to the "DesignPoints" ParametricTable of a Design of Experiments model or of a Response Surface in a manual refinement context. It also applies to the "VerificationPoints" ParametricTable of a Response Surface model.
The following example shows how to optimize the update order of the DesignPoints table in a Design of Experiments model.
container = system1.GetContainer(ComponentName="Design of Experiment")
model = container.GetModel()
model.DOEType = "eDOETYPE_USER"
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.OptimizeUpdateOrder()
Sets the value of a ParametricTable cell. If the table is read-only, the command has no effect.
Required Arguments
The following example shows how to set the value of the DesignPoints table in a custom DOE context.
container = system1.GetContainer(ComponentName="Design of Experiment")
model = container.GetModel()
model.DOEType = "eDOETYPE_USER"
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.AddRow()
DOEMatrix.SetCellValue(RowIndex=0, ColumnIndex=0, Value="12.5 [mm]")
Sets the values of the output parameters as Editable (Editable=True) or Calculated (Editable=False) for the complete table, or a set of rows specified by the RowIndices argument. This command is applicable to the "DesignPoints" ParametricTable of a Design of Experiments model in a custom context (DOEType is "eDOETYPE_USER" or "eDOETYPE_CUSTOM_OSFD") or of a Response Surface model in a manual refinement context. It also applies to the "VerificationPoints" ParametricTable of a Response Surface model.
Required Arguments
Optional Arguments
The following example shows how to switch a DOE model to the custom mode and then set the output values as editable for the first three design points of the DOE matrix.
container = system1.GetContainer(ComponentName="Design of Experiment")
model = container.GetModel()
model.DOEType = "eDOETYPE_USER"
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.SetOutputValuesEditable(Editable=True, RowIndices=[0,1,2])
Sets the Update Order value for a row in a ParametricTable. If the table doesn't support Update Order functionality, the command has no effect.
Required Arguments
The following example shows how to set the Update Order value of the DesignPoints table in a Design of Experiments model.
container = system1.GetContainer(ComponentName="Design of Experiment")
model = container.GetModel()
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.SetRowUpdateOrder(RowIndex=0, Value="2.0")
Sets the values of a ParametricTable's row. If the table is read-only, the command has no effect.
Required Arguments
The following example shows how to set the values of the DesignPoints table in a custom DOE context.
container = system1.GetContainer(ComponentName="Design of Experiment")
model = container.GetModel()
model.DOEType = "eDOETYPE_USER"
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.AddRow()
DOEMatrix.SetRowValues(RowIndex=0, RowValues=[ "12.5 [mm]", "1" ] )
Sets a value for the UpdateOrder property of all Design Points using sorting settings. This command applies to the "DesignPoints" ParametricTable of a Design of Experiments model or of a Response Surface in a manual refinement context. It also applies to the "VerificationPoints" ParametricTable of a Response Surface model.
The following example shows how to set the update order of the DesignPoints table in a Design of Experiments model. The Design Points are sorted first by their values for the parameter P3 (in ascending order), and then by their values for the parameter P1 (in descending order).
container = system1.GetContainer(ComponentName="Design of Experiment")
model = container.GetModel()
DOEMatrix = model.GetParametricTable(Name="DesignPoints")
DOEMatrix.SetUpdateOrderByRow(SortBy=["P3:+", "P1:-"])
Updates the design points held in rows from a ParametricTable entity and the results which depend on it.
The following example shows how to update the design points from the VerificationPoints Table.
responseSurface1 = system1.GetContainer(ComponentName="Response Surface")
responseSurfaceModel1 = responseSurface1.GetModel()
parametricTable1 = responseSurfaceModel1.GetParametricTable(Name="VerificationPoints")
parametricTable1.UpdateRows(Indices=[0,1])
Entity which performs and manages the DesignXplorer Response Surface Component
Crowding Distance Separation Percentage when refining with the Kriging algorithm
Crowding Distance Separation Percentage when refining with the Genetic Aggregation algorithm
Level of Display of Log File of Genetic Aggregation Response Surface
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.
If True and PreserveDesignPoints is True as well, export project for each preserved Design Point.
Kernel Variation Type for the Kriging algorithm
Maximum Depth limit when refining with the Sparse Grid response surface
Maximum Number of Generations for Genetic Aggregation Response Surface
Maximum Relative Error targeted when refining with the Sparse Grid response surface
Maximum Number of Refinement Points that can be generated for refinement with the Genetic Aggregation algorithm.
Maximum Number of Refinement Points that can be generated for refinement with the Kriging algorithm.
Maximum Number of Refinement Points that can be generated for refinement with the Sparse Grid response surface
Maximum Relative Error targeted for all input parameters when refining with the Kriging algorithm. This is the maximum predicted relative error that is acceptable for all parameters.
Indicates the number of times DX will try to update the failed design points.
Output Variable Combinations when refining with the Kriging algorithm. Controls how output variables are considered in terms of Predicated Relative Error and determines the number of refinement points generated per iteration.
Current value of the Predicted Relative Error when refining with the Kriging algorithm
If True, preserve the Design Points at the project level after the component Update.
Output Variable Combinations when refining with the GARS algorithm. Controls how output variables are considered in terms of Predicted Error and determines the number of refinement points generated per iteration.
If True and PreserveDesignPoints is True as well, retain data for each preserved Design Point.
Indicates how much time will elapse between tries. This option is only applicable when NumberOfRetries is greater than 0, otherwise it has no effect.
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.
Required Arguments
Optional Arguments
The following example shows how to create a chart.
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
TradeoffChart = model.CreateChart(ChartType="eChartTradeoff")
TradeoffChart.Update()
Creates a GoodnessOfFit. The ParameterValues dictionary can be used to specify a value for some or all of the discrete input parameters.
Return
The created entity.
Optional Arguments
The following example shows how to create a GoodnessOfFit from an existing ResponseSurface model. The code retrieves the parameters P1 and P2 and then creates the response point by assigning a value to each of these parameters.
container = system1.GetContainer(ComponentName="Response Surface")
model = container.GetModel()
inputParameter1 = model.GetParameter(Name="P1")
inputParameter2 = model.GetParameter(Name="P2")
goodnessOfFit = model.CreateGoodnessOfFit( DisplayText="GOF1",
ParameterValues={inputParameter1: "2", inputParameter2: "15"})
Creates a ResponsePoint. The ParameterValues dictionary can be used to specify a value or a quantity for some or all of the input parameters. The output parameter values cannot be specified. They are evaluated automatically from the ResponseSurface model once it is updated. Several types of charts can only be created as children of a ResponsePoint. These charts depend on the ResponsePoint and use the same parameter values.
Return
The created entity.
Optional Arguments
The following example shows how to create a ResponsePoint from an existing ResponseSurface model. The code retrieves the parameters P1 and P2 and then creates the response point by assigning a value to each of these parameters.
container = system1.GetContainer(ComponentName="Response Surface")
model = container.GetModel()
inputParameter1 = model.GetParameter(Name="P1")
inputParameter2 = model.GetParameter(Name="P2")
responsePoint = model.CreateResponsePoint( DisplayText="Improved Design",
ParameterValues={inputParameter1: "2.01", inputParameter2: "15.5"})
Deletes a list of Chart entities.
Required Arguments
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])
Deletes a list of GoodnessOfFit entities and all the depending Chart entities.
Required Arguments
The following example shows how to delete existing GoodnessOfFit.
container = system1.GetContainer(ComponentName="Response Surface")
model = container.GetModel()
gof1 = model.GetGoodnessOfFit(Name="GOF 1")
gof5 = model.GetGoodnessOfFit(Name="GOF 5")
gof6 = model.GetGoodnessOfFit(Name="GOF 6")
model.DeleteGoodnessOfFit(GoodnessOfFit=[gof1, gof5, gof6])
Deletes a list of ResponsePoint entities and all the depending Chart entities.
Required Arguments
The following example shows how to delete existing ResponsePoints.
container = system1.GetContainer(ComponentName="Response Surface")
model = container.GetModel()
rp1 = model.GetResponsePoint(Name="Response Point 1")
rp5 = model.GetResponsePoint(Name="Response Point 5")
rp6 = model.GetResponsePoint(Name="Response Point 6")
model.DeleteResponsePoints(ResponsePoints=[rp1, rp5, rp6])
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.
Required Arguments
Optional Arguments
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()
Duplicates a GoodnessOfFit.
Return
The created entity.
Required Arguments
Optional Arguments
The following example shows how to duplicate a GoodnessOfFit from an existing ResponseSurface model. The code retrieves the parameters P1 and P2 and then creates the response point by assigning a value to each of these parameters.
container = system1.GetContainer(ComponentName="Response Surface")
responseSurfaceModel1 = container.GetModel()
gof = responseSurfaceModel1.GetGoodnessOfFit(Name="GoodnessOfFit")
goodnessOfFit2 = model.DuplicateGoodnessOfFit(GoodnessOfFit=gof, DisplayText="GOF2")
goodnessOfFit2.Update()
Duplicates a ReponsePoint entity. The response point must be updated once after its creation by invoking its Update method. Then changes to its properties will update the response point automatically.
Return
The created entity.
Required Arguments
Optional Arguments
The following example shows how to duplicate a response point and all its charts.
responseSurface1 = system1.GetContainer(ComponentName="Response Surface")
responseSurfaceModel1 = responseSurface1.GetModel()
responsePoint1 = responseSurfaceModel1.GetResponsePoint(Name="ResponsePoint")
responsePoint2 = responseSurfaceModel1.DuplicateResponsePoint(ResponsePoint=responsePoint1,DuplicateCharts=True)
responsePoint2.Update()
Query to return the chart reference for a given model and chart name.
Return
The DataReference of the chart.
Required Arguments
Get the DataReference of a GoodnessOfFit entity associated with a Model. An exception is thrown if the entity is not found.
Return
The DataReference of the GoodnessOfFit.
Required Arguments
The following example shows how the user can get a GoodnessOfFit.
system1 = GetSystem(Name="RSO")
responseSurface1 = system1.GetContainer(ComponentName="Response Surface")
responseSurfaceModel1 = responseSurface1.GetModel()
gof = responseSurfaceModel1.GetGoodnessOfFit(Name="GoodnessOfFit")
Get the DataReferences of the GoodnessOfFit entities associated with a Model.
Return
The DataReferences of the GoodnessOfFits.
The following example shows how to retrieve the GoodnessOfFit entities of a response surface model.
system1 = GetSystem(Name="RSO")
responseSurface1 = system1.GetContainer(ComponentName="Response Surface")
responseSurfaceModel1 = responseSurface1.GetModel()
gof = responseSurfaceModel1.GetGoodnessOfFits()
Get the DataReference of the MinMaxSearch entity associated with a Response Surface model. An exception is thrown if the entity is not found.
Return
The DataReference of the MinMaxSearch entity.
The following example shows how the user can get the MinMaxSearch of a ResponseSurfaceModel to change one of its properties.
responseSurface1 = system1.GetContainer(ComponentName="Response Surface")
responseSurfaceModel1 = responseSurface1.GetModel()
minMaxSearch1 = responseSurfaceModel1.GetMinMaxSearch()
minMaxSearch1.NumberInitialPoints = 200
Get the DataReference of a Parameter. An exception is thrown if the entity is not found.
Return
The DataReference of the Parameter.
Required Arguments
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
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
Optional Arguments
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()
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
Required Arguments
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")
Get the DataReference of a ResponsePoint. An exception is thrown if the entity is not found.
Return
The DataReference of the ResponsePoint.
Required Arguments
The following example shows how to retrieve an existing ResponsePoint.
container = system1.GetContainer(ComponentName="Response Surface")
model = container.GetModel()
rp = model.GetResponsePoint(Name="Response Point 1")
Get the DataReferences of the ResponsePoints.
Return
The DataReferences of the ResponsePoints
The following example shows how to retrieve the response points of a response surface model.
system1 = GetSystem(Name="RSO")
container = system1.GetContainer(ComponentName="Response Surface")
model = container.GetModel()
responsePoints = model.GetResponsePoints()
Import Refinement Point values in the manual refinement table of a Response Surface model from a csv file.
Required Arguments
The following example shows how the user can import refinement points from a valid csv file.
container = system1.GetContainer(ComponentName="Response Surface")
model = container.GetModel()
model.ImportRefinementPointsFromFile(FilePath="designs.csv")
Import Verification Point values in the verification table of a Response Surface model from a csv file.
Required Arguments
The following example shows how the user can import verification points from a valid csv file.
container = system1.GetContainer(ComponentName="Response Surface")
model = container.GetModel()
model.ImportVerificationPointsFromFile(FilePath="designs.csv")
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.
The following example shows how to preview a DOE model.
container = system1.GetContainer(ComponentName="Design of Experiment")
model = container.GetModel()
DOEMatrix = model.PreviewDesignPoints()