Recent changes to basic_fitting

basic_fitting modified by A. Smith

A. Smith — Mon, 12 Sep 2016 14:58:45 -0000

--- v7
+++ v8
@@ -9,7 +9,7 @@

     fit=FitSpec(spec,par);

-In the first case, the program uses all default options, some of which are calculated during the program run depending on properties determined from the ‘spec’ structure. In the second case, the user determines some of these options, and specifies them in the ‘par’ structure. The ['spec'](/p/infos/wiki/spec_struct) structure contains the spectrum and frequency axes (in ppm), and also may contain acquisition and processing information for the spectrum. The ['par'](/p/infos/wiki/par_struct) structure contains instructions for spectrum fitting. The output structure, ['fit'](/p/infos/wiki/fit_struct), contains lists of peak positions, linewidths, amplitude, and integral, as well as the calculated spectrum and error spectrum, and information on the analysis of the fit.
+In the first case, the program uses all default options, some of which are calculated during the program run depending on properties determined from the ‘spec’ structure. In the second case, the user determines some of these options, and specifies them in the ‘par’ structure. The ['spec'](/p/infos/wiki/spec_struct) structure contains the experimental spectrum and frequency axes (in ppm), and also may contain acquisition and processing information for the spectrum. The ['par'](/p/infos/wiki/par_struct) structure contains instructions for spectrum fitting. The output structure, ['fit'](/p/infos/wiki/fit_struct), contains lists of peak positions, linewidths, amplitude, and integral, as well as the calculated spectrum and error spectrum, and information on the analysis of the fit.

 With a fixed peak list, without any user instructions:

@@ -19,4 +19,4 @@

     fit=FitSpec(spec,par,fit0);

-As before, the ‘par’ structure is optional, but now an initial fit is given in ‘fit0’. ['fit0'](/p/infos/wiki/fit0_struct) has a very similar form as ‘fit’, and one may use the output of another fitting run in the ‘fit0’ argument. ‘fit0’ also may containing additional fields to restrict how variables are changed (fixing parameters or setting ranges on the parameters). Note that when ‘fit0’ is provided, then peak position/linewidth/amplitude are optimized, but by default, the peak list itself is not changed. This can be overridden with user settings in the ‘par’ structure.
+As before, the ‘par’ structure is optional, but now an initial fit is given in ‘fit0’. ['fit0'](/p/infos/wiki/fit0_struct) has a very similar form as ‘fit’, and one may use the output of another fitting run in the ‘fit0’ argument. ‘fit0’ also may containing additional fields to restrict how variables are changed (fixing parameters or setting ranges on the parameters). Note that when ‘fit0’ is provided, then peak position/linewidth/amplitude are optimized, but by default, the peak list itself is not changed (no peaks added or removed). This can be overridden with user settings in the ‘par’ structure.

basic_fitting modified by A. Smith

A. Smith — Mon, 12 Sep 2016 14:55:32 -0000

--- v6
+++ v7
@@ -1,5 +1,6 @@
 ### Basic Fitting: The FitSpec Function
 Fitting a spectrum may be done completely within the FitSpec function. FitSpec may either optimize a given peak list by varying position, amplitude, and/or linewidth, or may perform the peak picking as well, with periodic modification of the peak list to optimize the spectrum fit. We will refer to the former case as a fixed peak list and the latter as a dynamic peak list. Additionally, settings controlling the behavior of FitSpec may be determined internally or fitting instructions may be provided by the user. The commands are formatted as follows.
+
 With a dynamic peak list, without any user instructions:

     fit=FitSpec(spec);

basic_fitting modified by A. Smith

A. Smith — Mon, 12 Sep 2016 14:54:36 -0000

--- v5
+++ v6
@@ -1,21 +1,20 @@
 ### Basic Fitting: The FitSpec Function
-Fitting a spectrum may be done completely within the FitSpec function. FitSpec may either optimize a given peak list by varying position, amplitude, and/or linewidth, or may perform the peak picking as well, with periodic modification of the peak list to optimize the spectrum fit. We will refer to the former case as a fixed peak list and the latter as a dynamic peak list. The commands are formatted as follows.
-
-With a dynamic peak list:
+Fitting a spectrum may be done completely within the FitSpec function. FitSpec may either optimize a given peak list by varying position, amplitude, and/or linewidth, or may perform the peak picking as well, with periodic modification of the peak list to optimize the spectrum fit. We will refer to the former case as a fixed peak list and the latter as a dynamic peak list. Additionally, settings controlling the behavior of FitSpec may be determined internally or fitting instructions may be provided by the user. The commands are formatted as follows.
+With a dynamic peak list, without any user instructions:

     fit=FitSpec(spec);

-or:
+or with a dynamic peak list, with additional user instructions:

     fit=FitSpec(spec,par);

 In the first case, the program uses all default options, some of which are calculated during the program run depending on properties determined from the ‘spec’ structure. In the second case, the user determines some of these options, and specifies them in the ‘par’ structure. The ['spec'](/p/infos/wiki/spec_struct) structure contains the spectrum and frequency axes (in ppm), and also may contain acquisition and processing information for the spectrum. The ['par'](/p/infos/wiki/par_struct) structure contains instructions for spectrum fitting. The output structure, ['fit'](/p/infos/wiki/fit_struct), contains lists of peak positions, linewidths, amplitude, and integral, as well as the calculated spectrum and error spectrum, and information on the analysis of the fit.

-With fixed peak list:
+With a fixed peak list, without any user instructions:

     fit=FitSpec(spec,[],fit0);

-or
+or with a fixed peak list, with additional user instructions:

     fit=FitSpec(spec,par,fit0);

basic_fitting modified by A. Smith

A. Smith — Fri, 09 Sep 2016 07:08:02 -0000

--- v4
+++ v5
@@ -2,15 +2,21 @@
 Fitting a spectrum may be done completely within the FitSpec function. FitSpec may either optimize a given peak list by varying position, amplitude, and/or linewidth, or may perform the peak picking as well, with periodic modification of the peak list to optimize the spectrum fit. We will refer to the former case as a fixed peak list and the latter as a dynamic peak list. The commands are formatted as follows.

 With a dynamic peak list:
+
     fit=FitSpec(spec);
-    or:
+
+or:
+
     fit=FitSpec(spec,par);

 In the first case, the program uses all default options, some of which are calculated during the program run depending on properties determined from the ‘spec’ structure. In the second case, the user determines some of these options, and specifies them in the ‘par’ structure. The ['spec'](/p/infos/wiki/spec_struct) structure contains the spectrum and frequency axes (in ppm), and also may contain acquisition and processing information for the spectrum. The ['par'](/p/infos/wiki/par_struct) structure contains instructions for spectrum fitting. The output structure, ['fit'](/p/infos/wiki/fit_struct), contains lists of peak positions, linewidths, amplitude, and integral, as well as the calculated spectrum and error spectrum, and information on the analysis of the fit.

 With fixed peak list:
+
     fit=FitSpec(spec,[],fit0);
-    or
+
+or
+
     fit=FitSpec(spec,par,fit0);

 As before, the ‘par’ structure is optional, but now an initial fit is given in ‘fit0’. ['fit0'](/p/infos/wiki/fit0_struct) has a very similar form as ‘fit’, and one may use the output of another fitting run in the ‘fit0’ argument. ‘fit0’ also may containing additional fields to restrict how variables are changed (fixing parameters or setting ranges on the parameters). Note that when ‘fit0’ is provided, then peak position/linewidth/amplitude are optimized, but by default, the peak list itself is not changed. This can be overridden with user settings in the ‘par’ structure.

basic_fitting modified by A. Smith

A. Smith — Thu, 08 Sep 2016 18:29:13 -0000

--- v3
+++ v4
@@ -1,4 +1,4 @@
-### Basic fitting: the FitSpec function
+### Basic Fitting: The FitSpec Function
 Fitting a spectrum may be done completely within the FitSpec function. FitSpec may either optimize a given peak list by varying position, amplitude, and/or linewidth, or may perform the peak picking as well, with periodic modification of the peak list to optimize the spectrum fit. We will refer to the former case as a fixed peak list and the latter as a dynamic peak list. The commands are formatted as follows.

 With a dynamic peak list:

basic_fitting modified by A. Smith

A. Smith — Thu, 08 Sep 2016 14:06:05 -0000

--- v2
+++ v3
@@ -6,7 +6,7 @@
     or:
     fit=FitSpec(spec,par);

-In the first case, the program uses all default options, some of which are calculated during the program run depending on properties determined from the ‘spec’ structure. In the second case, the user determines some of these options, and specifies them in the ‘par’ structure. The [spec](/p/infos/wiki/spec_struct) structure contains the spectrum and frequency axes (in ppm), and also may contain acquisition and processing information for the spectrum. The ['par'](/p/infos/wiki/par_struct) structure contains instructions for spectrum fitting. The output structure, ['fit'](/p/infos/wiki/fit_struct), contains lists of peak positions, linewidths, amplitude, and integral, as well as the calculated spectrum and error spectrum, and information on the analysis of the fit.
+In the first case, the program uses all default options, some of which are calculated during the program run depending on properties determined from the ‘spec’ structure. In the second case, the user determines some of these options, and specifies them in the ‘par’ structure. The ['spec'](/p/infos/wiki/spec_struct) structure contains the spectrum and frequency axes (in ppm), and also may contain acquisition and processing information for the spectrum. The ['par'](/p/infos/wiki/par_struct) structure contains instructions for spectrum fitting. The output structure, ['fit'](/p/infos/wiki/fit_struct), contains lists of peak positions, linewidths, amplitude, and integral, as well as the calculated spectrum and error spectrum, and information on the analysis of the fit.

 With fixed peak list:
     fit=FitSpec(spec,[],fit0);

basic_fitting modified by A. Smith

A. Smith — Thu, 08 Sep 2016 14:05:42 -0000

--- v1
+++ v2
@@ -6,11 +6,11 @@
     or:
     fit=FitSpec(spec,par);

-In the first case, the program uses all default options, some of which are calculated during the program run depending on properties determined from the ‘spec’ structure. In the second case, the user determines some of these options, and specifies them in the ‘par’ structure. The ‘spec’ structure contains the spectrum and frequency axes (in ppm), and also may contain acquisition and processing information for the spectrum. The fields and their form for ‘spec’ are detailed in 2.1. The ‘par’ structure contains instructions for spectrum fitting, which is detailed in 2.2. The output structure, ‘fit’, contains lists of peak positions, linewidths, amplitude, and integral, as well as the calculated spectrum and error spectrum, and information on the analysis of the fit. Details are found in 2.3.
+In the first case, the program uses all default options, some of which are calculated during the program run depending on properties determined from the ‘spec’ structure. In the second case, the user determines some of these options, and specifies them in the ‘par’ structure. The [spec](/p/infos/wiki/spec_struct) structure contains the spectrum and frequency axes (in ppm), and also may contain acquisition and processing information for the spectrum. The ['par'](/p/infos/wiki/par_struct) structure contains instructions for spectrum fitting. The output structure, ['fit'](/p/infos/wiki/fit_struct), contains lists of peak positions, linewidths, amplitude, and integral, as well as the calculated spectrum and error spectrum, and information on the analysis of the fit.

 With fixed peak list:
     fit=FitSpec(spec,[],fit0);
     or
     fit=FitSpec(spec,par,fit0);

-As before, the ‘par’ structure is optional, but now an initial fit is given in ‘fit0’. ‘fit0’ has a very similar form as ‘fit’, and one may use the output of another fitting run in the ‘fit0’ argument. ‘fit0’ also may containing additional fields to restrict how variables are changed (fixing parameters or setting ranges on the parameters). This is described in 2.5. Note that when ‘fit0’ is provided, then peak position/linewidth/amplitude are optimized, but by default, the peak list itself is not changed. This can be overridden with user settings in the ‘par’ structure.
+As before, the ‘par’ structure is optional, but now an initial fit is given in ‘fit0’. ['fit0'](/p/infos/wiki/fit0_struct) has a very similar form as ‘fit’, and one may use the output of another fitting run in the ‘fit0’ argument. ‘fit0’ also may containing additional fields to restrict how variables are changed (fixing parameters or setting ranges on the parameters). Note that when ‘fit0’ is provided, then peak position/linewidth/amplitude are optimized, but by default, the peak list itself is not changed. This can be overridden with user settings in the ‘par’ structure.

basic_fitting modified by A. Smith

A. Smith — Thu, 08 Sep 2016 09:33:57 -0000

Basic fitting: the FitSpec function

Fitting a spectrum may be done completely within the FitSpec function. FitSpec may either optimize a given peak list by varying position, amplitude, and/or linewidth, or may perform the peak picking as well, with periodic modification of the peak list to optimize the spectrum fit. We will refer to the former case as a fixed peak list and the latter as a dynamic peak list. The commands are formatted as follows.

With a dynamic peak list:
fit=FitSpec(spec);
or:
fit=FitSpec(spec,par);

In the first case, the program uses all default options, some of which are calculated during the program run depending on properties determined from the ‘spec’ structure. In the second case, the user determines some of these options, and specifies them in the ‘par’ structure. The ‘spec’ structure contains the spectrum and frequency axes (in ppm), and also may contain acquisition and processing information for the spectrum. The fields and their form for ‘spec’ are detailed in 2.1. The ‘par’ structure contains instructions for spectrum fitting, which is detailed in 2.2. The output structure, ‘fit’, contains lists of peak positions, linewidths, amplitude, and integral, as well as the calculated spectrum and error spectrum, and information on the analysis of the fit. Details are found in 2.3.

With fixed peak list:
fit=FitSpec(spec,[],fit0);
or
fit=FitSpec(spec,par,fit0);

As before, the ‘par’ structure is optional, but now an initial fit is given in ‘fit0’. ‘fit0’ has a very similar form as ‘fit’, and one may use the output of another fitting run in the ‘fit0’ argument. ‘fit0’ also may containing additional fields to restrict how variables are changed (fixing parameters or setting ranges on the parameters). This is described in 2.5. Note that when ‘fit0’ is provided, then peak position/linewidth/amplitude are optimized, but by default, the peak list itself is not changed. This can be overridden with user settings in the ‘par’ structure.