mbcmodel.linearmodel

Properties and methods for linear model objects

expand all in page

    Description

    Use these properties and object functions to create and examine model objects.

    Creation

    Create a mbcmodel.linearmodel object using CreateModel.

    Properties

    expand all

    Data stored in model, returned as an array.

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

    FitAlgorithm is a property of mbcmodel.model and of boundary model objects mbcboundary.AbstractBoundary and all subclasses.

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

    As an alternative to using CreateAlgorithm, you can assign the algorithm name directly to the algorithm.

    B.FitAlgorithm.BoundaryPointOptions = 'Boundary Only';
    m.FitAlgorithm = 'Minimize PRESS';
    Case and spaces are ignored.

    To get a fitalgorithm object, F, from a model, use this code.

    M = mbcmodel.CreateModel('Polynomial', 4);
F = M.FitAlgorithm
    F = 
Algorithm: Least Squares
Alternatives: 'Minimize PRESS','Forward Selection','Backward 
Selection','Prune'
1x1 struct array with no fields.

    This property is read-only.

    Input training data, specified as a matrix. InputData is specified when calling fit.

    Data Types: double

    Model input, specified as an mbcmodel.modelinput object.

    This property is read-only.

    Boolean indicating whether model is being edited, specified as either true (1) or false (0).

    Example: 0

    Data Types: logical

    This property is read-only.

    Boolean signaling if model is editable, specified as either true (1) or false (0). The following rules apply:

    • If the model was created using mbcmodel.CreateModel and is not Attached to a test plan, it is editable.

    • If the model was created or retrieved from the project and was not Attached to a test plan, it is editable.

    • If the data was Attached to a test plan and was subsequently retrieved from that test plan, it is editable.

    Data Types: logical

    Model object name, specified as a character vector.

    Data Types: char | string

    This property is read-only.

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

    Data Types: double | single

    This property is read-only.

    Output or response data, specified as a matrix. OutputData is specified when calling fit.

    Data Types: double

    This property is read-only.

    Response object in mbcmodel.project object, specified as an object.

    This property is read-only.

    Status of model fit, specified as Not Fitted, Fitted, or Best.

    Data Types: char | string

    This property is read-only.

    Type of model objects to be returned to mbcmodel.project, specified as a vector. model.type returns the model type.

    The model Type determines which properties you can set. To set properties, see mbcmodel.modelproperties and mbcmodel.localmodel.

    Note

    Spaces and case in model Type are ignored.

    The model type must be one in this table.

    TypeModel Object
    Polynomialmbcmodel.linearmodel
    Hybrid Splinembcmodel.linearmodel
    RBFmbcmodel.linearmodel
    Hybrid RBFmbcmodel.linearmodel
    Polynomial-RBFmbcmodel.linearmodel
    Hybrid Spline-RBFmbcmodel.linearmodel

    You can get a list of types by using getAlternativeTypes. Use this syntax.

    Mlist = getAlternativeTypes(M)

    where M is an mbcmodel.model object.

    Data Types: char | string

    View and edit model properties, returned as a mbcmodel.modelproperties object.

    Each model type has specific properties.

    Linear Models – Polynomial

    PropertyDescriptionValues

    Order

    Polynomial order

    n-by-1 vector of integers greater than or equal to 0, where n is the number of inputs

    InteractionOrder

    Maximum order of interaction terms

    Integer greater than or equal to 0

    TransformInputRange

    Transform inputs

    Boolean

    ParameterNames

    List of parameter names (read-only)

    NA

    StepwiseStatus

    Stepwise status

    Cell containing one of these values:

    • 'Always'

    • 'Never'

    • 'Step'

    BoxCox

    Box-Cox transform (power)

    Numeric number between -3 and 3, inclusive

    Linear Models – Hybrid Spline

    PropertyDescriptionValues

    Order

    Spline and polynomial order vector

    n-by-1 vector of integers greater than or equal to 0 and less than or equal to 3, where n is the number of inputs

    SplineVariable

    Spline variable

    NA

    SplineInteraction

    Order of interaction between spline and polynomial

    Integer greater than or equal to 0 and less than or equal to 3

    Knots

    Position of knots

    Real vector

    ParameterNames

    List of parameter names (read-only)

    NA

    StepwiseStatus

    Stepwise status

    Cell containing one of these values:

    • 'Always'

    • 'Never'

    • 'Step'

    BoxCox

    Box-Cox transform (power)

    Numeric number between -3 and 3, inclusive

    Linear Models – RBF

    PropertyDescriptionValues

    Kernel

    RBF kernel

    String containing one of these enumerated values:

    • 'multiquadric'

    • 'recmultiquadric'

    • 'gaussian'

    • 'thinplate'

    • 'logisticrbf'

    • 'wendland'

    • 'linearrbf'

    • 'cubicrbf'

    Continuity

    Continuity for Wendland kernel

    Integer greater than or equal to 0 and less than or equal to 6

    ParameterNames

    List of parameter names (read-only)

    NA

    StepwiseStatus

    Stepwise status

    Cell containing one of these values:

    • 'Always'

    • 'Never'

    • 'Step'

    BoxCox

    Box-Cox transform (power)

    Numeric number between -3 and 3, inclusive

    Linear Models – Polynomial RBF

    PropertyDescriptionValues

    Order

    		Polynomial order vector

    n-by-1 vector of integers greater than or equal to 0, where n is the number of inputs

    InteractionOrder

    Maximum order of interaction terms

    Integer greater than or equal to 0

    Kernel

    RBF kernel

    String containing one of these enumerated values:

    • 'multiquadric'

    • 'recmultiquadric'

    • 'gaussian'

    • 'thinplate'

    • 'logisticrbf'

    • 'wendland'

    • 'linearrbf'

    • 'cubicrbf'

    Continuity

    Continuity for Wendland kernel

    Integer greater than or equal to 0 and less than or equal to 6

    ParameterNames

    List of parameter names (read-only)

    NA

    StepwiseStatus

    Stepwise status

    Cell containing one of these values:

    • 'Always'

    • 'Never'

    • 'Step'

    BoxCox

    Box-Cox transform (power)

    Numeric number between -3 and 3, inclusive

    Linear Models – Hybrid Spline-RBF

    PropertyDescriptionValues

    Order

    		Spline and polynomial order vector

    n-by-1 vector of integers greater than or equal to 0 and less than or equal to 3, where n is the number of inputs

    SplineVariable

    Spline variable

    NA

    SplineInteraction

    Order of interaction between spline and polynomial

    Integer greater than or equal to 0 and less than or equal to 3

    Knots

    Position of knots

    Real vector

    Kernel

    RBF kernel

    String containing one of these enumerated values:

    • 'multiquadric'

    • 'recmultiquadric'

    • 'gaussian'

    • 'thinplate'

    • 'logisticrbf'

    • 'wendland'

    • 'linearrbf'

    • 'cubicrbf'

    Continuity

    Continuity for Wendland kernel

    Integer greater than or equal to 0 and less than or equal to 6

    ParameterNames

    List of parameter names (read-only)

    NA

    StepwiseStatus

    Stepwise status

    Cell containing one of these values:

    • 'Always'

    • 'Never'

    • 'Step'

    BoxCox

    Box-Cox transform (power)

    Numeric number between -3 and 3, inclusive

    Model output unit, specified as a vector.

    Data Types: double | single

    Object Functions

    AliasMatrixAlias matrix for linear model parameters
    BoxCoxSSESSE and confidence interval for Box-Cox transformations
    CreateDesignCreate design object for test plan or model
    EvaluateEvaluate model, boundary model, or design constraint
    ExportMake command-line or Simulink export model
    fitFit model or boundary model to new or existing data, and provide summary statistics
    InputSetupDialogOpen Input Setup dialog box to edit inputs
    JacobianCalculate Jacobian matrix for model at existing or new data points
    ModelSetupOpen Model Setup dialog box where you can alter model type
    pevPredicted error variance of model at specified inputs
    PredictedValuePredicted value of model at specified inputs
    StatisticsDialogOpen summary statistics dialog box
    SummaryStatisticsSummary statistics for response
    UpdateResponseReplace model in response
    getAlternativeTypesAlternative model or design types
    CorrelationCorrelation matrix for linear model parameters
    CovarianceCovariance matrix for linear model parameters
    ValidationRMSECalculates the validation RMSE for model data
    MultipleVIFMultiple VIF matrix for linear model parameters
    ParameterStatisticsCalculate parameter statistics for linear model
    SingleVIFSingle VIF matrix for linear model parameters
    PartialVIFPartial VIF matrix for linear model parameters
    StepwiseRegressionChange stepwise selection status for specified terms

    Version History

    Introduced before R2006a

    See Also

    | |