Changeset b5846a10 in sasview

Timestamp:

May 28, 2015 1:11:14 PM (9 years ago)

Author:

smk78

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

b327dd7

Parents:

63d314b

Message:

Work in progress

File:

• src/sas/perspectives/fitting/media/fitting_help.rst (modified) (2 diffs)

src/sas/perspectives/fitting/media/fitting_help.rst

@@ -132 +132 @@
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
+.. _Adding_your_own_models:
+
 Adding your own models
 ----------------------
@@ -368 +370 @@
 fit parameters between data sets (eg, to fix a background level, or radius, etc).
 
-If the data to be fit are in multiple files, load each file, select it in the 
-*Data Explorer*, and *Send To Fitting*.
-
-If multiple data sets are in one file, load that file, *Unselect All Data*, then 
-select each dataset one at a time and Send To Fitting.
-
-The result should be that for 
-n
-datsets you have 2
-n
-graphs (
-n
-of the data & model fit and 
-n
-residuals plots).
-
-IMPORTANT! 
-If you need to create a n
-ew model with the new model wizard, or use a 
-model which is the sum of two existing models, go Fitting 
-
-Edit Custom Model 
-before
-sending the data to the fitting engine.
-The model will be available under 
-‘
-Customised 
-Models
-’
-on 
-the FitPage. NB: the name will likely be abbreviated; eg, 
-‘
-Peak 
-Gauss
-Model + Absolute Power Law Model
-’
-will appear as 
-‘
-PGM + APL
-’
-.
-3.
-Go to each Fit
-Page in turn
-and:
-
-Select the required model.
-
-Unselect all the model par
-ameters.
-
-Enter some starting guesses for the parameters (it may be helpful to remove the 
-residuals plots for clarity; go Graph 
-
-Show and untick graph windows as required).
-
-Enter any parameter limits (recommended).
-
-Select which parameters will refine (sele
-cting all is probably a bad idea...).
-4.
-Select Fitting 
-
-Simultaneous Fit (this also selects the Complex Fit Engine).
-5.
-Go to the Simultaneous Fit page
-and:
-
-Select which datasets are to be fitted (which will probably be all of them or you wouldn’t 
-have 
-loaded them in!).
-
-It is possible to tie parameters between datasets with constraints; eg, make the 
-Background in FitPage1 the same as the Background in FitPage2, and so on. To do this, 
-answer ‘yes’ to Add Constraints in the Fit Constraints box.
-
-But note th
-at SANSView only lets you constrain parameters that are refining.
-6.
-Click Fit
-
-
+If the data to be fit are in multiple files, load each file, then select each file
+in the *Data Explorer*, and *Send To Fitting*. If multiple data sets are in one file,
+load that file, *Unselect All Data*, select just those data sets to be fitted, and
+*Send To Fitting*. Either way, the result should be that for *n* data sets you have
+2*n* graphs (*n* of the data and model fit, and *n* of the resulting residuals). But
+it may be helpful to minimise the residuals plots for clarity.
+
+*NB: If you need to use a customized model, you must ensure that model is available*
+*first (see* :ref:`Adding_your_own_models` *).*
+
+Now go to each *FitPage* in turn and:
+
+  Select the required category and model;
+
+  Unselect all the model parameters;
+
+  Enter some starting guesses for the parameters;
+
+  Enter any parameter limits (recommended);
+
+  Select which parameters will refine (selecting all is generally a bad idea...);
+
+When done, select *Constrained or Simultaneous Fit* under *Fitting* in the menu bar.
+
+In the *Const & Simul Fit* page that appears, select which data sets are to be
+simultaneously fitted (this will probably be all of them or you would not have loaded
+them in the first place!).
+
+To tie parameters between the data sets with constraints, check the 'yes' radio button
+next to *Add Constraint?* in the *Fit Constraints* box.
+
+*NB: You can only constrain parameters that are set to refine.*
+
+When ready, click the *Fit* button on the *Const & Simul Fit* page, NOT the *Fit*
+button on the individual *FitPage*'s.
 
 Simultaneous Fits without Constraints
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Assuming some FitPages are already set up, check the checkboxes of the 
-model_data rows to fit. And click the 'Fit' button. The results will return to 
-each FitPages.
-
-Note that the chi2/Npts returned is the sum of the chi2/Npts of each fits. If 
-one needs the chi2 value only for a page, click the 'Compute' button in the 
-FitPage to recalculate.
+The results of the model-fitting will be returned to each of the individual
+*FitPage*'s.
+
+Note that the chi2/Npts value returned is the SUM of the chi2/Npts of each fit. To
+the chi2/Npts value for a specific *FitPage*, click the *Compute* button at the
+bottom of that *FitPage* to recalculate.
 
 Simultaneous Fits with Constraints
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Enter constraint in the text control next to *constraint fit*  button. 
-Constraint should be of type model1 parameter name = f(model2 parameter name) 
-for example, M0.radius=2*M1.radius. Many constraints can be entered for a 
-single fit. Each of them should be separated by a newline charater or ";" 
-The easy setup can generate many constraint inputs easily when the selected 
-two models are the same type.
-
-Note that the chi2/Npts returned is the sum of the chi2/Npts of each fits. 
-If one needs the chi2 value only for one fit, click the 'Compute' button in 
-the FitPage to recalculate.
+Use the *Easy Setup* drop-down buttons in the *Const & Simul Fit* page to set
+up constraints between *FitPage*'s.
+
+Constraints will generally be of the form Mi Parameter1 = Mj.Parameter1, however
+the text box after the '=' sign can be used to adjust this relationship; for
+example Mi Parameter1 = scalar*Mj.Parameter1. A 'free-form' constraint box is
+also provided.
+
+Many constraints can be entered for a single fit.
+
+The results of the model-fitting will be returned to each of the individual
+*FitPage*'s.
+
+Note that the chi2/Npts value returned is the SUM of the chi2/Npts of each fit. To
+the chi2/Npts value for a specific *FitPage*, click the *Compute* button at the
+bottom of that *FitPage* to recalculate.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ