Changeset 896abb3 in sasview for pr_inversion/__init__.py

Timestamp:

May 23, 2008 2:31:50 PM (16 years ago)

Author:

Mathieu Doucet <doucetm@…>

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:

ffca8f2

Parents:

a1718df

Message:

Added docs

File:

• pr_inversion/__init__.py (modified) (2 diffs)

pr_inversion/__init__.py

@@ -15 +15 @@
 # 
 # [1] P.B. Moore, J.Appl. Cryst (1980) 13, 168-175.
+#
 # [2] O. Glatter, J.Appl. Cryst (1977) 10, 415-421.
+#
 # [3] D.I. Svergun, J.Appl. Cryst (1991) 24, 485-492.
+#
 # [4] D.I. Svergun, J.Appl. Cryst (1992) 25, 495-503.
+#
 # [5] S. Hansen and J. Skov Pedersen, J.Appl. Cryst (1991) 24, 541-548.
 #
@@ -41 +45 @@
 #
 #
+# \subsection Tutorial
+# To create an inversion object:
+# \verbatim
+#from sans.pr.invertor import Invertor
+#    invertor = Invertor()
+# \endverbatim
+#
+# To set the maximum distance between any two points:
+# \verbatim
+#    invertor.d_max = 160.0
+# \endverbatim
+#
+# To set the regularization constant:
+# \verbatim
+#    invertor.alpha = 0.0007
+# \endverbatim
+#
+# To set the q, I(q) and error on I(q):
+# \verbatim
+#    invertor.x = q_vector
+#    invertor.y = Iq_vector
+#    invertor.err = dIq_vector
+# \endverbatim
+#
+# To perform the inversion. In this example, we choose
+# a P(r) expension wit 10 base functions.
+# \verbatim
+#    c_out, c_cov = invertor.invert(10)
+# \endverbatim
+# The c_out and c_cov are the set of coefficients and the covariance 
+# matrix for those coefficients, respectively.
+#
 # Examples are available as unit tests under sans.pr_inversion.test.
 #