Changeset 0390040 in sasview

Timestamp:

Jul 12, 2016 6:50:09 AM (8 years ago)

Author:

lewis

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

Children:

2fe78566

Parents:

8bdc103

Message:

Add tutorial to corfunc perspective help

Files:

• docs/sphinx-docs/source/user/analysis.rst (modified) (1 diff)
• src/sas/sasgui/perspectives/corfunc/media/corfunc_help.rst (modified) (3 diffs)
• src/sas/sasgui/perspectives/corfunc/media/tutorial1.png (added)
• src/sas/sasgui/perspectives/corfunc/media/tutorial2.png (added)
• src/sas/sasgui/perspectives/corfunc/media/tutorial3.png (added)

docs/sphinx-docs/source/user/analysis.rst

@@ -6 +6 @@
 .. toctree::
    :maxdepth: 1
-   
+
    Model Fitting <sasgui/perspectives/fitting/fitting>
-   
+
    P(r) Inversion <sasgui/perspectives/pr/pr_help>
-   
+
    Invariant Calculation <sasgui/perspectives/invariant/invariant_help>
+
+   Correlation Function <sasgui/perspectives/corfunc/corfunc_help>

src/sas/sasgui/perspectives/corfunc/media/corfunc_help.rst

@@ -92 +92 @@
 
 If Fourier is selected for the transform type, the perspective will perform a
-discrete cosine transform to the extrapolated data in order to calculate the
+discrete cosine transform on the extrapolated data in order to calculate the
 correlation function. The following algoritm is applied:
 
@@ -103 +103 @@
 ^^^^^^^
 If Hilbert is selected for the transform type, the perspective will perform a
-Hilbert transform to the extraplated data in order to calculate the Volume
+Hilbert transform on the extraplated data in order to calculate the Volume
 Fraction Profile.
 
@@ -128 +128 @@
 *   Polydispersity :math:`= \Gamma_{\text{min}}/\Gamma_{\text{max}}`
 *   Local Crystallinity :math:`= L_c/L_p`
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+Usage
+-----
+Upon sending data to the correlation function perspective, it will plot the data
+, as well as a red bar indicating the lower Q range (used for
+back-extrapolation), and 2 purple bars indicating the upper qrange (used for
+forwards-extraplation) [figure 3]. These bars may be moved my clicking and
+dragging, or by entering the appropriate value in the Q range input boxes.
+
+.. figure:: tutorial1.png
+   :align: center
+
+   **Figure 3** A plot of some data showing the Q range bars
+
+Once the Q ranges have been set, click the "Calculate" button next to the
+background input field to calculate the Bonart thermal background level.
+Alternatively, enter your own value into the field. Click the "Extrapolate"
+button to extrapolate the data and plot the extrapolation in the same figure
+as the original data. [figure 4]
+
+.. figure:: tutorial2.png
+   :align: center
+
+   **Figure 4** A plot showing the extrapolated data and the original data
+
+Then, select which type of transform you would like to perform, using the radio
+buttons:
+
+*   **Fourier** Perform a Fourier Transform to calculate the correlation
+    function of the extrapolated data
+*   **Hilbert** Perform a Hilbert Transform to calculate the volume fraction
+    profile of the extrapolated data
+
+Clicking the transform button will then perform the selected transform and plot
+it in a new figure. If a Fourier Transform was performed, the "Compute
+Parameters" button can also be clicked to calculate values for the output
+parameters [figure 5]
+
+ .. figure:: tutorial3.png
+    :align: center
+
+    **Figure 5** The Fourier Transform (correlation function) of the
+    extrapolated data, and the parameters extracted from it.