mbcdoe.candidateset

Properties and methods for design of experiment (doe) candidate set objects

expand all in page

Description

Use these properties and object functions to create and examine doe candidate set objects.

A mbcdoe.candidateset object represents the candidate set of all possible points for use in an optimal design. CandidateSet is a property of optimal design generators.

Creation

Create a mbcdoe.candidateset object using CreateCandidateSet.

Properties

expand all

Candidate set type, specified as an array.

C.Type returns the candidate set type. You can only choose a type when you create the candidate set using CreateCandidateSet.

The candidate set type determines which properties you can set.

To get a list of types to use as alternative designs for the current design using getAlternativeTypes, enter this command. C is an mbcdoe.candidateset object.

Clist = getAlternativeTypes(C)

To use the alternative designs, the candidate set must be one shown in the following table.

Candidate Set Properties (for Optimal Designs)

Candidate Set TypePropertyDescription
All built-in: Grid/ Lattice, Grid, Lattice, Stratified Lattice, Sobol, HaltonNumberOfPoints (read-only for Grid and Grid/Lattice)Number of points (int: [0,Inf])
LimitsDesign Limits
GridLevelsSelection criteria for best LHS design (cell)
NumberPerLevelSymmetric design (vector int: {[-Inf,Inf], NumInputs})
LatticeGeneratorsPrime number generators for lattice (vector int: {[0,Inf], NumInputs})
Stratified LatticeStratifyLevels Number of levels for each factors (vector int: {[0,Inf], NumInputs})
Sobol SequenceScrambleScramble method (enum:
{‘none’,
’MatousekAffineOwen’}
SkipModeSkip mode options (enum: {'None','2^k','Custom'})
SkipSkip size (int: [0,Inf])
Halton SequenceScramble Scrambling method for sequence (enum: {'None','RR2'})
PrimeLeapLeap sequence points using prime number (boolean)
SkipZeroSkip zero point (boolean)
User-definedNumberOfPointsUser-defined points (read-only)
PointsUser-defined points

Data Types: char | string

Object Functions

getAlternativeTypesAlternative model or design types

Examples

collapse all

You can use property value pairs to specify candidate set properties as part of the CreateCandidateSet command, or you can set properties individually.

To create a candidate set with type grid and specified grid levels:

CandidateSet = augmentedDesign.CreateCandidateSet...
( 'Type', 'Grid' );
CandidateSet.NumberOfLevels = [21 21 21 21];

Version History

Introduced in R2008a

See Also

Topics