Changeset 23a9beb in sasview for src/sas/fit


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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • 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: 
Note: See TracChangeset for help on using the changeset viewer.