mbcboundary.PointByPoint

Point-by-point boundary model class

expand all in page

    Description

    The mbcboundary.PointByPoint 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 only create and fit point-by-point boundary models in the local boundary tree in two ways. You can use either a two-stage test plan or an existing boundary of type 'Point-by-point' or 'Two-stage'. You cannot create or fit these types of boundary models outside a project. Fit them by adding the boundary model to the boundary tree.

    A separate boundary model is fitted to each operating point. Point-by-point boundary models are only valid at the observed operating points.

    Properties

    expand all

    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.

    For a point-by-point boundary, a separate boundary is fitted for each operating point in the local model.

    Use the LocalModel property to adjust the boundary model and its fit algorithm. 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.PointByPoint objects, this property returns an mbcmodel.modelinput object. You cannot edit this object when it is attached to a response. You cannot change the number of inputs after creation.

    This property is read-only.

    Local boundary models for each operating point, specified as a cell array.

    Local boundary model definition, specified as a mbcboundary.Model object. B.LocalModel returns the boundary model that fits each operating point. You can modify the FitAlgorithm properties of LocalModel. See mbcboundary.Model for more information.

    Use CreateBoundary to change the local boundary model, for example: 

    b.LocalModel = CreateBoundary(b.LocalModel,'Range')

    Note

    Ellipsoid, Convex hull, and Star-shaped require two inputs. Range only requires one input.

    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.

    Type of boundary model, specified as a character vector. Type is a property of the mbcboundary.AbstractBoundary class and all subclasses.

    B.Type returns the boundary model type.

    Use the getAlternativeTypes method to find out what types are available for the specified boundary model.

    Available types depend on the boundary model.

    • For mbcboundary.TwoStage, the LocalModel requires a type of either Range or Ellipsoid. GlobalModel requires a type of Interpolating RBF only.

    • For mbcboundary.PointByPoint, the LocalModel type can be any valid type for mbcboundary.Model.

    Note

    You can only create boundaries of type 'Point-by-point' or 'Two-stage' from a local boundary tree or from an existing boundary of type 'Point-by-point' or 'Two-stage'. You cannot create or fit these types of boundary models outside of a project. Fit them by adding the boundary model to the boundary tree. See example below.

    This property is read-only.

    Model operating point sites, returned as a matrix of number of operating points by number of inputs.

    Data Types: double

    Object Functions

    CreateBoundaryCreate boundary model
    EvaluateEvaluate model, boundary model, or design constraint
    designconstraintConvert boundary model to design constraint
    getAlternativeTypesAlternative model or design types

    Examples

    collapse all

    1. Open a project with a test plan.

      proj = mbcmodel.LoadProject(fullfile(mbcpath,'mbctraining','CI_MultiInject_PointByPoint.mat'));
testPlan = proj.Testplans(1);
tree = testPlan.Boundary
      tree = 
  TwoStageTree with properties:

        Local: [1×1 mbcboundary.Tree]
       Global: [1×1 mbcboundary.Tree]
     Response: [1×1 mbcboundary.Tree]
    BestModel: [1×1 mbcboundary.PointByPoint]
       InBest: [1 1 1]
     TestPlan: [1×1 mbcmodel.testplan]

    2. Create a point-by-point local boundary model.

      ptbyptBoundaryModel = CreateBoundary(tree.Local,'Point-by-Point');

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

      You can modify the ptbyptBoundaryModel boundary model properties. However, ptbyptBoundaryModel is not fitted until it is added to the local part of the boundary tree.

      ptbyptBoundaryModel = Add(tree.Local,ptbyptBoundaryModel);

    4. Extract the local boundary at the eleventh operating point using LocalBoundaries property.

      localBoundary = ptbyptBoundaryModel.LocalBoundaries{11}
      localBoundary = 
  Model with properties:

    ActiveInputs: [1 1 1 1 1 1]
            Name: 'ConvexHull(MAINSOI,PILOTDELTASOI,PILOTFMF,FUELPRESSDELTA,EGRPOS,VGTPOS; 4401 faces)'
       NumInputs: 6
            Type: 'Convex hull'
          Inputs: [6×1 mbcmodel.modelinput]
    FitAlgorithm: [1×1 mbcmodel.fitalgorithm]

    Version History

    Introduced in R2009b

    See Also

    | | | | | |