Learn more about Model-Based Calibration

Function Reference

Alphabetical List

---

Object Creation Functions to construct data, model and project objects; load projects; and find data file types. Data Manipulation Properties and methods for data objects Projects Properties and methods for project objects Test Plans Properties and methods for test plan objects Designs Properties and methods for design objects Models Properties and methods for model objects Boundary Models Properties and methods for boundary model objects

Back to Top

Object Creation

CreateBoundary	Create boundary model
CreateData	Create data object
CreateModel	Create new model
CreateProject	Create project object
DataFileTypes	Data file types
LoadProject	Load mbcmodel.project
modelinput	Create modelinput object

Back to Top

Data Manipulation

Data Properties Examine data objects Data Methods Work with data objects

Back to Top of Section

Data Properties

Filters	Structure array holding user-defined filters
IsBeingEdited	Boolean signaling if data or model is being edited
IsEditable	Boolean signaling whether data is editable
Name	Name of object
NumberOfRecords	Total number of records in data object
NumberOfTests	Total number of tests being used in model
Owner	Object from which data was received
RecordsPerTest	Number of records in each test
SignalNames	Names of signals held by data
SignalUnits	Names of units in data
TestFilters	Structure array holding user-defined test filters
UserVariables	Structure array holding user-defined variables

Back to Top of Section

Data Methods

AddFilter	Add user-defined filter to data set
AddTestFilter	Add user-defined test filter to data set
AddVariable	Add user-defined variable to data set
Append	Append data to data set
BeginEdit	Begin editing session on data object
CommitEdit	Update temporary changes in data
DefineNumberOfRecordsPerTest	Define exact number of records per test
DefineTestGroups	Define rule-based test groupings
ExportToMBCDataStructure	Export data to MBC data structure
ImportFromFile	Load data from file
ImportFromMBCDataStructure	Load data from MBC data structure
ModifyFilter	Modify user-defined filter in data set
ModifyTestFilter	Modify user-defined test filter in data set
ModifyVariable	Modify user-defined variable in data set
RemoveFilter	Remove user-defined filter from data set
RemoveTestFilter	Remove user-defined test filter from data set
RemoveVariable	Remove user-defined variable from data set
RollbackEdit	Undo most recent changes to data
Value	Double data from data object

Back to Top

Projects

Project Properties Examine project objects Project Methods Work with project objects

Back to Top of Section

Project Properties

Data	Array of data objects in project, boundary tree, or test plan
Filename	Full path to project file
Modified	Boolean signaling whether project has been modified
Name	Name of object
TestPlans	Array of test plan objects in project

Back to Top of Section

Project Methods

CopyData	Create data object from copy of existing object
CreateData	Create data object
CreateTestplan	Create new test plan
Load	Load existing project file
New	Create new project file
Remove	Remove project, test plan, model, or boundary model
RemoveData	Remove data from project
Save	Save project
SaveAs	Save project to new file

Back to Top

Test Plans

Testplan Properties Examine test plan objects Testplan Methods Work with test plan objects

Back to Top of Section

Testplan Properties

BestDesign	Best design in test plan
Boundary	Get boundary model tree from test plan
Data	Array of data objects in project, boundary tree, or test plan
DefaultModels	Default models for test plan
Designs	Designs in test plan
Inputs	Inputs for test plan, model, boundary model, design, or constraint
InputSignalNames	Names of signals in data that are being modeled
InputsPerLevel	Number of inputs at each level in model
Levels	Number of levels in hierarchical model
Name	Name of object
Responses	Array of available responses for test plan

Back to Top of Section

Testplan Methods

AddDesign	Add design to test plan
AttachData	Attach data from project to test plan
BoundaryModel	Get boundary model from test plan
CreateDesign	Create design object for test plan or model
CreateResponse	Create new response model for test plan
DetachData	Detach data from test plan
FindDesign	Find design by name
InputSetupDialog	Open Input Setup dialog box to edit inputs
Remove	Remove project, test plan, model, or boundary model
RemoveDesign	Remove design from test plan
UpdateDesign	Update design in test plan

Back to Top

Designs

Design Properties Examine design objects Design Methods Work with design objects Generator Properties Examine design generator objects Generator Methods Work with design generator objects Candidate Set Properties Examine design candidate set objects Candidate Set Methods Work with design candidate set objects Design Constraint Properties Examine design constraint objects Design Constraint Methods Work with design constraint objects

Back to Top of Section

Design Properties

Constraints	Constraints in design
Generator	Design generation options
Inputs	Inputs for test plan, model, boundary model, design, or constraint
Model (for designs)	Model for design
Name	Name of object
NumberOfInputs	Number of model, boundary model, or design object inputs
NumberOfPoints	Number of design points
Points	Matrix of design points
PointTypes	Fixed and free point status
Style	Style of design type
Type (for designs and generators)	Design type

Back to Top of Section

Design Methods

AddConstraint	Add design constraint
Augment	Add design points
ConstrainedGenerate	Generate constrained space-filling design of specified size
CreateCandidateSet	Create candidate set for optimal designs
CreateConstraint	Create design contraint
Discrepancy	Discrepancy value
FixPoints	Fix design points
Generate	Generate new design points
getAlternativeTypes	Alternative model or design types
Maximin	Maximum of minimum of distance between design points
Merge	Merge designs
Minimax	Minimum of maximum distance between design points
OptimalCriteria	Optimal design criteria (V, D, A, G)
RemovePoints	Remove all nonfixed design points
Scatter2D	Plot design points

Back to Top of Section

Generator Properties

NumberOfInputs	Number of model, boundary model, or design object inputs
Type (for designs and generators)	Design type

Back to Top of Section

Generator Methods

getAlternativeTypes	Alternative model or design types
Properties (for design generators)	View and edit design generator properties

Back to Top of Section

Candidate Set Properties

NumberOfInputs	Number of model, boundary model, or design object inputs
Type (for candidate sets)	Candidate set type

Back to Top of Section

Candidate Set Methods

getAlternativeTypes	Alternative model or design types
Properties (for candidate sets)	View and edit candidate set properties

Back to Top of Section

Design Constraint Properties

Inputs	Inputs for test plan, model, boundary model, design, or constraint
Name	Name of object
NumberOfInputs	Number of model, boundary model, or design object inputs
Type (for design constraints)	Design constraint type

Back to Top of Section

Design Constraint Methods

Evaluate	Evaluate model, boundary model, or design constraint
getAlternativeTypes	Alternative model or design types
MatchInputs	Match design constraint inputs
Properties (for design constraints)	View and edit design constraint properties

Back to Top

Models

Hierarchical Models Working with hierarchical models Local Models Working with local models Response Models Working with response models Model Objects Working with model objects Model Parameters Examine model parameter objects Model Properties Set model properties

Back to Top of Section

Hierarchical Models

Hierarchical Response Properties

InputSignalNames	Names of signals in data that are being modeled
Level	Level in test plan of response
LocalResponses	Array of local responses for response
Name	Name of object
NumberOfTests	Total number of tests being used in model
ResponseSignalName	Name of signal or response feature being modeled

Hierarchical Response Methods

AlternativeModelStatistics	Summary statistics for alternative models
CreateAlternativeModels	Create alternative models from model template
DoubleInputData	Data being used as input to model
DoubleResponseData	Data being used as output to model for fitting
Export	Make command-line or Simulink export model
OutlierIndices	Indices of DoubleInputData marked as outliers
PEV	Predicted error variance of model at specified inputs
PredictedValue	Predicted value of model at specified inputs
Remove	Remove project, test plan, model, or boundary model
SummaryStatistics	Summary statistics for response
xregstatsmodel	Class for evaluating models and calculating PEV

Back to Top of Section

Local Models

Local Response Properties

InputSignalNames	Names of signals in data that are being modeled
Level	Level in test plan of response
Name	Name of object
NumberOfTests	Total number of tests being used in model
ResponseFeatures(Local Response)	Array of response features for local response
ResponseSignalName	Name of signal or response feature being modeled

Local Response Methods

AlternativeModelStatistics	Summary statistics for alternative models
CreateAlternativeModels	Create alternative models from model template
CreateResponseFeature	Create new response feature for local model
DiagnosticStatistics	Diagnostic statistics for response
DoubleInputData	Data being used as input to model
DoubleResponseData	Data being used as output to model for fitting
Export	Make command-line or Simulink export model
MakeHierarchicalResponse	Build two-stage model from response feature models
mbcPointByPointModel	Class for evaluating point-by-point models and calculating PEV
ModelForTest	Model for specified test
OutlierIndices	Indices of DoubleInputData marked as outliers
OutlierIndicesForTest	Indices marked as outliers for test
PEV	Predicted error variance of model at specified inputs
PEVForTest	Local model predicted error variance for test
PredictedValue	Predicted value of model at specified inputs
PredictedValueForTest	Predicted local model response for test
Remove	Remove project, test plan, model, or boundary model
RemoveOutliers	Remove outliers in input data by index or rule, and refit models
RemoveOutliersForTest	Remove outliers on test by index or rule and refit models
RestoreData	Restore removed outliers
RestoreDataForTest	Restore removed outliers for test
SummaryStatistics	Summary statistics for response
SummaryStatisticsForTest	Statistics for specified test
UpdateResponseFeatures	Refit response feature models
xregstatsmodel	Class for evaluating models and calculating PEV

Local Model Properties

LocalModel Properties	Edit local model properties
ResponseFeatures(Local Model)	Set of response features for local model

Back to Top of Section

Response Models

Response Properties

AlternativeResponses	Array of alternative responses for this response
InputSignalNames	Names of signals in data that are being modeled
Level	Level in test plan of response
Model Object	Model object within response object
Name	Name of object
NumberOfTests	Total number of tests being used in model
ResponseSignalName	Name of signal or response feature being modeled

Response Methods

AlternativeModelStatistics	Summary statistics for alternative models
ChooseAsBest	Choose best model from alternative responses
CreateAlternativeModels	Create alternative models from model template
DiagnosticStatistics	Diagnostic statistics for response
DoubleInputData	Data being used as input to model
DoubleResponseData	Data being used as output to model for fitting
Export	Make command-line or Simulink export model
OutlierIndices	Indices of DoubleInputData marked as outliers
PEV	Predicted error variance of model at specified inputs
PredictedValue	Predicted value of model at specified inputs
Remove	Remove project, test plan, model, or boundary model
RemoveOutliers	Remove outliers in input data by index or rule, and refit models
RestoreData	Restore removed outliers
SummaryStatistics	Summary statistics for response
xregstatsmodel	Class for evaluating models and calculating PEV

Back to Top of Section

Model Objects

Response objects contain an mbcmodel.model object with the following properties and methods.

Model Properties

FitAlgorithm	Fit algorithm for model or boundary model
InputData	Input data for model
Inputs	Inputs for test plan, model, boundary model, design, or constraint
IsBeingEdited	Boolean signaling if data or model is being edited
NumberOfInputs	Number of model, boundary model, or design object inputs
OutputData	Output (or response) data for model
Parameters	Model parameters
Properties (for models)	View and edit model properties
Response	Response for model object
Status	Model status: fitted, not fitted or best
Type (for models)	Valid model types
Units	Model output units

Linear Model Methods

AliasMatrix	Alias matrix for linear model parameters
BoxCoxSSE	SSE and confidence interval for Box-Cox transformations
Correlation	Correlation matrix for linear model parameters
Covariance	Covariance matrix for linear model parameters
MultipleVIF	Multiple VIF matrix for linear model parameters
ParameterStatistics	Calculate parameter statistics for linear model
PartialVIF	Partial VIF matrix for linear model parameters
SingleVIF	Single VIF matrix for linear model parameters
StepwiseRegression	Change stepwise selection status for specified terms

Model Methods

CreateDesign	Create design object for test plan or model
Evaluate	Evaluate model, boundary model, or design constraint
Export	Make command-line or Simulink export model
Fit	Fit model or boundary model to new or existing data, and provide summary statistics
getAlternativeTypes	Alternative model or design types
InputSetupDialog	Open Input Setup dialog box to edit inputs
Jacobian	Calculate Jacobian matrix for model at existing or new X points
ModelSetup	Open Model Setup dialog box where you can alter model type
PEV	Predicted error variance of model at specified inputs
PredictedValue	Predicted value of model at specified inputs
StatisticsDialog	Open summary statistics dialog box
SummaryStatistics	Summary statistics for response
UpdateResponse	Replace model in response
xregstatsmodel	Class for evaluating models and calculating PEV

Fit Algorithm Methods

An mbcmodel.fitalgorithm object is contained within the Properties property of an mbcmodel.model object.

CreateAlgorithm	Create algorithm
getAlternativeNames	List alternative algorithm names
IsAlternative	Test alternative fit algorithm
SetupDialog	Open fit algorithm setup dialog box

Back to Top of Section

Model Parameters

These properties of the mbcmodel.modelparameters object are all read-only. An mbcmodel.modelparameters object is contained within the Parameters property of an mbcmodel.model object.

Model Parameters Properties

Names	Model parameter names
NumberOfParameters	Number of included model parameters
Values	Values of model parameters

Linear Model Properties

A mbcmodel.linearmodelparameters object is a mbcmodel.modelparameters object plus the following properties.

SizeOfParameterSet	Number of model parameters
StepwiseSelection	Model parameters currently included and excluded
StepwiseStatus	Stepwise status of parameters in model

RBF Model Properties

A mbcmodel.rbfmodelparameters object is a mbcmodel.linearmodelparameters object plus the following properties.

Centers	Centers of RBF model
Widths	Width data from RBF model

Back to Top of Section

Model Properties

Linear Model Properties Methods

GetAllTerms	List all model terms
GetIncludedTerms	List included model terms
SetTermStatus	Set status of model terms

Back to Top

Boundary Models

Boundary Classes Learn about boundary model objects AbstractBoundary Properties Examine parent boundary model objects AbstractBoundary Methods Work with parent boundary model objects Model Properties Examine base boundary model objects Model Methods Work with base boundary model objects Boolean Properties Examine boolean boundary model objects Boolean Methods Work with boolean boundary model objects PointByPoint Properties Examine point-by-point boundary model objects PointByPoint Methods Work with point-by-point boundary model objects TwoStage Properties Examine two-stage boundary model objects TwoStage Methods Work with two-stage boundary model objects Tree Properties Examine boundary tree objects Tree Methods Work with boundary tree objects TwoStageTree Properties Examine two-stage boundary tree objects

Back to Top of Section

Boundary Classes

mbcboundary.AbstractBoundary	Base boundary model class
mbcboundary.Boolean	Boolean boundary model class
mbcboundary.Model	Boundary model class
mbcboundary.PointByPoint	Point-by-point boundary model class
mbcboundary.Tree	Boundary tree class
mbcboundary.TwoStage	Two-stage boundary model class
mbcboundary.TwoStageTree	Root boundary tree class in two-stage test plans

Back to Top of Section

AbstractBoundary Properties

FitAlgorithm	Fit algorithm for model or boundary model
Fitted	Indicate whether boundary model has been fitted
Inputs	Inputs for test plan, model, boundary model, design, or constraint
Name	Name of object
NumberOfInputs	Number of model, boundary model, or design object inputs
Type (for boundary models)	Boundary model type

Back to Top of Section

AbstractBoundary Methods

CreateBoundary	Create boundary model
designconstraint	Convert boundary model to design constraint
Evaluate	Evaluate model, boundary model, or design constraint
getAlternativeTypes	Alternative model or design types

Back to Top of Section

Model Properties

ActiveInputs	Active boundary model inputs
FitAlgorithm	Fit algorithm for model or boundary model
Fitted	Indicate whether boundary model has been fitted
Inputs	Inputs for test plan, model, boundary model, design, or constraint
Name	Name of object
NumberOfInputs	Number of model, boundary model, or design object inputs
Type (for boundary models)	Boundary model type

Back to Top of Section

Model Methods

CreateBoundary	Create boundary model
designconstraint	Convert boundary model to design constraint
Evaluate	Evaluate model, boundary model, or design constraint
Fit	Fit model or boundary model to new or existing data, and provide summary statistics
getAlternativeTypes	Alternative model or design types

Back to Top of Section

Boolean Properties

FitAlgorithm	Fit algorithm for model or boundary model
Fitted	Indicate whether boundary model has been fitted
Inputs	Inputs for test plan, model, boundary model, design, or constraint
Name	Name of object
NumberOfInputs	Number of model, boundary model, or design object inputs
Type (for boundary models)	Boundary model type

Back to Top of Section

Boolean Methods

CreateBoundary	Create boundary model
designconstraint	Convert boundary model to design constraint
Evaluate	Evaluate model, boundary model, or design constraint
getAlternativeTypes	Alternative model or design types

Back to Top of Section

PointByPoint Properties

FitAlgorithm	Fit algorithm for model or boundary model
Fitted	Indicate whether boundary model has been fitted
Inputs	Inputs for test plan, model, boundary model, design, or constraint
LocalBoundaries	Array of local boundary models for each operating point
LocalModel	Definition of local boundary model
Name	Name of object
NumberOfInputs	Number of model, boundary model, or design object inputs
OperatingPoints	Model operating point sites
Type (for boundary models)	Boundary model type

Back to Top of Section

PointByPoint Methods

CreateBoundary	Create boundary model
designconstraint	Convert boundary model to design constraint
Evaluate	Evaluate model, boundary model, or design constraint
getAlternativeTypes	Alternative model or design types

Back to Top of Section

TwoStage Properties

FitAlgorithm	Fit algorithm for model or boundary model
Fitted	Indicate whether boundary model has been fitted
GlobalModel	Interpolating global boundary model definition
Inputs	Inputs for test plan, model, boundary model, design, or constraint
LocalModel	Definition of local boundary model
Name	Name of object
NumberOfInputs	Number of model, boundary model, or design object inputs
Type (for boundary models)	Boundary model type

Back to Top of Section

TwoStage Methods

CreateBoundary	Create boundary model
designconstraint	Convert boundary model to design constraint
Evaluate	Evaluate model, boundary model, or design constraint
getAlternativeTypes	Alternative model or design types
getLocalBoundary	Local boundary model for operating point

Back to Top of Section

Tree Properties

BestModel	Combined best boundary models
Data	Array of data objects in project, boundary tree, or test plan
InBest	Boundary models selected as best
Models	Array of boundary models
TestPlan	Test plan containing boundary tree

Back to Top of Section

Tree Methods

Add	Add boundary model to tree and fit to test plan data
CreateBoundary	Create boundary model
Remove	Remove project, test plan, model, or boundary model
Update	Update boundary model in tree and fit to test plan data

Back to Top of Section

TwoStageTree Properties

BestModel	Combined best boundary models
Global	Global boundary model tree
InBest	Boundary models selected as best
Local	Local boundary model tree
Response	Response for model object
TestPlan	Test plan containing boundary tree

Commands — Alphabetical List

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