NonLinModel (FPScript)
Calculates a non-linear model function for model parameters that you specify.
Syntax
NonLinModel(Model, Data, Parameter)
or
NonLinModel(UserdefinedModel, N, Data, Parameter [ , AuxData ])
The syntax of the NonLinModel function consists of the following parts:
Part |
Description |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Model |
Determines the model to be calculated. The argument can be selected from a list of predefined models. The argument Model can have the following values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UserdefinedModel |
Identifies the custom model that should be adjusted to the data. The argument contains FPScript code for calculating the model function (see NonLinCurveFit function). Permitted data structures are scalar value. Supported data types are string. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
N |
The number of parameters used in the custom model. Permitted data structures are scalar value. All integral data types are permitted. The value must be greater or equal to 1. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Data |
The X values for which the model function is to be evaluated. If you specify an aggregate data structure, then its X component is used. Permitted data structures are data series, signal und signal series. All numeric data types are permitted, except calendar time. If the argument is a list, then the function is executed for each element of the list and the result is also a list. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter |
The data series with the parameter values for which the model function is evaluated. Permitted data structures are data series. All numeric data types are permitted. The unit of the argument is ignored. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AuxData |
Any data that can be passed to the custom model as an option as the argument 'd'. All data structures are allowed. All data types are permitted. |
Remarks
The result always has the data structure signal.
If the Data argument is a signal, only its X component is used. The result is a signal with the specified X values and the calculated Y values.
Available in
FlexPro Basic, Professional, Developer Suite
Examples
Dim p = ParameterEstimation(MODEL_EXP_EXPONENTIAL_DECAY1, Ag, {{0,1000}, {0,1000}, {0,1000}}, {10, 10, 10}, MODE_RANDOM)
NonLinModel(MODEL_EXP_EXPONENTIAL_DECAY1, Ag, p)
Estimates the parameters of the Exponential decay (variant 1) model using the random search process and calculates the modeled data from this. The parameters can be between 0 and 1000.