2.4.21 nlgui

Brief Information

Get or set fitting output properties using a tree

Additional Information

Minimum Origin Version Required: 8.0 SR5

Command Line Usage

  1. nlgui gg 1; //Get the gui tree.
    gg.quantities.parameters.LCL =1;
    gg.quantities.parameters.UCL = 1;
    gg.output.PlotSettings.PasteResultTable.use=0; //disable a branch check box
  2. nlgui gg 0; //Update the gui tree after changing setting

Variables

Display
Name
Variable
Name
I/O
and
Type
Default
Value
Description
gui

Input/Output

TreeNode

nlgui
The tree that contains output quantities and destination.
command

Input

int

1
Specify whether to get or set the Nlgui tree.

Option list:

  • set:Set
Set the gui tree.
  • get:Get
Get the gui tree. This is the default selection.

Description

This X-Function is usually used with other fitting X-Function to control the output quantities and the destination of the nltree. You can use this command to update the tree to fit report process before nlend.


Details on gui TreeNode

  • gui
Please see this page for more details.

Example

Following script will generate a report without ANOVA table, fitted curve plot and residual plot

// import some sample data
newbook;
string fname$ = system.path.program$ + "Samples\Curve Fitting\Gaussian.dat";
impasc;

//init NLFit object and specify Input range as the col(B) and
//associate the NLFit internal tree with LabTalk tree named tt
nlbegin 2 gauss tt;

// start iterations
nlfit;

//get the gui output to a tree named gg
nlgui gg 1;

//disable ANOVA table, fitted curve plot and residual plot output in the report sheet
//Not to paste the parameters table on the graph
gg.quantities.ANOVAtable=0;
gg.graph1.doplot=0;
gg.residuals.graph2=0;
gg.output.plotsettings.pasteresulttable.use=0;

//Output fitted curve results to source workbook, source worksheet
gg.output.data.book$ = <source>;
gg.output.data.sheet$ = <source>;

//update the changes back to gui tree
nlgui gg 0;

//dump out the tree to check if the changes success
gg.=;

//generate the report sheet and end fitting process to clean up internal objects
nlend 1;

Related X-Functions

nlbegin, nlfit, nlend, nlfn


Keywords:regression, NLFit