2.4.14 nlbeginm(Pro)
Brief Information
Start a nonlinear curve fitting session for matrix data
Additional Information
X-Function not designed for Auto GetN Dialog. This feature is for OriginPro only.
This feature is updated in 8.0 SR5. For more details, please refer to Release Notes.
Command Line Usage
nlbeginm func:=Gauss2D; // Fit the active matrix data with a 2D Gaussian function.
X-Function Execution Options
Please refer to the page for additional option switches when accessing the x-function from script
Variables
Display
Name
|
Variable
Name
|
I/O
and
Type
|
Default
Value
|
Description
|
| Input Matrix
|
im
|
Input
MatrixObject
|
<active>
|
Specify the matrix data to be fitted.
|
| Fitting Function Name
|
func
|
Input
string
|
<unassigned>
|
Specify the fitting function.
|
|
|
nltree
|
Input/Output
TreeNode
|
nlt
|
This is the tree with which you can customize the settings of the fitting such as parameter values, standard error. For more details, please refer to here.
|
| Number of Replicas
|
replica
|
Input
int
|
0
|
Specify the number of replicas. Enter a non-zero value if you want to fit your data to a built-in peak function by replicating the function for each peak. Each of function may have different parameter values. Your data should display multiple peaks of the same general form. If the function you have selected does not support replicas, this is disabled.
|
| Dialog Theme
|
theme
|
Input
string
|
<optional>
|
Specify a theme. The settings saved in it will be loaded to customize the fitting.
|
| Notation of Parameters
|
pnotation
|
Input
int
|
para
|
Specify the notation of parameters in the output tree.
Option list:
- Use the parameter names as notation.
- Use the abbreviations of the parameters as notation.
- Use both names and abbreviations of the parameters as notation.
|
| Parameter Initialization
|
init
|
Input
int
|
0
|
Specify the status of parameter initialization.
Option list:
- Origin automatically decides whether to enable parameter initialization according to the FDF file of the fitting function.
- Enable parameter initialization.
- Disable parameter initialization.
|
| How to Initialize the NLFit Object
|
option
|
Input
int
|
0
|
Specify how to initialize the NLFit Object.
Option list:
- init_all:Init All Parameters
- Initialize all parameters and then do the fitting with these parameters.
- change_data:Only Change Data
- Keep the former settings and only change dataset, then do the fitting to the new dataset.
|
Description
Start a nonlinear surface fitting session from matrix data. You can customize the fitting settings and the parameter initilization.
Example
This example fits the data in a matrix with a 2D Gaussian function and generate the result report.
//Prepare the data
string fn$=system.path.program$ + "Samples\Matrix Conversion and Gridding\2D Gaussian.ogm";
doc -a %(fn$);
// fit the matrix data with 2D Gaussian and generate report
nlbeginm func:=Gauss2D;
nlfit;
nlend 1 2;
Related X-Functions
nlfit, nlend, nlgui, nlpara, nlfn, nlbegin, nlbeginz, nlbeginr
Keywords:regression, NLFit
|