Changeset 23a9beb in sasview


Ignore:
Timestamp:
Feb 15, 2015 10:09:34 AM (9 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
Files:
7 edited

Legend:

Unmodified
Added
Removed

  • src/sas/calculator/media/sld_calculator_help.rst

    r78f02c3 r23a9beb  
    33.. This is a port of the original SasView html help file to ReSTructured text 
    44.. by S King, ISIS, during SasView CodeCamp-III in Feb 2015. 
     5 
     6.. |Ang| unicode:: U+212B 
    57 
    68SLD Calculator Tool 
    … …  
    1214The neutron scattering length density is defined as 
    1315 
    14 SLD = (b_c1 +b_c2+...+b_cn )/Vm 
     16SLD = (b_c1 + b_c2 + ... + b_cn) / Vm 
    1517 
    1618where  
    … …  
    2426------------------------------- 
    2527 
    26 To calculate scattering length densities enter a compound and a mass density  
    27 and click "Calculate". Entering a wavelength value is optional (a default  
    28 value of 6.0 Angstroms will be used). 
     28To calculate scattering length densities enter the empirical formula of a  
     29compound and its mass density and click "Calculate". 
    2930 
    30 * Formula strings consist of counts and atoms such as "CaCO3+6H2O". 
     31Entering a wavelength value is optional (a default value of 6.0 |Ang| will  
     32be used). 
    3133 
    32 * Groups can be separated by *'+'* or *space*, so "CaCO3 6H2O" works as well. 
     34*  Formula strings consist of atoms and the number of them, such as "CaCO3+6H2O". 
    3335 
    34 * Groups and be defined using parentheses, such as "CaCO3(H2O)6". 
     36*  Groups can be separated by *'+'* or *space*, so "CaCO3 6H2O" works as well. 
    3537 
    36 * Parentheses can be nested, such as "(CaCO3(H2O)6)1". 
     38*  Groups can be defined using parentheses, such as "CaCO3(H2O)6". 
    3739 
    38 * Isotopes are represented by their index, e.g., "CaCO[18]3+6H2O", H[1], or  
    39 H[2]. 
     40*  Parentheses can be nested, such as "(CaCO3(H2O)6)1". 
    4041 
    41 * Counts can be integer or decimal, e.g. "CaCO3+(3HO0.5)2". 
     42*  Isotopes are represented by their atomic number in *square brackets*, such  
     43   as "CaCO[18]3+6H2O", H[1], or H[2]. 
    4244 
    43 * Other compositions can be calculated as well, for example, for a 70-30  
    44 mixture of H2O/D2O write *H14O7+ D6O3* or more simply *H7D3O5* (i.e. this says  
    45 7 hydrogens, 3 deuteriums, and 5 oxygens) and the mass density calculated  
    46 based on the percentages of H and D. 
     45*  Numbers of atoms can be integer or decimal, such as "CaCO3+(3HO0.5)2". 
    4746 
    48 * Type *C[13]6 H[2]12 O[18]6* for C(13)6H(2)12O(18)6 (6 Carbon-13 atoms, 12  
    49 deuterium atoms, and 6 Oxygen-18 atoms) 
     47*  The SLD of mixtures can be calculated as well. For example, for a 70-30  
     48   mixture of H2O/D2O write "H14O7+D6O3" or more simply "H7D3O5" (i.e. this says 
     49   7 hydrogens, 3 deuteriums, and 5 oxygens) and enter a mass density calculated 
     50   on the percentages of H2O and D2O. 
     51 
     52*  Type "C[13]6 H[2]12 O[18]6" for C(13)6H(2)12O(18)6 (6 Carbon-13 atoms, 12  
     53   deuterium atoms, and 6 Oxygen-18 atoms). 

  • src/sas/data_util/media/data_operator_help.rst

    r78f02c3 r23a9beb  
    1212last data set could be a number). 
    1313 
    14 When the data1 and data2 are selected, their x (or qx and qy for 2D) value(s)  
     14When data1 and data2 are selected, their x (or qx and qy for 2D) value(s) 
    1515must match with each other. 
    1616 
    … …  
    2222 
    23232) Select a data/theory in the drop down menus. When data2 is set to number,  
    24 type a number in the text control box. 
     24   type a number in the text control box. 
    2525 
    26263) Select an arithmetic operator symbol; + (for addition), - (for subtraction),  
    27 * (for multiplication), / (for division), and | (for combination of two data  
    28 sets). 
     27   * (for multiplication), / (for division), and | (for combination of two data 
     28   sets). 
    2929 
    30 If two data sets do not match, the operation will fail and the background color  
    31 of the combo box items will turn to red (WIN only). 
     30   If two data sets do not match, the operation will fail and the background color 
     31   of the combo box items will turn to red (WIN only). 
    3232 
    33334) If the operation is successful, hit the Apply button to make the new data. 
    34 Then the data name will be shown up in the data box in the data explorer. 
     34   Then the data name will be shown up in the data box in the data explorer. 
    3535 
    36 Note: The errors and warnings will be displayed at the bottom of the SasView  
     36Note: Any errors and warnings will be displayed at the bottom of the SasView 
    3737window. 
    3838 
    39 .. image:: data_oper_pic.png 
    40  
     39.. image:: image:: docs/sphinx-docs/source/user/calculator/media/data_oper_pic.png 

  • src/sas/fit/media/fitting_help.rst

    r898a8b9 r23a9beb  
    1515 
    1616Load_a_File_ 
     17 
    1718Single_Fit_ 
     19 
    1820Simultaneous_Fitting_ 
     21 
    1922Batch_Fitting_ 
     23 
    2024Model_Selection_ 
     25 
    2126Model_Category_Manager_ 
     27 
    2228Model_Functions_ 
     29 
    2330Custom_Model_Editor_ 
     31 
    2432Polydispersity_Distributions_ 
     33 
    2534Smearing_Computation_ 
    26 Polarisation/Magnetic_Scattering_ 
     35 
     36Polarisation_Magnetic_Scattering_ 
     37 
    2738Key_Combinations_ 
     39 
    2840Status_Bar_Help_ 
    2941 
    … …  
    100112------------- 
    101113 
    102 .. _Batch_Fit_ 
    103 .. _Batch_Window_ 
    104 .. _Edit_Grid_  
    105 .. _Save_Grid_  
    106 .. _Open_Batch_Results_  
    107 .. _Plot_  
    108 .. _View_Column_Cell_  
     114Batch_Fit_ 
     115 
     116Batch_Window_ 
     117 
     118Edit_Grid_ 
     119 
     120Save_Grid_ 
     121 
     122Open_Batch_Results_ 
     123 
     124Plot_ 
     125 
     126View_Column_Cell_ 
    109127 
    110128.. _Batch_Fit: 
    … …  
    117135Fitting menubar. 
    118136 
    119 .. image:: batch_button_area.bmp 
     137.. image:: docs/sphinx-docs/source/user/perspectives/fitting/batch_button_area.bmp 
    120138 
    121139Figure 1: MenuBar:  
    … …  
    154172Figure 2). 
    155173 
    156 .. image:: restore_batch_window.bmp 
     174.. image:: docs/sphinx-docs/source/user/perspectives/fitting/restore_batch_window.bmp 
    157175 
    158176Figure 2: Edit Menu:  
    … …  
    179197column in the grid. 
    180198 
    181 .. image:: edit_menu.bmp 
     199.. image:: docs/sphinx-docs/source/user/perspectives/fitting/edit_menu.bmp 
    182200 
    183201Figure 3: Edit Menu: 
    … …  
    191209.csv file. 
    192210 
    193  *Note:* The grid doesn't save the data array, fits, and the array residuals.  
    194  As a result, the 'View (fit) Results' functionality will be lost when  
    195  reloading the saved file. 
     211*Note:* The grid doesn't save the data array, fits, and the array residuals. 
     212As a result, the 'View (fit) Results' functionality will be lost when 
     213reloading the saved file. 
    196214 
    197215Warning! To ensure accuracy of saved fit results, it is recommended to save  
    … …  
    208226available only when at least one column will be removed from the grid. 
    209227 
    210 .. image:: file_menu.bmp 
     228.. image:: docs/sphinx-docs/source/user/perspectives/fitting/file_menu.bmp 
    211229 
    212230Figure 4: MenuBar: 
    … …  
    226244clicking on the plot button. 
    227245 
    228  *X/Y -Axis Selection Range* can be edited manually. These text controls  
    229  allow the following types of expression (operation can be + - * /, or pow) 
     246*X/Y -Axis Selection Range* can be edited manually. These text controls 
     247allow the following types of expression (operation can be + - * /, or pow) 
    230248  
    2312491) if the current axis label range is a function of 1 or more columns, write  
    … …  
    249267with valid entries for plotting to work. The dY-bar is optional (see Figure 5). 
    250268 
    251 .. image::plot_button.bmp 
     269.. image:: docs/sphinx-docs/source/user/perspectives/fitting/plot_button.bmp 
    252270 
    253271Figure 5: Plotting 
    … …  
    271289data and fits.  
    272290 
    273 .. image::view_button.bmp 
     291.. image:: docs/sphinx-docs/source/user/perspectives/fitting/view_button.bmp 
    274292 
    275293Figure 6: View Fits 
    … …  
    280298 
    281299Model_Type_  
    282 Change_Model_Parameters_  
    283 Write_your_Own_Model_  
     300 
     301Change_Model_Parameters_ 
     302 
     303Write_your_Own_Model_ 
    284304 
    285305.. _Model_Type: 
    … …  
    345365button (Fig. 2). 
    346366 
    347 .. image:: cat_fig0.bmp 
     367.. image:: docs/sphinx-docs/source/user/perspectives/fitting/cat_fig0.bmp 
    348368 
    349369Fig.1 
    350370 
    351 .. image:: cat_fig1.bmp 
     371.. image:: docs/sphinx-docs/source/user/perspectives/fitting/cat_fig1.bmp 
    352372 
    353373Fig.2 
    354374 
    355 .. image:: cat_fig2.bmp 
     375.. image:: docs/sphinx-docs/source/user/perspectives/fitting/cat_fig2.bmp 
    356376 
    357377Fig.3 
    … …  
    374394 
    375395Description_  
    376 New_  
    377 Sum_Multi_p1_p2_  
    378 Advanced_  
    379 Delete_  
     396 
     397New_ 
     398 
     399Sum_Multi_p1_p2_ 
     400 
     401Advanced_ 
     402 
     403Delete_ 
    380404 
    381405.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    … …  
    390414function are effective after it is re-selected from the combo-box menu. 
    391415 
    392 .. image:: edit_model_menu.bmp 
     416.. image:: docs/sphinx-docs/source/user/perspectives/fitting/edit_model_menu.bmp 
    393417 
    394418.. _New: 
    … …  
    400424can be viewed and further modified by the 'Advanced' option below. 
    401425 
    402 .. image:: new_model.bmp 
     426.. image:: docs/sphinx-docs/source/user/perspectives/fitting/new_model.bmp 
    403427 
    404428.. _Sum_Multi_p1_p2: 
    … …  
    413437for activation. Hit the 'Close' button when it's done. 
    414438 
    415 .. image:: sum_model.bmp 
     439.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sum_model.bmp 
    416440 
    417441.. _Advanced: 
    … …  
    422446The menu option shows all the files in the plugin_models folder. You can edit,  
    423447modify, and save it. It is recommended to modify only the lines with arrow  
    424 (--`-----). In the end of edit, 'Compile' and 'Run' from the menu bar to  
     448(-------). In the end of edit, 'Compile' and 'Run' from the menu bar to 
    425449activate or to see the model working properly. 
    426450 
    … …  
    470494------------------------ 
    471495 
    472 .. image:: img/pd_image001.png 
     496.. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image001.png 
    473497 
    474498The xmean is the mean of the distribution, w is the half-width, and Norm is a  
    … …  
    478502The standard deviation is 
    479503 
    480 .. image:: img/pd_image002.png 
     504.. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image002.png 
    481505 
    482506The PD (polydispersity) is 
    483507 
    484 .. image:: img/pd_image003.png 
    485  
    486 .. image:: img/pd_image004.jpg 
     508.. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image003.png 
     509 
     510.. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image004.jpg 
    487511 
    488512.. _Array_Distribution: 
    … …  
    513537--------------------- 
    514538 
    515 .. image:: img/pd_image005.png 
     539.. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image005.png 
    516540 
    517541The xmean is the mean of the distribution and Norm is a normalization factor  
    … …  
    520544The PD (polydispersity) is 
    521545 
    522 .. image:: img/pd_image003.png 
    523  
    524 .. image:: img/pd_image006.jpg 
     546.. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image003.png 
     547 
     548.. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image006.jpg 
    525549 
    526550.. _Lognormal_Distribution: 
    … …  
    529553---------------------- 
    530554 
    531 .. image:: img/pd_image007.png 
     555.. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image007.png 
    532556 
    533557The /mu/=ln(xmed), xmed is the median value of the distribution, and Norm is a  
    … …  
    538562The PD (polydispersity) is given by /sigma/ 
    539563 
    540 .. image:: img/pd_image008.png 
     564.. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image008.png 
    541565 
    542566For the angular distribution 
    543567 
    544 .. image:: img/pd_image009.png 
     568.. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image009.png 
    545569 
    546570The mean value is given by xmean=exp(/mu/+p2/2). The peak value is given by  
    547571xpeak=exp(/mu/-p2). 
    548572 
    549 .. image:: img/pd_image010.jpg 
     573.. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image010.jpg 
    550574 
    551575This distribution function spreads more and the peak shifts to the left as the  
    … …  
    557581------------------- 
    558582 
    559 .. image:: img/pd_image011.png 
    560  
    561 The xmeanis the mean of the distribution and Norm is a normalization factor  
     583.. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image011.png 
     584 
     585The xmean is the mean of the distribution and Norm is a normalization factor 
    562586which is determined during the numerical calculation. 
    563587 
    … …  
    566590The PD (polydispersity) is 
    567591 
    568 .. image:: img/pd_image012.png 
     592.. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image012.png 
    569593 
    570594Note that the higher PD (polydispersity) might need higher values of Npts and  
    … …  
    572596Nsigmas >= 15 at least. 
    573597 
    574 .. image:: img/pd_image013.jpg 
     598.. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image013.jpg 
    575599 
    576600.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    … …  
    582606 
    583607Slit_Smearing_  
    584 Pinhole_Smearing_  
    585 2D_Smearing_  
     608 
     609Pinhole_Smearing_ 
     610 
     6112D_Smearing_ 
    586612 
    587613.. _Slit_Smearing: 
    … …  
    592618The sit smeared scattering intensity for SAS is defined by 
    593619 
    594 .. image:: img/sm_image002.gif 
     620.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image002.gif 
    595621 
    596622where Norm = 
    597623 
    598 .. image:: img/sm_image003.gif 
     624.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image003.gif 
    599625 
    600626Equation 1 
    601627 
    602 The functions .. image:: img/sm_image004.gif and .. image:: img/sm_image005.gif 
     628The functions .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image004.gif and .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image005.gif 
    603629refer to the slit width weighting function and the slit height weighting  
    604630determined at the q point, respectively. Here, we assumes that the weighting  
    605631function is described by a rectangular function, i.e., 
    606632 
    607 .. image:: img/sm_image006.gif 
     633.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image006.gif 
    608634 
    609635Equation 2 
    … …  
    611637and 
    612638 
    613 .. image:: img/sm_image007.gif 
     639.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image007.gif 
    614640 
    615641Equation 3 
    616642 
    617 so that .. image:: img/sm_image008.gif .. image::img/sm_image009.gif for  
    618 .. image:: img/sm_image010.gif and u. 
    619  
    620 The .. image::img/sm_image011.gif and .. image::img/sm_image012.gif stand for  
     643so that .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image008.gif .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image009.gif for 
     644.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image010.gif and u. 
     645 
     646The .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image011.gif and .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image012.gif stand for 
    621647the slit height (FWHM/2) and the slit width (FWHM/2) in the q space. Now the  
    622648integral of Equation 1 is simplified to 
    623649 
    624 .. image:: img/sm_image013.gif 
     650.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image013.gif 
    625651 
    626652Equation 4 
    … …  
    632658------ 
    633659 
    634 For .. image:: img/sm_image012.gif = 0 and .. image:: img/sm_image011.gif =  
     660For .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image012.gif = 0 and .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image011.gif =  
    635661constant. 
    636662 
    637 .. image:: img/sm_image016.gif 
     663.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image016.gif 
    638664 
    639665For discrete q values, at the q values from the data points and at the q  
    640 values extended up to qN= qi + .. image:: img/sm_image011.gif the smeared  
     666values extended up to qN= qi + .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image011.gif the smeared  
    641667intensity can be calculated approximately 
    642668 
    643 .. image:: img/sm_image017.gif 
     669.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image017.gif 
    644670 
    645671Equation 5 
    646672 
    647 .. image:: img/sm_image018.gif = 0 for *Is* in *j* < *i* or *j* > N-1*. 
     673.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image018.gif = 0 for *Is* in *j* < *i* or *j* > N-1*. 
    648674 
    649675Case 2 
    650676------ 
    651677 
    652 For .. image:: img/sm_image012.gif = constant and  
    653 .. image:: img/sm_image011.gif = 0. 
     678For .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image012.gif = constant and  
     679.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image011.gif = 0. 
    654680 
    655681Similarly to Case 1, we get 
    656682 
    657 .. image:: img/sm_image019.gif for qp= qi-.. image:: img/sm_image012.gif  
    658 and qN= qi+.. image:: img/sm_image012.gif. .. image:: img/sm_image018.gif = 0  
     683.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image019.gif for qp= qi- .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image012.gif 
     684 
     685and qN= qi+ .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image012.gif. .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image018.gif = 0 
    659686for *Is* in *j* < *p* or *j* > *N-1*. 
    660687 
    … …  
    662689------ 
    663690 
    664 For .. image:: img/sm_image011.gif = constant and  
    665 .. image:: img/sm_image011.gif = constant. 
     691For .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image011.gif = constant and  
     692.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image011.gif = constant. 
    666693 
    667694In this case, the best way is to perform the integration, Equation 1,  
    … …  
    674701numerical integration for the slit width. 
    675702 
    676 .. image:: img/sm_image020.gif 
     703.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image020.gif 
    677704 
    678705Equation 7 
    679706 
    680 for qp= qi-.. image:: img/sm_image012.gif and  
    681 qN= qi+.. image:: img/sm_image012.gif. .. image:: img/sm_image018.gif = 0 for  
     707for qp= qi- .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image012.gif and 
     708qN= qi+ .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image012.gif. .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image018.gif = 0 for 
    682709*Is* in *j* < *p* or *j* > *N-1*. 
    683710 
    684 .. Pinhole_Smearing: 
     711.. _Pinhole_Smearing: 
    685712 
    686713Pinhole Smearing 
    … …  
    691718for this case becomes 
    692719 
    693 .. image:: img/sm_image021.gif 
     720.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image021.gif 
    694721 
    695722Equation 8 
    … …  
    710737except that the weight function used was the 2D elliptical Gaussian function 
    711738 
    712 .. image:: img/sm_image022.gif 
     739.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image022.gif 
    713740 
    714741Equation 9 
    … …  
    721748distribution. The A is a normalization factor. 
    722749 
    723 .. image:: img/sm_image023.gif 
     750.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image023.gif 
    724751 
    725752Now we consider a numerical integration where each bins in /theta/ and R are  
    … …  
    728755within the bins which in turn becomes 
    729756 
    730 .. image:: img/sm_image024.gif 
     757.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image024.gif 
    731758 
    732759Equation 10 
    … …  
    736763axis). Then, for the polar symmetric smear 
    737764 
    738 .. image:: img/sm_image025.gif 
     765.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image025.gif 
    739766 
    740767Equation 11 
    … …  
    742769where 
    743770 
    744 .. image:: img/sm_image026.gif 
     771.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image026.gif 
    745772 
    746773while for the x-y symmetric smear 
    747774 
    748 .. image:: img/sm_image027.gif 
     775.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image027.gif 
    749776 
    750777Equation 12 
    … …  
    752779where 
    753780 
    754 .. image:: img/sm_image028.gif 
     781.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image028.gif 
    755782 
    756783Here, the current version of the SasView uses Equation 11 for 2D smearing  
    … …  
    782809vector *Q* contributes to the the magnetic scattering length. 
    783810 
    784 ... image:: img/mag_vector.bmp 
     811.. image:: docs/sphinx-docs/source/user/perspectives/fitting/mag_vector.bmp 
    785812 
    786813The magnetic scattering length density is then 
    787814 
    788 .. image:: img/dm_eq.gif 
     815.. image:: docs/sphinx-docs/source/user/perspectives/fitting/dm_eq.gif 
    789816 
    790817where /gamma/ = -1.913 the gyromagnetic ratio, /mu/B is the Bohr magneton, r0  
    … …  
    799826Spin flips:     (+ -) and (- +) 
    800827 
    801 .. image:: img/M_angles_pic.bmp 
     828.. image:: docs/sphinx-docs/source/user/perspectives/fitting/M_angles_pic.bmp 
    802829 
    803830Now, let's assume that the angles of the *Q*  vector and the spin-axis (x')  
    … …  
    807834as, for non-spin-flips 
    808835 
    809 .. image:: img/sld1.gif 
     836.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sld1.gif 
    810837 
    811838for spin-flips 
    812839 
    813 .. image:: img/sld2.gif 
     840.. image:: docs/sphinx-docs/source/user/perspectives/fitting/sld2.gif 
    814841 
    815842where 
    816843 
    817 .. image:: img/mxp.gif 
    818  
    819 .. image:: img/myp.gif 
    820  
    821 .. image:: img/mzp.gif 
    822  
    823 .. image:: img/mqx.gif 
    824  
    825 .. image:: img/mqy.gif 
     844.. image:: docs/sphinx-docs/source/user/perspectives/fitting/mxp.gif 
     845 
     846.. image:: docs/sphinx-docs/source/user/perspectives/fitting/myp.gif 
     847 
     848.. image:: docs/sphinx-docs/source/user/perspectives/fitting/mzp.gif 
     849 
     850.. image:: docs/sphinx-docs/source/user/perspectives/fitting/mqx.gif 
     851 
     852.. image:: docs/sphinx-docs/source/user/perspectives/fitting/mqy.gif 
    826853 
    827854Here, the M0x, M0y and M0z are the x, y and z components of the magnetization  
    … …  
    829856and /phi/M as defined in the Figure (above) 
    830857 
    831 .. image:: img/m0x_eq.gif 
    832  
    833 .. image:: img/m0y_eq.gif 
    834  
    835 .. image:: img/m0z_eq.gif 
     858.. image:: docs/sphinx-docs/source/user/perspectives/fitting/m0x_eq.gif 
     859 
     860.. image:: docs/sphinx-docs/source/user/perspectives/fitting/m0y_eq.gif 
     861 
     862.. image:: docs/sphinx-docs/source/user/perspectives/fitting/m0z_eq.gif 
    836863 
    837864The user input parameters are M0_sld = DMM0, Up_theta = /theta/up,  
    … …  
    843870neutrons before the sample and at the analyzer, respectively. 
    844871 
    845 *Note: The values of the 'Up_frac_i' and 'Up_frac_f' must be in the range  
     872*Note:* The values of the 'Up_frac_i' and 'Up_frac_f' must be in the range 
    846873between 0 and 1. 
    847874 
    … …  
    854881 
    855882Copy_Paste_ 
     883 
    856884Bookmark_ 
     885 
    857886Graph_Context_Menu_ 
     887 
    858888FTolerance_ 
    859889 
    … …  
    918948 
    919949Message_Warning_Hint_  
    920 Console_  
     950 
     951Console_ 
    921952 
    922953.. _Message_Warning_Hint: 

  • src/sas/guiframe/media/data_explorer_help.rst

    r78f02c3 r23a9beb  
    1 .. _data_explorer_help.rst 
     1.. data_explorer_help.rst 
    22 
    33.. This is a port of the original SasView html help file to ReSTructured text 
    … …  
    77============ 
    88 
    9 1. Introduction_  
    10 2. Load Data_ 
    11 3. Handy Menu_ 
    12 4. Activate Data_ 
    13 5. Remove Data_ 
    14 6. Append Plot to Graph_ 
    15 7. Create New Plot_ 
    16 8. Freeze Theory_ 
    17 9. Send Data to Applications_ 
     9Introduction_ 
     10 
     11Load_Data_ 
     12 
     13Handy_Menu_ 
     14 
     15Activate_Data_ 
     16 
     17Remove_Data_ 
     18 
     19Append_Plot_to_Graph_ 
     20 
     21Create_New_Plot_ 
     22 
     23Freeze_Theory_ 
     24 
     25Send_Data_to_Applications_ 
    1826 
    1927.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    … …  
    2331Introduction 
    2432------------ 
     33 
    2534*Data Explorer* is a panel that allows the user more interactions with data.  
    2635Some functionalities provided by the Data Explorer are also available through  
    … …  
    3544.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    3645 
    37 .. _Load Data: 
     46.. _Load_Data: 
    3847 
    3948Load Data 
    … …  
    4857.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    4958 
    50 .. _Handy Menu: 
     59.. _Handy_Menu: 
    5160 
    5261Handy Menu 
    … …  
    5766context menu. 
    5867 
    59 .. _ image:: hand_menu.png 
     68.. image:: hand_menu.png 
    6069 
    6170.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    6271 
    63 .. _Activate Data: 
     72.. _Activate_Data: 
    6473 
    6574Activate Data 
    … …  
    7584.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    7685 
    77 .. _Remove Data: 
     86.. _Remove_Data: 
    7887 
    7988Remove Data 
    … …  
    8695.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    8796 
    88 .. _Append Plot to Graph: 
     97.. _Append_Plot_to_Graph: 
    8998 
    9099Append Plot to Graph 
    … …  
    100109.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    101110 
    102 .. _Create New Plot: 
     111.. _Create_New_Plot: 
    103112 
    104113Create New Plot 
    … …  
    110119.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    111120 
    112 .. _Freeze Theory: 
     121.. _Freeze_Theory: 
    113122 
    114123Freeze Theory 
    … …  
    120129.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    121130 
    122 .. _Send to application: 
     131.. _Send_Data_to_Applications: 
    123132 
    124133Send to Application 

  • src/sas/guiframe/media/graph_help.rst

    r78f02c3 r23a9beb  
    1 ..graph_help.rst 
     1.. graph_help.rst 
    22 
    33.. This is a port of the original SasView html help file to ReSTructured text 
    … …  
    77==================== 
    88 
    9 1. Graph Menu_ 
    10 2. 2D Data Averaging_ 
    11 3. Key Combinations_ 
    12  
    13 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    14  
    15 .. _Graph menu: 
     9Graph_Menu_ 
     10 
     112D_Data_Averaging_ 
     12 
     13Key_Combinations_ 
     14 
     15.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     16 
     17.. _Graph_Menu: 
    1618 
    1719Graph Menu 
    1820---------- 
    1921 
    20 Introduction_  
    21 Reset Graph_  
    22 Hide/Show/Delete Graph_  
    23 Data Info_  
    24 Save Plot Image_  
    25 Save Data_  
    26 Drag Plot_  
    27 Zoom In/Out_  
    28 Remove Data_  
    29 Change Scale_  
    30 Linear Fit_  
    31 Other Graph Modifications_  
    32  
    33 .. _Introduction:  
     22Introduction_ 
     23 
     24Reset_Graph_ 
     25 
     26Hide_Show_Delete_Graph_ 
     27 
     28Data_Info_ 
     29 
     30Save_Plot_Image_ 
     31 
     32Save_Data_ 
     33 
     34Drag_Plot_ 
     35 
     36Zoom_In_Out_ 
     37 
     38Remove_Data_ 
     39 
     40Change_Scale_ 
     41 
     42Linear_Fit_ 
     43 
     44Other_Graph_Modifications_ 
     45 
     46.. _Introduction: 
     47 
     48Introduction 
     49------------ 
    3450 
    3551Locating the pointer and right-clicking on a data/theory plot will bring a  
    3652context menu. On the menu, select a menu item. 
    3753 
    38 .. _Reset Graph:  
     54.. _Reset_Graph: 
     55 
     56Reset Graph 
     57----------- 
    3958 
    4059To reset the graph's axis range, right click on the plot and the context menu  
    … …  
    4261the 'home' icon in tool bar will do the same. 
    4362 
    44 .. _Hide/Show/Delete Graph:  
     63.. _Hide_Show_Delete_Graph: 
     64 
     65Hide/Show/Delete Graph 
     66---------------------- 
    4567 
    4668To Hide, click the Hide (bar) button in the tool bar.To Show, select the the  
    … …  
    5173computation. 
    5274 
    53 .. _Save Plot Image:  
     75.. _Data_Info: 
     76 
     77Data Info 
     78--------- 
     79 
     80From the context menu, select 'Data Info' to see the data information dialog 
     81panel. 
     82 
     83.. _Save_Plot_Image: 
     84 
     85Save Plot Image 
     86--------------- 
    5487 
    5588Right click on plot. Context menu will pop-up select save image [file name]. 
    … …  
    5790*Save Image.* 
    5891 
    59 .. _Data Info:  
    60  
    61 From the context menu, select 'Data Info' to see the data information dialog  
    62 panel. 
    63  
    64 .. _Save Data:  
     92.. _Save_Data: 
     93 
     94Save Data 
     95--------- 
    6596 
    6697From the context menu, select 'Save points as a file' for 1D, or 'Save as a  
    … …  
    6899saving. 
    69100 
    70 .. _Drag Plot:  
     101.. _Drag_Plot: 
     102 
     103Drag Plot 
     104--------- 
    71105 
    72106Select the *crossed arrows*  button on the plot panel *toolbar*  to drag the  
    73107plot. To disable dragging mode, unselect the same button on the toolbar. 
    74108 
    75 .. _Remove data from plot:  
    76  
    77 Highlight the plot and the context menu appears.Select *remove [file name]*.  
     109.. _Zoom_In_Out: 
     110 
     111Zoom In/Out 
     112----------- 
     113 
     114Select the *rectangle*  button on the plot panel *toolbar*  to zoom in a 
     115region of the plot. 
     116 
     117To disable zoom mode, unselect the same button on the toolbar. After zoom in 
     118a region, select *left arrow*  or *right arrow*  button on the toolbar to set 
     119the graph the the previous size. If a mouse wheel button is available, 
     120*zoom in/out*  by scrolling the mouse wheel (see Key_Combinations_ help for 
     121details). 
     122 
     123.. _Remove_Data: 
     124 
     125Remove Data from Plot 
     126--------------------- 
     127 
     128Highlight the plot and the context menu appears.Select *remove [file name]*. 
    78129The plot selected will disappear. 
    79130 
    80 .. _Zoom In/Out:  
    81  
    82 Select the *rectangle*  button on the plot panel *toolbar*  to zoom in a  
    83 region of the plot. 
    84  
    85 To disable zoom mode, unselect the same button on the toolbar. After zoom in  
    86 a region, select *left arrow*  or *right arrow*  button on the toolbar to set  
    87 the graph the the previous size. If a mouse wheel button is available,  
    88 *zoom in/out*  by scrolling the mouse wheel (see Key combination_ help for  
    89 details). 
    90  
    91 .. _Change Scale:  
     131.. _Change_Scale: 
     132 
     133Change Scale 
     134------------ 
    92135 
    93136If the loaded data is a 1-D data changing scale or data representation will  
    94137work as follows. *Right click* on the plot window. A context menu pops-up and  
    95138select *Change Scale* . A dialog window titled *select the scale of the graph*  
    96 will pop-up then change the *x* , the *y*  and the *view*  values as wish.  
     139will pop-up then change the *x* , the *y*  and the *view*  values as wish. 
     140 
    97141The 'view' option includes the axis scale short-cuts such as Linear, Guinier,  
    98142Cross-sectional (XC) Guinier, and Porod plot scale. For a proper data set,  
    … …  
    103147bar. 
    104148 
    105 .. _Linear Fit:  
    106  
    107 Linear fit is to perform a line model fitting keeping the scale of the plot.  
    108 Highlight data to fit. From the context menu select *Linear Fit* . A dialog  
    109 window appears. Change model initial parameters, data limits and hit *fit*  
    110 button. New parameters values are displayed and the line with the new  
    111 parameters is added to the plot. Especially for Guinier, XC Guinier, and  
    112 Porod plot scale, this 'Linear Fit' will provides Rg, Rod diameter, and  
    113 background, respectively. The following figure shows an example for the  
     149If the loaded data is an image. *Right click*  on the image to pop-up the 
     150context menu. Select to switch from linear to log scale. The scale selected is 
     151printed on the status bar. 
     152 
     153.. _Linear_Fit: 
     154 
     155Linear Fit 
     156---------- 
     157 
     158Linear fit is to perform a line model fitting keeping the scale of the plot. 
     159Highlight data to fit. From the context menu select *Linear Fit* . A dialog 
     160window appears. Change model initial parameters, data limits and hit *fit* 
     161button. New parameters values are displayed and the line with the new 
     162parameters is added to the plot. Especially for Guinier, XC Guinier, and 
     163Porod plot scale, this 'Linear Fit' will provides Rg, Rod diameter, and 
     164background, respectively. The following figure shows an example for the 
    114165Guinier scale. 
    115166 
    116 .. _Change scale 
    117  
    118 If the loaded data is a 1-D data changing scale or data representation will  
    119 work as follows. *Right click* on the plot window. A context menu pops-up and  
    120 select *Change Scale* . A dialog window titled *select the scale of the graph*  
    121 will pop-up then change the *x* , the *y*  and the *view*  values as wish.  
    122 If the loaded data is an image. *Right click*  on the image to pop-up the  
    123 context menu. Select to switch from linear to log scale. The scale selected is  
    124 printed on the statusbar. 
    125  
    126167.. image:: guinier_fit.png 
    127168 
    128 .. _Other Graph Modifications:  
     169.. _Other_Graph_Modifications: 
     170 
     171Other Graph Modifications 
     172------------------------- 
    129173 
    130174Some custom modifications of the symbols, text, axis, etc of the graph are  
    131 provided 
    132  
    133 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    134  
    135 .. _2D data averaging 
     175provided. 
     176 
     177.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     178 
     179.. _2D_Data_Averaging: 
    136180 
    1371812D Data Averaging 
    138182----------------- 
    139183 
    140 Description_  
    141 How to Average_  
    142 Available Averagings_ 
    143 Perform Circular Average_  
    144 Masked Circular Average_  
    145 Sector [Q view]_  
    146 Annulus [Phi view]_  
    147 Box Sum_  
    148 Box Averaging in Qx_  
    149 Box Averaging in Qy_  
     184Description_ 
     185 
     186How_to_Average_ 
     187 
     188Available_Averagings_ 
     189 
     190Unmasked_Circular_Average_ 
     191 
     192Masked_Circular_Average_ 
     193 
     194Sector_Average_ 
     195 
     196Annular_Average_ 
     197 
     198Box_Sum_ 
     199 
     200Box_Averaging_in_Qx_ 
     201 
     202Box_Averaging_in_Qy_ 
    150203 
    151204.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    152205 
    153206.. _Description:  
     207 
     208Description 
     209----------- 
    154210 
    155211This feature allows you to perform different types of averages on your data,  
    … …  
    158214dragging the lines around. 
    159215 
    160 .. _How to Average  
     216.. _How_to_Average: 
     217 
     218How to Average 
     219-------------- 
    161220 
    162221Right click on 2D data for the context menu to appear. Select one type of  
    … …  
    180239data.The user can also enter values to select a region. 
    181240 
    182 .. _Available Averagings: 
    183  
    184 ??? 
    185  
    186 .. _Perform Circular Average:  
    187  
    188 It will perform and average in constant q-rings around the (x,y) pixel  
     241.. _Available_Averagings: 
     242 
     243Available Averagings 
     244-------------------- 
     245 
     246Some different types of averaging are provided for. 
     247 
     248.. _Unmasked_Circular_Average: 
     249 
     250Unmasked Circular Average 
     251------------------------- 
     252 
     253This operation will perform and average in constant q-rings around the (x,y) pixel 
    189254location of the beam center. 
    190255 
    191 .. _Masked Circular Average:  
    192  
    193 This operation is same as 'Perform Circular Average' except that the masked  
     256.. _Masked_Circular_Average: 
     257 
     258Masked Circular Average 
     259----------------------- 
     260 
     261This operation is same as 'Masked Circular Average' except that the masked 
    194262region is excluded if masked. 
    195263 
    196 .. _Sector [Q view]:  
    197  
    198 It averages in constant q-arcs. The width of the sector is specified in  
    199 degrees (+/- delta phi) each direction from the central angle (phi). 
    200  
    201 .. _Annulus [Phi view]:  
     264.. _Sector_Average: 
     265 
     266Sector Average [Q View] 
     267----------------------- 
     268 
     269This operation averages in constant q-arcs. The width of the sector is specified in 
     270degrees (+/- delta phi) each side of the central angle (phi). 
     271 
     272.. _Annular_Average: 
     273 
     274Annular Average [Phi View] 
     275-------------------------- 
    202276 
    203277It performs an average between two q-values centered in (0,0), and averaged  
    … …  
    207281outer circle. The angle zero starts from the positive x-axis direction. 
    208282 
    209 .. _Box Sum:  
     283.. _Box_Sum: 
     284 
     285Box Sum 
     286------- 
    210287 
    211288Perform the sum of counts in a 2D region of interest.When editing the slicer,  
    … …  
    213290coordinates of the center of this rectangle. 
    214291 
    215 .. _Box Averaging in Qx:  
     292.. _Box_Averaging_in_Qx: 
     293 
     294Box Averaging in Qx 
     295------------------- 
    216296 
    217297Computes average I(Qx) for a region of interest. When editing the slicer, the  
    … …  
    221301on the x-axis. 
    222302 
    223 .. _Box Averaging in Qy:  
     303.. _Box_Averaging_in_Qy: 
     304 
     305Box Averaging in Qy 
     306------------------- 
    224307 
    225308Computes average I(Qy) for a region of interest.When editing the slicer, the  
    … …  
    231314.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    232315 
    233 .. _Key combination 
     316.. _Key_Combinations: 
    234317 
    235318Key Combination 
    236319--------------- 
    237320 
    238 Floating Panel_  
    239 Graph Context Menu_  
    240 Zoom In and Out_  
    241  
    242 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    243  
    244 .. _Floating Panel:  
     321Floating_Panel_ 
     322 
     323Graph_Context_Menu_ 
     324 
     325Zoom_ 
     326 
     327.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     328 
     329.. _Floating_Panel: 
     330 
     331Floating Panel 
     332-------------- 
    245333 
    246334For a graph panel to float on the top of the SV window: 
    … …  
    250338the menu bar. Otherwise choose 'Dock'. 
    251339 
    252 .. _Graph Context Menu:  
     340.. _Graph_Context_Menu: 
     341 
     342Graph Context Menu 
     343------------------ 
    253344 
    254345To get the graph context menu to print, copy, save data, (2D)average, etc,  
    … …  
    256347to bring up the full menu. 
    257348 
    258 .. _Zoom In and Out:  
     349.. _Zoom: 
     350 
     351Zoom In/Out 
     352----------- 
    259353 
    260354To Zoom in or out the full plot, *locate the mouse point inside the graph  

  • src/sas/invariant/media/invariant_help.rst

    r78f02c3 r23a9beb  
    1 ..invariant_help.rst 
     1.. invariant_help.rst 
    22 
    33.. This is a port of the original SasView html help file to ReSTructured text 
    … …  
    77================================= 
    88 
    9 1. Scattering Invariant_ 
    10 2. Volume Fraction_ 
    11 3. Specific Surface Area_ 
    12 4. Definitions_ 
    13 5. Reference_ 
    14 6. How to Use_ 
     9Scattering_Invariant_ 
     10 
     11Volume_Fraction_ 
     12 
     13Specific_Surface_Area_ 
     14 
     15Definitions_ 
     16 
     17Reference_ 
     18 
     19How_to_Use_ 
    1520 
    1621.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    1722 
    18 .. _Scattering Invariant: 
     23.. _Scattering_Invariant: 
    1924 
    2025Scattering Invariant 
    … …  
    7782.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    7883 
    79 .. _Volume Fraction: 
     84.. _Volume_Fraction: 
    8085 
    8186Volume Fraction 
    … …  
    9499.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    95100 
    96 .. _Specific Surface Area: 
     101.. _Specific_Surface_Area: 
    97102 
    98103Specific Surface Area 
    … …  
    106111.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    107112 
    108 .. _Definitions 
     113.. _Definitions: 
    109114 
    110115Definitions 
    … …  
    115120I(Q): the scattering intensity as a function of the momentum transfer Q. 
    116121 
    117 Invariant total is the sum of the invariant calculated from data’s q range and  
     122Invariant total is the sum of the invariant calculated from datas q range and 
    118123the invariant resulting from extrapolation at low q range and at high q range  
    119124if considered. 
    … …  
    129134Press, New York, 1982 
    130135 
    131 http://physchem.kfunigraz.ac.at/sm/ <http://physchem.kfunigraz.ac.at/sm/>_ 
     136http://physchem.kfunigraz.ac.at/sm/ 
    132137 
    133138.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    134139 
    135 .. _How to Use 
     140.. _How_to_Use: 
    136141 
    137142How to Use 
    … …  
    1491543. If you want to calculate the volume fraction and the specific surface  
    150155area, type the optional inputs in the customized input box, and then press  
    151 ‘Compute’ button. 
     156'Compute' button. 
    152157 
    1531584. The invariant can also be calculated including the outside of the data Q  
    154159range:  To include the lower Q and/or the higher Q range, check in the enable  
    155 extrapolation check box in ‘Extrapolation ‘box. If the power low is chosen,  
     160extrapolation check box in 'Extrapolation' box. If the power low is chosen, 
    156161the power (exponent) can be either held or fitted by checking the  
    157162corresponding radio button.  The Npts that is being used for the extrapolation  
    … …  
    162167proper to calculate the invariant. 
    163168 
    164 6. The details of the calculation is available by clicking the ‘Details’  
     1696. The details of the calculation is available by clicking the 'Details' 
    165170button in the middle of the panel. 
    166171 

  • src/sas/invariant/media/pr_help.rst

    r78f02c3 r23a9beb  
    1 ..pr_help.rst 
     1.. pr_help.rst 
    22 
    33.. This is a port of the original SasView html help file to ReSTructured text 
    44.. by S King, ISIS, during SasView CodeCamp-III in Feb 2015. 
     5 
     6.. |pi| unicode:: U+03C0 
     7.. |chi| unicode:: U+03C7 
    58 
    69P(r) Inversion Perspective 
    … …  
    912The inversion approach is based on Moore, J. Appl. Cryst., (1980) 13, 168-175. 
    1013 
    11 P(r) is set to be equal to an expansion of base functions  of the type  
    12 phi_n(r) = 2*r*sin(pi*n*r/D_max). 
     14P(r) is set to be equal to an expansion of base functions of the type 
     15phi_n(r) = 2 * r * sin(|pi| * n * r / D_max). 
    1316 
    1417The coefficient of each base function in the expansion is found by performing  
    1518a least square fit with the following fit function: 
    1619 
    17 chi**2 = sum_i[ I_meas(q_i) - I_th(q_i) ]**2/error**2 + Reg_term 
     20|chi| ^2 = sum_i[ I_meas(q_i) - I_th(q_i) ]^2 / error^2 + Reg_term 
    1821 
    1922where I_meas(q) is the measured scattering intensity and I_th(q) is the  
    … …  
    2124 
    2225The Reg_term term is a regularization term set to the second derivative  
    23 d**2P(r)/dr**2 integrated over r. It is used to produce a smooth P(r) output. 
     26d^2 P(r) / dr^2 integrated over r. It is used to produce a smooth P(r) output. 
    2427 
    2528The following are user inputs: 
    2629 
    27    - Number of terms: the number of base functions in the P(r) expansion.  
     30*  Number of terms: the number of base functions in the P(r) expansion. 
    2831    
    29    - Regularization constant: a multiplicative constant to set the size of  
    30 the regularization term. 
     32*  Regularization constant: a multiplicative constant to set the size of 
     33   the regularization term. 
    3134 
    32    - Maximum distance: the maximum distance between any two points in the  
     35*  Maximum distance: the maximum distance between any two points in the 
    3336   system. 
Note: See TracChangeset for help on using the changeset viewer.