LocalModel Properties - Edit local model properties

Syntax

Props = localmodel.Properties

Description

This is a property of the mbcmodel.localmodel object, which is a subclass of mbcmodel.model.

See Understanding Model Structure for an explanation of the relationship between the different response types.

Every local model object has an mbcmodel.modelproperties object (within the Properties property). In this object, each local model type has specific properties, as described in the following tables.

Local Polynomial Properties

PropertyDescription
OrderPolynomial order (vector int: {[0,Inf],2})
InteractionOrderMaximum order of interaction terms (int: [0,Inf])
TransformInputRange Transform inputs (Boolean)
ParameterNamesList of parameter names (read-only)
StepwiseStatusStepwise status {'Always','Never','Step'} (cell)
TransformTransform function (char) or empty ('')
CovarianceModelCovariance Model

(enum: {'None','Power',
'Exponential','Mixed'}
)

CorrelationModelCorrelation Model (enum: {'None','MA(1)','AR(1)',
'AR(2)'}
)

Local Hybrid Spline Properties

PropertyDescription
OrderSpline and polynomial order (vector int: {[0,3],2})
SplineVariableSpline variable
SplineInteractionOrder of interaction between spline and polynomial (int: [0,3])
Knots: Position of knots (vector real) ParameterNames: List of parameter names (read-only)
StepwiseStatusStepwise status {'Always','Never','Step'} (cell)
TransformTransform function (char) or empty ('')
CovarianceModelCovariance Model

(enum: {'None','Power',
'Exponential','Mixed'}
)

CorrelationModelCorrelation Model (enum: {'None','MA(1)','AR(1)',
'AR(2)'}
)

Local Polynomial Spline Properties

PropertyDescription
HighOrderPolynomial order above knot (int: [2,Inf])
LowOrderPolynomial order below knot (int: [2,Inf])
TransformTransform function (char) or empty ('')
CovarianceModelCovariance Model

(enum: {'None','Power',
'Exponential','Mixed'}
)

CorrelationModelCorrelation Model (enum: {'None','MA(1)','AR(1)',
'AR(2)'}
)
DatumTypeDatum Type (enum: {'None','Maximum','Minimum',
'Linked'}
)

Local Polynomial With Datum Properties

PropertyDescription
OrderPolynomial order (int: [0,Inf])
TransformTransform function (char) or empty ('')
CovarianceModelCovariance Model

(enum: {'None','Power',
'Exponential','Mixed'}
)

CorrelationModelCorrelation Model (enum: {'None','MA(1)','AR(1)',
'AR(2)'}
)
DatumTypeDatum Type (enum: {'None','Maximum','Minimum',
'Linked'})

Local Free Knot Spline Properties

PropertyDescription
OrderSpline Order (int: [0,Inf])
NumKnots Number of knots (int: 'Positive')
TransformTransform function (char) or empty ('')
CovarianceModelCovariance Model

(enum: {'None','Power',
'Exponential','Mixed'}
)

CorrelationModelCorrelation Model (enum: {'None','MA(1)','AR(1)',
'AR(2)'}
)

Local Truncated Power Series Properties

PropertyDescription
OrderPolynomial order (int: 'Positive')
NumKnotsNumber of knots (int: 'Positive')
TransformTransform function (char) or empty ('')
CovarianceModelCovariance Model

(enum: {'None','Power',
'Exponential','Mixed'}
)

CorrelationModelCorrelation Model (enum: {'None','MA(1)','AR(1)',
'AR(2)'}
)

Local Growth Properties

PropertyDescription
ModelGrowth model (enum: {'expgrowth','gomp',
'logistic','logistic4',
'mmf','richards',
'weibul'}
)
AlternativeModelsList of growth models (read-only)
TransformTransform function (char) or empty ('')
TransformBothSidesTransform both sides (Boolean)
CovarianceModelCovariance Model

(enum: {'None','Power',
'Exponential','Mixed'}
)

CorrelationModelCorrelation Model (enum: {'None','MA(1)','AR(1)',
'AR(2)'}
)

Local User-Defined Properties

PropertyDescription
ModelName of user-defined model (enum: {'exponential'})
AlternativeModelsList of registered user-defined models (read-only)
TransformTransform function (char) or empty ('')
TransformBothSidesTransform both sides (Boolean)
CovarianceModelCovariance Model

(enum: {'None','Power',
'Exponential','Mixed'}
)

CorrelationModelCorrelation Model (enum: {'None','MA(1)','AR(1)',
'AR(2)'}
)

Local Transient Properties

PropertyDescription
ModelName of transient model (enum: {'fuelPuddle'})
AlternativeModelsList of registered transient models (read-only)
Transform Transform function (char) or empty ('')
TransformBothSidesTransform both sides (Boolean)
CovarianceModelCovariance Model

(enum: {'None','Power',
'Exponential','Mixed'}
)

CorrelationModelCorrelation Model (enum: {'None','MA(1)','AR(1)',
'AR(2)'}
)

Local Multiple Models Properties

PropertyDescription
ModelCandidatesList of candidate models (cell)
SelectionStatisticSelection statistic for automatic model selection (char)
AutomaticInputRangesUse data range as model input ranges (Boolean)
TransformTransform function (char) or empty ('')

Local Average Fit Properties

PropertyDescription
Model[1x1 mbcmodel.linearmodel]
TransformTransform function (char) or empty ('')

Examples

To create a local model object, create a model specifying any model Type that begins with the word "local", e.g.,

L = mbcmodel.CreateModel('Local Polynomial',2);

To show properties, at the command line enter:

P = L.Properties

P = 
Local Polynomial Properties
                  Order: [3 3]
       InteractionOrder: 3
    TransformInputRange: 1
         ParameterNames: {10x1 cell}
         StepwiseStatus: {10x1 cell}
              Transform: ''
        CovarianceModel: 'None'
       CorrelationModel: 'None'

To set the Order property to a quadratic, enter:

>> P.Order = [2,2]
 
P = 
Local Polynomial Properties
                  Order: [2 2]
       InteractionOrder: 2
    TransformInputRange: 1
         ParameterNames: {6x1 cell}
         StepwiseStatus: {6x1 cell}
              Transform: ''
        CovarianceModel: 'None'
       CorrelationModel: 'None'

 

To update the local model, the properties object must be reassigned to the model as follows:

>> L.Properties = P
 
L =
 
   1 + 2*X1 + 5*X2 + 3*X1^2 + 4*X1*X2 + 6*X2^2
   InputData: [0x2 double]
   OutputData: [0x1 double]
   Status: Being Edited
   Linked to Response: not linked

See Also

CreateModel, Type (for models), ResponseFeatures(Local Model)

  


 © 1984-2009- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS