mbcmodel.linearmodelproperties

Properties and methods for linear model property objects

Description

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

Creation

Syntax

MLPropObj = ModelObj.Properties

ModelObj.Properties.LinearPropertyName = NewValue

Description

MLPropObj = ModelObj.Properties creates an mbcmodel.linearmodelproperties object for the model object ModelObj.

ModelObj.Properties.LinearPropertyName = NewValue changes the ModelObj linear property name LinearPropertyName to the new value NewValue.

Properties

Every mbcmodel.linearmodel model object has an mbcmodel.linearmodelproperties object. In the mbcmodel.linearmodelproperties object, each model type has specific properties.

These tables provide the properties available for each model type.

Linear Models – Polynomial

Property	Description	Values
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)	Not applicable
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

Property	Description	Values
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	Not applicable
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)	Not applicable
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

Property	Description	Values
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)	Not applicable
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

Property	Description	Values
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)	Not applicable
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

Property	Description	Values
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	Not applicable
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)	Not applicable
StepwiseStatus	Stepwise status	Cell containing one of these values: 'Always' 'Never' 'Step'
BoxCox	Box-Cox transform (power)	Numeric number between -3 and 3, inclusive

Type — Type of model objects

vector

This property is read-only.

The model type must be one in this table.

Note

Spaces and case in model Type are ignored.

Type	Model Object
Polynomial	mbcmodel.linearmodel
Hybrid Spline	mbcmodel.linearmodel
RBF	mbcmodel.linearmodel
Hybrid RBF	mbcmodel.linearmodel
Polynomial-RBF	mbcmodel.linearmodel
Hybrid Spline-RBF	mbcmodel.linearmodel
Gaussian Process	mbcmodel.model
Free Knot Spline	mbcmodel.model
Transient	mbcmodel.model
User-Defined	mbcmodel.model
Neural Network	mbcmodel.model
Interpolating RBF	mbcmodel.model
Local Polynomial Spline	mbcmodel.localmodel
Local Polynomial with Datum	mbcmodel.localmodel
Local Polynomial	mbcmodel.localmodel
Local Hybrid Spline	mbcmodel.localmodel
Local Truncated Power Series	mbcmodel.localmodel
Local Free Knot Spline	mbcmodel.localmodel
Local Multiple Models	mbcmodel.localmodel
Local Growth	mbcmodel.localmodel
Local User-Defined	mbcmodel.localmodel
Local Transient	mbcmodel.localmodel

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

Mlist = getAlternativeTypes(M)

In this syntax, M is an mbcmodel.model object.

Data Types: char | string

NumInputs — Number of inputs to model

real positive scalar

This property is read-only.

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

Data Types: double | single

Object Functions

GetAllTerms	List all model terms
GetIncludedTerms	List included model terms
GetTermLabel	List labels for model terms
GetTermStatus	List status of some or all model terms
SetTermStatus	Set status of model terms

Version History

Introduced before R2006a