Changeset 23a9beb in sasview for src/sas/invariant/media

Timestamp:

Feb 15, 2015 10:09:34 AM (10 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:

920928f

Parents:

898a8b9

Message:

Fixed rst errors

Location:

src/sas/invariant/media

Files:

• invariant_help.rst (modified) (9 diffs)
• pr_help.rst (modified) (3 diffs)

src/sas/invariant/media/invariant_help.rst

@@ -1 @@
-..invariant_help.rst
+.. invariant_help.rst
 
 .. This is a port of the original SasView html help file to ReSTructured text
@@ -7 +7 @@
 =================================
 
-1. Scattering Invariant_
-2. Volume Fraction_
-3. Specific Surface Area_
-4. Definitions_
-5. Reference_
-6. How to Use_
+Scattering_Invariant_
+
+Volume_Fraction_
+
+Specific_Surface_Area_
+
+Definitions_
+
+Reference_
+
+How_to_Use_
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-.. _Scattering Invariant:
+.. _Scattering_Invariant:
 
 Scattering Invariant
@@ -77 +82 @@
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-.. _Volume Fraction:
+.. _Volume_Fraction:
 
 Volume Fraction
@@ -94 +99 @@
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-.. _Specific Surface Area:
+.. _Specific_Surface_Area:
 
 Specific Surface Area
@@ -106 +111 @@
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-.. _Definitions
+.. _Definitions:
 
 Definitions
@@ -115 +120 @@
 I(Q): the scattering intensity as a function of the momentum transfer Q.
 
-Invariant total is the sum of the invariant calculated from data’s q range and 
+Invariant total is the sum of the invariant calculated from datas q range and
 the invariant resulting from extrapolation at low q range and at high q range 
 if considered.
@@ -129 +134 @@
 Press, New York, 1982
 
-http://physchem.kfunigraz.ac.at/sm/ <http://physchem.kfunigraz.ac.at/sm/>_
+http://physchem.kfunigraz.ac.at/sm/
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-.. _How to Use
+.. _How_to_Use:
 
 How to Use
@@ -149 +154 @@
 3. If you want to calculate the volume fraction and the specific surface 
 area, type the optional inputs in the customized input box, and then press 
-‘Compute’ button.
+'Compute' button.
 
 4. The invariant can also be calculated including the outside of the data Q 
 range:  To include the lower Q and/or the higher Q range, check in the enable 
-extrapolation check box in ‘Extrapolation ‘box. If the power low is chosen, 
+extrapolation check box in 'Extrapolation' box. If the power low is chosen,
 the power (exponent) can be either held or fitted by checking the 
 corresponding radio button.  The Npts that is being used for the extrapolation 
@@ -162 +167 @@
 proper to calculate the invariant.
 
-6. The details of the calculation is available by clicking the ‘Details’ 
+6. The details of the calculation is available by clicking the 'Details'
 button in the middle of the panel.
 

src/sas/invariant/media/pr_help.rst

@@ -1 @@
-..pr_help.rst
+.. pr_help.rst
 
 .. This is a port of the original SasView html help file to ReSTructured text
 .. by S King, ISIS, during SasView CodeCamp-III in Feb 2015.
+
+.. |pi| unicode:: U+03C0
+.. |chi| unicode:: U+03C7
 
 P(r) Inversion Perspective
@@ -9 +12 @@
 The inversion approach is based on Moore, J. Appl. Cryst., (1980) 13, 168-175.
 
-P(r) is set to be equal to an expansion of base functions  of the type 
-phi_n(r) = 2*r*sin(pi*n*r/D_max).
+P(r) is set to be equal to an expansion of base functions of the type
+phi_n(r) = 2 * r * sin(|pi| * n * r / D_max).
 
 The coefficient of each base function in the expansion is found by performing 
 a least square fit with the following fit function:
 
-chi**2 = sum_i[ I_meas(q_i) - I_th(q_i) ]**2/error**2 + Reg_term
+|chi| ^2 = sum_i[ I_meas(q_i) - I_th(q_i) ]^2 / error^2 + Reg_term
 
 where I_meas(q) is the measured scattering intensity and I_th(q) is the 
@@ -21 +24 @@
 
 The Reg_term term is a regularization term set to the second derivative 
-d**2P(r)/dr**2 integrated over r. It is used to produce a smooth P(r) output.
+d^2 P(r) / dr^2 integrated over r. It is used to produce a smooth P(r) output.
 
 The following are user inputs:
 
-   - Number of terms: the number of base functions in the P(r) expansion. 
+*  Number of terms: the number of base functions in the P(r) expansion.
    
-   - Regularization constant: a multiplicative constant to set the size of 
-the regularization term.
+*  Regularization constant: a multiplicative constant to set the size of
+   the regularization term.
 
-   - Maximum distance: the maximum distance between any two points in the 
+*  Maximum distance: the maximum distance between any two points in the
    system.