Changeset 98b30b4 in sasview

Timestamp:

Feb 17, 2015 8:35:07 AM (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:

3702c12

Parents:

a37b4e6

Message:

Dupilicate links resolved

Location:

src/sas

Files:

• guiframe/media/graph_help.rst (modified) (9 diffs)
• models/media/model_functions.rst (modified) (2 diffs)
• perspectives/calculator/media/data_operator_help.rst (added)
• perspectives/fitting/media/fitting_help.rst (modified) (15 diffs)

src/sas/guiframe/media/graph_help.rst

@@ -11 +11 @@
 2D_Data_Averaging_
 
-Key_Combinations_
+Key_Sequences_
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -20 +20 @@
 ----------
 
-Introduction_
+Invoking_the_Graph_Menu_
 
 Reset_Graph_
@@ -36 +36 @@
 Zoom_In_Out_
 
-Remove_Data_
+Remove_Data_from_Plot_
 
 Change_Scale_
@@ -44 +44 @@
 Other_Graph_Modifications_
 
-.. _Introduction:
+.. _Invoking_the_Graph_Menu:
 
 Introduction
@@ -118 +118 @@
 a region, select *left arrow*  or *right arrow*  button on the toolbar to set
 the graph the the previous size. If a mouse wheel button is available,
-*zoom in/out*  by scrolling the mouse wheel (see Key_Combinations_ help for
+*zoom in/out*  by scrolling the mouse wheel (see Key_Sequences_ help for
 details).
 
-.. _Remove_Data:
+.. _Remove_Data_from_Plot:
 
 Remove Data from Plot
@@ -182 +182 @@
 -----------------
 
-Description_
+Principle_
 
 How_to_Average_
@@ -204 +204 @@
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-.. _Description: 
-
-Description
------------
+.. Principle: 
+
+Principle
+---------
 
 This feature allows you to perform different types of averages on your data, 
@@ -314 +314 @@
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-.. _Key_Combinations:
-
-Key Combination
----------------
+.. _Key_Sequences:
+
+Key Sequences
+-------------
 
 Floating_Panel_
 
-Graph_Context_Menu_
+Context_Menu_
 
 Zoom_
@@ -338 +338 @@
 the menu bar. Otherwise choose 'Dock'.
 
-.. _Graph_Context_Menu:
+.. _Context_Menu:
 
 Graph Context Menu

src/sas/models/media/model_functions.rst

@@ -82 +82 @@
 Contents
 --------
-1. Introduction_
+1. Background_
 
 2. Model_ Functions
@@ -99 +99 @@
 
 
-.. _Introduction:
-
-1. Introduction
+.. _Background:
+
+1. Background
 ---------------
 

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

@@ -10 +10 @@
 .. |phi| unicode:: U+03C6
 .. |theta| unicode:: U+03B8
+.. |chi| unicode:: U+03C7
+
+.. |inlineimage004| image:: sm_image004.gif
+.. |inlineimage005| image:: sm_image005.gif
+.. |inlineimage008| image:: sm_image008.gif
+.. |inlineimage009| image:: sm_image009.gif
+.. |inlineimage010| image:: sm_image010.gif
+.. |inlineimage011| image:: sm_image011.gif
+.. |inlineimage012| image:: sm_image012.gif
+.. |inlineimage018| image:: sm_image018.gif
+.. |inlineimage019| image:: sm_image019.gif
+
 
 Fitting Perspective
@@ -61 +73 @@
 One of two fit-engines can be chosen from the Fitting menu bar. The Simple Fit-
 engine uses Scipy's leasqr and the Complex Fit-Engine is a custom optimizer 
-that provides a better chance to find the global minimum of the chi2 but that 
+that provides a better chance to find the global minimum of the |chi| 2 but that
 requires longer computation time. In order to set a data to a control panel 
 (FitPage), see the "DataLoader Help". Once a data set to the FiPage, select a 
@@ -532 +544 @@
 
 We use only these array values in the computation, therefore the mean value 
-given in the control panel, for example ‘radius = 60’, will be ignored.
+given in the control panel, for example ‘radius = 60’, will be ignored.
 
 .. _Gaussian_Distribution:
@@ -560 +572 @@
 normalization factor which will be determined during the numerical calculation. 
 The median value is the value given in the size parameter in the control panel, 
-for example, “radius = 60”.
+for example, “radius = 60â€ￜ.
 
 The PD (polydispersity) is given by /sigma/
@@ -588 +600 @@
 which is determined during the numerical calculation.
 
-The z = 1/p2– 1.
+The z = 1/p2– 1.
 
 The PD (polydispersity) is
@@ -628 +640 @@
 Equation 1
 
-The functions .. image:: sm_image004.gif and .. image:: sm_image005.gif
+The functions |inlineimage004| and |inlineimage005|
 refer to the slit width weighting function and the slit height weighting 
 determined at the q point, respectively. Here, we assumes that the weighting 
@@ -643 +655 @@
 Equation 3
 
-so that .. image:: sm_image008.gif .. image:: sm_image009.gif for
-.. image:: sm_image010.gif and u.
-
-The .. image:: sm_image011.gif and .. image:: sm_image012.gif stand for
+so that |inlineimage008| |inlineimage009| for |inlineimage010| and u.
+
+The |inlineimage011| and |inlineimage012| stand for
 the slit height (FWHM/2) and the slit width (FWHM/2) in the q space. Now the 
 integral of Equation 1 is simplified to
@@ -660 +671 @@
 ------
 
-For .. image:: sm_image012.gif = 0 and .. image:: sm_image011.gif = 
-constant.
+For |inlineimage012| = 0 and |inlineimage011| = constant.
 
 .. image:: sm_image016.gif
 
 For discrete q values, at the q values from the data points and at the q 
-values extended up to qN= qi + .. image:: sm_image011.gif the smeared 
+values extended up to qN= qi + |inlineimage011| the smeared 
 intensity can be calculated approximately
 
@@ -673 +683 @@
 Equation 5
 
-.. image:: sm_image018.gif = 0 for *Is* in *j* < *i* or *j* > N-1*.
+|inlineimage018| = 0 for *Is* in *j* < *i* or *j* > N-1*.
 
 Case 2
 ------
 
-For .. image:: sm_image012.gif = constant and 
-.. image:: sm_image011.gif = 0.
+For |inlineimage012| = constant and |inlineimage011| = 0.
 
 Similarly to Case 1, we get
 
-.. image:: sm_image019.gif for qp= qi- .. image:: sm_image012.gif
-
-and qN= qi+ .. image:: sm_image012.gif. .. image:: sm_image018.gif = 0
+|inlineimage019| for qp= qi- |inlineimage012| and qN= qi+ |inlineimage012|. |inlineimage018| = 0
 for *Is* in *j* < *p* or *j* > *N-1*.
 
@@ -691 +698 @@
 ------
 
-For .. image:: sm_image011.gif = constant and 
-.. image:: sm_image011.gif = constant.
+For |inlineimage011| = constant and 
+|inlineimage011| = constant.
 
 In this case, the best way is to perform the integration, Equation 1, 
@@ -707 +714 @@
 Equation 7
 
-for qp= qi- .. image:: sm_image012.gif and
-qN= qi+ .. image:: sm_image012.gif. .. image:: sm_image018.gif = 0 for
+for qp= qi- |inlineimage012| and
+qN= qi+ |inlineimage012|. |inlineimage018| = 0 for
 *Is* in *j* < *p* or *j* > *N-1*.
 
@@ -745 +752 @@
 In Equation 9, x0 = qcos/theta/ and y0 = qsin/theta/, and the primed axes 
 are in the coordinate rotated by an angle /theta/ around the z-axis (below) 
-so that x’0= x0cos/theta/+y0sin/theta/ and y’0= -x0sin/theta/+y0cos/theta/.
+so that x’0= x0cos/theta/+y0sin/theta/ and y’0= -x0sin/theta/+y0cos/theta/.
 
 Note that the rotation angle is zero for x-y symmetric elliptical Gaussian 
@@ -754 +761 @@
 Now we consider a numerical integration where each bins in /theta/ and R are 
 *evenly* (this is to simplify the equation below) distributed by /delta//theta/ 
-and /delta/R, respectively, and it is assumed that I(x’, y’) is constant 
+and /delta/R, respectively, and it is assumed that I(x’, y’) is constant 
 within the bins which in turn becomes
 
@@ -762 +769 @@
 
 Since we have found the weighting factor on each bin points, it is convenient 
-to transform x’-y’ back to x-y coordinate (rotating it by -/theta/ around z 
+to transform x’-y’ back to x-y coordinate (rotating it by -/theta/ around z 
 axis). Then, for the polar symmetric smear
 
@@ -940 +947 @@
 If this operation is successful, the new ftol value will be displayed in the 
 info line at the bottom of the SV window.Note that increasing the ftol value 
-may cause for the fitting to terminate with higher chisq.
+may cause for the fitting to terminate with higher |chi| sq.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ