CreateCandidateSet

Create candidate set for optimal designs

Syntax

DoeObjMod = CreateCandidateSet(DoeObj)

DoeObjMod = CreateCandidateSet(DoeObj,'Name1','Value1',…)

Description

DoeObjMod = CreateCandidateSet(DoeObj) creates a candidate set object for the design.

Use ConstrainedGenerate to create a candidate set for optimal designs. Candidate sets are similar to design generators. The software does not use a candidate set to specify a design. Instead, candidate sets specify the set of all possible points to consider as part of an optimal design.

DoeObjMod = CreateCandidateSet(DoeObj,'Name1','Value1',…) creates a candidate set object for the design with the options specified by the name-value pairs.

Examples

Create Candidate Set

mdl = CreateModel(mbcmodel,'Polynomial',4)
ActualDesign = CreateDesign(mdl,'Type','V-optimal')

c = CreateCandidateSet(ActualDesign,'Type','Grid')
c.NumberOfLevels = [11 11 11 11];

ActualDesign = Generate(ActualDesign,'NumberOfPoints',50,'CandidateSet',c)

Input Arguments

DoeObj — Instance of mbcdoe.design class

mbcdoe.design object

Instance of mbcdoe.design class, specified as a mbcdoe.design doe design object.

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'Type','Grid'

The design candidate properties determines the applicable name-value pairs. This table provides a complete list of the properties.

Candidate Set Properties (for Optimal Designs)

Candidate Set Type	Property	Description
All built-in: Grid/ Lattice, Grid, Lattice, Stratified Lattice, Sobol, Halton	NumberOfPoints (read-only for Grid and Grid/Lattice)	Number of points (int: [0,Inf])
	Limits	Design Limits
Grid	Levels	Selection criteria for best LHS design (cell)
	NumberPerLevel	Symmetric design (vector int: {[-Inf,Inf], NumInputs})
Lattice	Generators	Prime number generators for lattice (vector int: {[0,Inf], NumInputs})
Stratified Lattice	StratifyLevels	Number of levels for each factors (vector int: {[0,Inf], NumInputs})
Sobol Sequence	Scramble	Scramble method (enum: {‘none’, ’MatousekAffineOwen’}
	SkipMode	Skip mode options (enum: {'None','2^k','Custom'})
	Skip	Skip size (int: [0,Inf])
Halton Sequence	Scramble	Scrambling method for sequence (enum: {'None','RR2'})
	PrimeLeap	Leap sequence points using prime number (boolean)
	SkipZero	Skip zero point (boolean)
User-defined	NumberOfPoints	User-defined points (read-only)
	Points	User-defined points

Type — Generator type

character vector

Generator type, specified as the comma-separated pair consisting of 'Type' and a character vector.

Example: 'Type','V-optimal'

Output Arguments

DoeObjMod — Modified instance of mbcdoe.design class

mbcdoe.design object

Modified instance of mbcdoe.design class, returned as a mbcdoe.design object.

Version History

Introduced in R2008a