Changeset 0390040 in sasview


Ignore:
Timestamp:
Jul 12, 2016 6:50:09 AM (7 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:
3 added
2 edited

Legend:

Unmodified
Added
Removed
  • docs/sphinx-docs/source/user/analysis.rst

    r8f46df7 r0390040  
    66.. toctree:: 
    77   :maxdepth: 1 
    8     
     8 
    99   Model Fitting <sasgui/perspectives/fitting/fitting> 
    10     
     10 
    1111   P(r) Inversion <sasgui/perspectives/pr/pr_help> 
    12     
     12 
    1313   Invariant Calculation <sasgui/perspectives/invariant/invariant_help> 
     14 
     15   Correlation Function <sasgui/perspectives/corfunc/corfunc_help> 
  • src/sas/sasgui/perspectives/corfunc/media/corfunc_help.rst

    r41345d7e r0390040  
    9292 
    9393If Fourier is selected for the transform type, the perspective will perform a 
    94 discrete cosine transform to the extrapolated data in order to calculate the 
     94discrete cosine transform on the extrapolated data in order to calculate the 
    9595correlation function. The following algoritm is applied: 
    9696 
     
    103103^^^^^^^ 
    104104If Hilbert is selected for the transform type, the perspective will perform a 
    105 Hilbert transform to the extraplated data in order to calculate the Volume 
     105Hilbert transform on the extraplated data in order to calculate the Volume 
    106106Fraction Profile. 
    107107 
     
    128128*   Polydispersity :math:`= \Gamma_{\text{min}}/\Gamma_{\text{max}}` 
    129129*   Local Crystallinity :math:`= L_c/L_p` 
     130 
     131.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     132 
     133Usage 
     134----- 
     135Upon sending data to the correlation function perspective, it will plot the data 
     136, as well as a red bar indicating the lower Q range (used for 
     137back-extrapolation), and 2 purple bars indicating the upper qrange (used for 
     138forwards-extraplation) [figure 3]. These bars may be moved my clicking and 
     139dragging, or by entering the appropriate value in the Q range input boxes. 
     140 
     141.. figure:: tutorial1.png 
     142   :align: center 
     143 
     144   **Figure 3** A plot of some data showing the Q range bars 
     145 
     146Once the Q ranges have been set, click the "Calculate" button next to the 
     147background input field to calculate the Bonart thermal background level. 
     148Alternatively, enter your own value into the field. Click the "Extrapolate" 
     149button to extrapolate the data and plot the extrapolation in the same figure 
     150as the original data. [figure 4] 
     151 
     152.. figure:: tutorial2.png 
     153   :align: center 
     154 
     155   **Figure 4** A plot showing the extrapolated data and the original data 
     156 
     157Then, select which type of transform you would like to perform, using the radio 
     158buttons: 
     159 
     160*   **Fourier** Perform a Fourier Transform to calculate the correlation 
     161    function of the extrapolated data 
     162*   **Hilbert** Perform a Hilbert Transform to calculate the volume fraction 
     163    profile of the extrapolated data 
     164 
     165Clicking the transform button will then perform the selected transform and plot 
     166it in a new figure. If a Fourier Transform was performed, the "Compute 
     167Parameters" button can also be clicked to calculate values for the output 
     168parameters [figure 5] 
     169 
     170 .. figure:: tutorial3.png 
     171    :align: center 
     172 
     173    **Figure 5** The Fourier Transform (correlation function) of the 
     174    extrapolated data, and the parameters extracted from it. 
Note: See TracChangeset for help on using the changeset viewer.