mbcboundary.Model

Boundary model class

expand all in page

    Description

    The mbcboundary.Model class represents the basic boundary model types in the Model-Based Calibration Toolbox™ software. The mbcboundary.Model class is a subclass of the mbcboundary.AbstractBoundary class. The mbcboundary.AbstractBoundary class is the base class for all boundary model classes in the Model-Based Calibration Toolbox software.

    Creation

    You can fit boundary models in mbcmodel projects using the boundary tree class mbcboundary.Tree, or you can fit boundary models directly to data.

    You can combine boundary models using the logical operators &, |, and ~.

    Properties

    expand all

    Active boundary model inputs, specified as a logical row vector.

    Note

    Each input must have one element.

    Example: To make a boundary model using only the first two inputs: 

    B.ActiveInputs = [true true false false];

    Fit algorithm for model or boundary model, specified as an mbcmodel.FitAlgorithm object.

    An mbcmodel.FitAlgorithm object is contained within the FitAlgorithm property of an mbcmodel.model object or mbcboundary.Model object.

    Parameters available to modify a boundary model fit vary depending on the boundary type selected. See Editing Boundary Model Fit Options for more information.

    This property is read-only.

    Whether boundary is fitted, specified as logical 0 or logical 1.

    B.Fitted indicates whether boundary model B has been fitted. You cannot evaluate the boundary model unless Fitted equals logical 1.

    Data Types: logical

    This property is read-only.

    Boundary model input, specified as an mbcmodel.modelinput object.

    For mbcboundary.Model objects, this property returns an mbcmodel.modelinput object. You cannot edit this object when it is attached to a boundary tree. You cannot change the number of inputs after creation.

    This property is read-only.

    Boundary model object name, specified as a character vector. Names of boundary models are read-only and provide a description of the boundary model type and active inputs.

    This property is read-only.

    Number of boundary model object inputs, specified as a real positive scalar.

    Object Functions

    CreateBoundaryCreate boundary model
    EvaluateEvaluate model, boundary model, or design constraint
    designconstraintConvert boundary model to design constraint
    fitFit model or boundary model to new or existing data, and provide summary statistics
    getAlternativeTypesAlternative model or design types

    Examples

    collapse all

    1. Open a project with a test plan.

      proj = mbcmodel.LoadProject(fullfile(mbcpath,'mbctraining','gasolineOneStage.mat'));
testPlan = proj.Testplans(2);
tree = testPlan.Boundary
      tree = 
  Tree with properties:

         Data: [143×4 double]
       Models: {[1×1 mbcboundary.Model]}
    BestModel: [1×1 mbcboundary.Model]
       InBest: 1
     TestPlan: [1×1 mbcmodel.testplan]

    2. Create a convex hull boundary model. Use the third and fourth inputs, load and speed.

      boundaryModel = CreateBoundary(tree,'Convex hull','ActiveInputs',[false false true true])
      boundaryModel = 
  Model with properties:

    ActiveInputs: [0 0 1 1]
            Name: 'ConvexHull(LOAD,Speed; 0 faces)'
       NumInputs: 4
            Type: 'Convex hull'
          Inputs: [4×1 mbcmodel.modelinput]
    FitAlgorithm: [1×1 mbcmodel.fitalgorithm]

    3. Use Add or Update to add the boundary model to the boundary tree.

      boundaryModel = Add(tree,boundaryModel);

    Version History

    Introduced in R2009b

    See Also

    | | | | |