DX Direct Optimization
This container holds data for an instance of Parameter Direct 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 performs and manages the DesignXplorer Optimization Method 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.
Maximum number of permutations for discrete / manufacturable values.
Entity which performs and manages the DesignXplorer Optimization Method 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.
Maximum number of permutations for discrete / manufacturable values.
Maximun Number of Domain Reduction per Iteration
Number of Screening Samples for the Adaptive Single-Objective optimization method.
Number of Starting Points for the Adaptive Single-Objective optimization method.
Entity which wraps and manages the external Parameter Definition for the Optimization Criterion with an external Optimization Method
No Properties.
Entity which wraps and manages the external Objective Definition for the Optimization Criterion with an external Optimization Method
No Properties.
Entity which wraps and manages the external Parameter Definition for the Input Parameter with an external Optimization Method
No Properties.
The data entity which describes a Discrete Level of an Input Parameter.
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.
Zero-based Index of the discrete level in the list of levels of the owning parameter.
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
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" )
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
Entity which performs and manages the DesignXplorer Optimization Method Component
DerivativeApproximationType
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.
Maximum number of permutations for discrete / manufacturable values.
Entity which performs and manages the DesignXplorer Optimization Method 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.
Maximum number of permutations for discrete / manufacturable values.
Entity which performs and manages the DesignXplorer Optimization Method Component
DerivativeApproximationType
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.
Maximum number of permutations for discrete / manufacturable values.
The data entity which describes the objective and constraint associated with a Parameter for an Optimization Study.
Allowed Values Type of parameter if Parameter is a continuous input parameter.
Constraint First Value used when ConstraintType is eGI_LessThanTarget, eGI_GreaterThanTarget, eGI_NearTarget or eGI_InsideBounds.
Importance of the constraint when multiple objectives are defined.
Constraint Second Value used when ConstraintType is eGI_InsideBounds.
List of custom constraint definitions.
List of custom objective definitions.
Grid Interval of the parameter if Parameter is a continuous input parameter and the allowed values type is Span To Grid.
Lower Bound of the variation range if Parameter is an input parameter.
Importance of the objective when multiple objectives are defined.
The value of the parameter in the starting point if Parameter is an input parameter and the optimization method uses a starting point.
Upper Bound of the variation range if Parameter is an input parameter.
Get the DataReference of the HistoryChart associated with an OptimizationCriterion. An exception is thrown if the entity is not found.
Return
The DataReference of the OptimizationCriterion.
The following example shows how the user can get a HistoryChart to export its data as .csv file.
system = GetSystem(Name="RSO")
optimization = system.GetContainer(ComponentName="Optimization")
optimizationModel = optimization.GetModel()
parameter = optimizationModel.GetParameter(Name="P3")
criterion = parameter.GetOptimizationCriterion()
historyChart = criterion.GetChart()
historyChart.ExportData(FileName="D:/Temp/HistoryChart.csv")
Get the DataReference of a CustomConstraintProperties entity associated with an Optimization Criterion. An exception is thrown if the entity is not found.
Return
The DataReference of the CustomConstraintProperties.
Required Arguments
The following example shows how the user can get a CustomConstraintProperties.
system1 = GetSystem(Name="DOP")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
outputParameter1 = optimizationModel1.GetParameter(Name="P4")
optimizationCriterion1 = outputParameter1.CreateOptimizationCriterion()
customConstraintDefinition1 = optimizationCriterion1.GetCustomConstraintDefinition(ExtensionName="CommonConstraintDefinition@PythonOptimizer")
customConstraintDefinition1.FeasibleTolerance = 0.02
Get the DataReference of a CustomObjectiveProperties entity associated with an Optimization Criterion. An exception is thrown if the entity is not found.
Return
The DataReference of the CustomObjectiveProperties.
Required Arguments
The following example shows how the user can get a CustomObjectiveProperties.
system1 = GetSystem(Name="DOP")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
outputParameter1 = optimizationModel1.GetParameter(Name="P4")
optimizationCriterion1 = outputParameter1.CreateOptimizationCriterion()
customObjectiveDefinition1 = optimizationCriterion1.GetCustomObjectiveDefinition(ExtensionName="CommonObjectiveDefinition@PythonOptimizer")
customObjectiveDefinition1.RelativeObjectiveWeight = 0.9
Entity which wraps and manages the external Optimization Method for the Optimization component
No Properties.
Entity which performs and manages the DesignXplorer Optimization 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 and PreserveDesignPoints is True as well, export project for each preserved Design Point.
Indicates the number of times DX will try to update the failed design points.
If True, preserve the Design Points at the project level after the component Update.
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.
If True, verifies the candidates by a design points update.
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 custom candidate point. The Expressions dictionary can be used to specify a value or a quantity for some or all of the input parameters. In the context of a response surface based optimization, the output values are evaluated from the response surface.
Return
The created entity.
Optional Arguments
The following example shows how to create a CustomCandidatePoint entity on an Optimization model based on a ResponseSurface.
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
inputParameter1 = model.GetParameter(Name="P1")
inputParameter2 = model.GetParameter(Name="P2")
customCandidatePoint = model.CreateCustomCandidatePoint( DisplayText="Existing Design",
Expressions={inputParameter1: "2.01", inputParameter2: "15.5"})
Creates a Parameter Relationship
Return
The DataReference of the ParameterRelationship.
Optional Arguments
The following example shows how to create an ParameterRelationship entity.
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
parameterRelationship = model.CreateParameterRelationship(LeftExpression="P1+P2",RightExpression="P3",Type="PRT_LessThanOrEqualTo")
parameterRelationship2 = model.CreateParameterRelationship(LeftExpression="P4+P5",RightExpression="10[inch]",Type="PRT_GreaterThanOrEqualTo")
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 CustomCandidatePoint entities.
Required Arguments
The following example shows how to delete existing CustomCandidatePoint entities from an optimization model.
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
customCandidatePoint1 = model.GetCustomCandidatePoint(Name="CustomCandidatePoint 1")
customCandidatePoint2 = model.GetCustomCandidatePoint(Name="CustomCandidatePoint 2")
model.DeleteCustomCandidatePoints(CustomCandidatePoints=[customCandidatePoint1, customCandidatePoint2])
Deletes a list of OptimizationCriterion entities.
Required Arguments
The following example shows how to delete existing OptimizationCriterion entities.
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
parameter1 = model.GetParameter(Name="P1")
optimizationCriterion1 = parameter1.GetOptimizationCriterion()
parameter3 = model.GetParameter(Name="P3")
optimizationCriterion3 = parameter3.GetOptimizationCriterion()
model.DeleteOptimizationCriteria(OptimizationCriteria=[optimizationCriterion1, optimizationCriterion3])
Deletes a list of ParameterRelationship entities.
Required Arguments
The following example shows how to delete existing ParameterRelationships.
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
pr1 = model.GetParameterRelationship(Name="ParameterRelationShip 1")
pr2 = model.GetParameterRelationship(Name="ParameterRelationShip 2")
pr3 = model.GetParameterRelationship(Name="ParameterRelationShip 3")
model.DeleteParameterRelationships(ParameterRelationships=[pr1, pr2, pr3])
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()
Export the data of model's entities to a csv file. These entities can be candidate points, custom candidate points, charts, parametric tables or input parameters.
Required Arguments
Optional Arguments
The following example shows how the user can export the candidate points of an optimization component.
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidates = model.GetCandidatePoints()
model.ExportData(FileName="doe.csv", Entities=candidates)
Get the DataReference of a CandidatePoint entity. An exception is thrown if the entity is not found.
Return
The DataReference of the CandidatePoint entity.
Required Arguments
The following example shows how to retrieve an existing CandidatePoint entity.
system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidatePoint = model.GetCandidatePoint(Name="CandidatePoint 1")
Get the DataReferenceSet of all of the existing CandidatePoint entities on the model.
Return
The DataReferenceSet of the CandidatePoint entities.
The following example shows how to retrieve the candidate points of an optimization model.
system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidatePoints = model.GetCandidatePoints()
Query to return the chart reference for a given model and chart name.
Return
The DataReference of the chart.
Required Arguments
Query to return the chart reference for a given model and chart name.
Return
The DataReference of the chart.
Get the DataReference of a CustomCandidatePoint entity. An exception is thrown if the entity is not found.
Return
The DataReference of the CustomCandidatePoint entity.
Required Arguments
The following example shows how to retrieve an existing CustomCandidatePoint entity.
system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
customCandidatePoint = model.GetCustomCandidatePoint(Name="CustomCandidatePoint 1")
Get the DataReferenceSet of all of the existing CustomCandidatePoint entities of the model.
Return
The DataReferenceSet of the CustomCandidatePoint entities.
The following example shows how to retrieve the custom candidate points of an optimization model.
system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
customCandidatePoints = model.GetCustomCandidatePoints()
Get the DataReferenceSet of all of the existing OptimizationCriterion entities of the model.
Return
The DataReference of the OptimizationCriterion entities.
Required Arguments
The following example shows how to retrieve the objectives of an optimization model, as a set of OptimizationCriterion entities.
system1 = GetSystem(Name="DOP")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
criteria = model.GetOptimizationCriteria()
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 DataReference of a ParameterRelationship entity. An exception is thrown if the entity is not found.
Return
The DataReference of the ParameterRelationship entity.
Required Arguments
The following example shows how the user can retrieve an existing ParameterRelationship entity.
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
parameterRelationship = model.GetParameterRelationship(Name="ParameterRelationShip 1")
Get the Parameter Relationships associated to a Model. If the optional argument Enabled is not specified, the query returns all Parameter Relationships. If it is specified and True, the query returns only enabled Parameter Relationships. If it is False, the query returns only disabled Parameter Relationships.
Return
The DataReferenceSet of the ParameterRelationship entities.
Optional Arguments
The following example shows how the user can retrieve all the Parameter Relationships defined on a model.
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
allParameterRelationships = model.GetParameterRelationships()
enabledParameterRelationships = model.GetParameterRelationships(Enabled="True")
disabledParameterRelationships = model.GetParameterRelationships(Enabled="False")
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")
Sets a point as the reference to calculate the variation of the parameters in each of the candidate and custom candidate points of the container. The variation is calculated by the command and can be retrieved for each parameter of each point.
Required Arguments
Optional Arguments
The following example shows how to set a custom candidate point as the reference and how to retrieve the calculated variation on the parameters of a second candidate point.
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
customCandidatePoint = model.GetCustomCandidatePoint(Name="CustomCandidatePoint")
model.SetVariationReferencePoint(Point=customCandidatePoint, Source="Simulation")
bestCandidate = model.GetCandidatePoint(Name="CandidatePoint")
variationOfOutputsAsDecimals = bestCandidate.GetOutputValues(Source="Simulation", ValueType="VariationToReference")
Verify the CandidatePoint entities by performing a design point update to generate Simulation output values, so that they can be compared to the ResponseSurface output values. This command has no effect if the optimization model is used as part of a Direct Optimization system.
Required Arguments
Optional Arguments
The following example shows how the user can verify all the candidate points generated by the optimization model and extract the existing output parameter values from the first candidate point.
system1 = GetSystem(Name="RSO")
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
candidatePoints = model.GetCandidatePoints()
model.VerifyPoints(Points=candidatePoints)
responseSurfaceValues = candidatePoints[0].GetOutputValues(Source="ResponseSurface")
verifiedValues = candidatePoints[0].GetOutputValues(Source="Simulation")
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
Entity which manages the calculated Statistics of a parameter for a Six-Sigma Component
Quantity Name of Left Expression of Parameter Relationship.
Value of the left expression (as a quantity string), or an error message.
Quantity Name of Right Expression of Parameter Relationship.
Value of the right expression (as a quantity string), or an error message.
Duplicates a Parameter Relationship.
Return
The created entity.
Optional Arguments
The following example shows how to duplicate a Parameter Relationship.
container = system1.GetContainer(ComponentName="Optimization")
model = container.GetModel()
pr1 = model.GetParameterRelationship(Name="ParameterRelationShip")
pr2 = pr1.DuplicateParameterRelationship()
container = system1.GetContainer(ComponentName="Optimization 1")
model2 = container.GetModel()
pr3 = pr1.DuplicateParameterRelationship(TargetModel = model2)
Get the DataReference of the ParameterRelationshipChart associated with a ParameterRelationship. An exception is thrown if the entity is not found.
Return
The DataReference of the ParameterRelationshipChart.
The following example shows how the user can get a ParameterRelationshipChart to export its data as .csv file.
system1 = GetSystem(Name="RSO")
optimization1 = system1.GetContainer(ComponentName="Optimization")
optimizationModel1 = optimization1.GetModel()
parameterRelationship1 = optimizationModel1.GetParameterRelationship(Name="ParameterRelationship")
chart1 = parameterRelationship1.GetChart()
Parameters.ExportData(Data=chart1,FileName="E:/Temp/Relationship.csv")
The data entity which describes a ParameterRelationship chart. It allows you to visualize how parameter relationship evolves during the optimization process, depending on the optimizer.
If True, the legend of the chart contains the full name of the parameters. Otherwise it contains the short name such as "P1".
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.
Entity which performs and manages the DesignXplorer Optimization Method 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.
Maximum number of permutations for discrete / manufacturable values.