Changeset 5ed76f8 in sasview for src/sas/sasgui/perspectives/fitting/media/residuals_help.rst

Timestamp:

Apr 7, 2017 1:11:41 AM (7 years ago)

Author:

Paul Kienzle <pkienzle@…>

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, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

fca1f50

Parents:

727c05f

Message:

docs: use latex in equations rather than unicode + rst markup

File:

• src/sas/sasgui/perspectives/fitting/media/residuals_help.rst (modified) (3 diffs)

src/sas/sasgui/perspectives/fitting/media/residuals_help.rst

@@ -18 +18 @@
 also provides two other measures of the quality of a fit:
 
-*  |chi|\  :sup:`2` (or 'Chi2'; pronounced 'chi-squared')
+*  $\chi^2$ (or 'Chi2'; pronounced 'chi-squared')
 *  *Residuals*
 
@@ -32 +32 @@
 *Npts* such that
 
-  *Chi2/Npts* = { SUM[(*Y_i* - *Y_theory_i*)^2 / (*Y_error_i*)^2] } / *Npts*
+.. math::
 
-This differs slightly from what is sometimes called the 'reduced chi-squared'
+  \chi^2/N_{pts} =  \sum[(Y_i - Y_{theory}_i)^2 / (Y_error_i)^2] } / N_{pts}
+
+This differs slightly from what is sometimes called the 'reduced $\chi^2$'
 because it does not take into account the number of fitting parameters (to
-calculate the number of 'degrees of freedom'), but the 'normalized chi-squared'
-and the 'reduced chi-squared' are very close to each other when *Npts* >> number of
-parameters.
+calculate the number of 'degrees of freedom'), but the 'normalized $\chi^2$
+and the 'reduced $\chi^2$ are very close to each other when $N_{pts} \gg
+\text{number of parameters}.
 
-For a good fit, *Chi2/Npts* tends to 0.
+For a good fit, $\chi^2/N_{pts}$ tends to 1.
 
-*Chi2/Npts* is sometimes referred to as the 'goodness-of-fit' parameter.
+$\chi^2/N_{pts}$ is sometimes referred to as the 'goodness-of-fit' parameter.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -53 +55 @@
 value and its *true* value is its error).
 
-*SasView* calculates 'normalized residuals', *R_i*, for each data point in the
+*SasView* calculates 'normalized residuals', $R_i$, for each data point in the
 fit:
 
-  *R_i* = (*Y_i* - *Y_theory_i*) / (*Y_err_i*)
+.. math::
 
-For a good fit, *R_i* ~ 0.
+  R_i = (Y_i - Y_theory_i) / (Y_err_i)
+
+For a good fit, $R_i \sim 0$.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ