DX Six Sigma Analysis
This container holds data for a Six Sigma Analysis.
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"
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
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 performs and manages the Six Sigma Analysis 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.
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()
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])
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()
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 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")