| Model-Based Calibration Toolbox™ | |
Function Reference |  Alphabetical List |
|
| CreateData | Create data object |
| CreateModel | Create new model |
| CreateProject | Create project object |
| DataFileTypes | Data file types |
| LoadProject | Load mbcmodel.project |
| modelinput | Create modelinput object |
|
| 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 |
| 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 |
|
| Data | Array of data objects in project 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 |
| 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, or model |
| RemoveData | Remove data from project |
| Save | Save project to currently selected filename |
| SaveAs | Save project to new file |
|
| BestDesign | Best design in test plan |
| Data | Array of data objects in project or test plan |
| DefaultModels | Default models for test plan |
| Designs | Designs in test plan |
| Inputs | Inputs for test plan, 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 |
| 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, or model |
| RemoveDesign | Remove design from test plan |
| UpdateDesign | Update design in test plan |
|
| Constraints | Constraints in design |
| Generator | Design generation options |
| Inputs | Inputs for test plan, model, design or constraint |
| Model (for designs) | Model for design |
| Name | Name of object |
| NumberOfInputs | Number of 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 |
| AddConstraint | Add design contraint |
| 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 |
| NumberOfInputs | Number of model or design object inputs |
| Type (for designs and generators) | Design type |
| getAlternativeTypes | Alternative model or design types |
| Properties (for design generators) | View and edit design generator properties |
| NumberOfInputs | Number of model or design object inputs |
| Type (for candidate sets) | Candidate set type |
| getAlternativeTypes | Alternative model or design types |
| Properties (for candidate sets) | View and edit candidate set properties |
| Inputs | Inputs for test plan, model, design or constraint |
| Name | Name of object |
| NumberOfInputs | Number of model or design object inputs |
| Type (for design constraints) | Design constraint type |
| Evaluate | Evaluate 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 |
|
| 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 |
| 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, or model |
| SummaryStatistics | Summary statistics for response |
| 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 |
| 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 |
| 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, or 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 |
| LocalModel Properties | Edit local model properties |
| ResponseFeatures(Local Model) | Set of response features for local model |
| 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 |
| 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, or model |
| RemoveOutliers | Remove outliers in input data by index or rule, and refit models |
| RestoreData | Restore removed outliers |
| SummaryStatistics | Summary statistics for response |
Response objects contain an mbcmodel.model object with the following properties and methods.
| FitAlgorithm | Fit algorithm for model |
| InputData | Input data for model |
| Inputs | Inputs for test plan, model, design or constraint |
| IsBeingEdited | Boolean signaling if data or model is being edited |
| NumberOfInputs | Number of 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 |
| 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 |
| CreateDesign | Create design object for test plan or model |
| Evaluate | Evaluate model or design constraint |
| Export | Make command-line or Simulink export model |
| Fit | Fit 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 |
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 |
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.
| Names | Model parameter names |
| NumberOfParameters | Number of included model parameters |
| Values | Values of model parameters |
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 |
A mbcmodel.rbfmodelparameters object is a mbcmodel.linearmodelparameters object plus the following properties.
| Centers | Centers of RBF model |
| Widths | Width data from RBF model |
| GetAllTerms | List all model terms |
| GetIncludedTerms | List included model terms |
| SetTermStatus | Set status of model terms |
| Commands — Alphabetical List | |
| © 1984-2009- The MathWorks, Inc. - Site Help - Patents - Trademarks - Privacy Policy - Preventing Piracy - RSS |