Changeset 920928f in sasview


Ignore:
Timestamp:
Feb 15, 2015 10:45:23 AM (8 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:
48153283
Parents:
23a9beb
Message:

Fixed rst errors. Sphinx docs now build in a useable form. Require
checking against existing html.

Location:
src/sas
Files:
10 edited

Legend:

Unmodified
Added
Removed
  • src/sas/calculator/media/density_calculator_help.rst

    r78f02c3 r920928f  
    1 ..density_calculator_help.rst 
     1.. density_calculator_help.rst 
    22 
    33.. This is a port of the original SasView html help file to ReSTructured text 
  • src/sas/calculator/media/kiessig_calculator_help.rst

    r78f02c3 r920928f  
    1 ..kiessig_calculator_help.rst 
     1.. kiessig_calculator_help.rst 
    22 
    33.. This is a port of the original SasView html help file to ReSTructured text 
  • src/sas/calculator/media/resolution_calculator_help.rst

    r78f02c3 r920928f  
    1 ..resolution_calculator_help.rst 
     1.. resolution_calculator_help.rst 
    22 
    33.. This is a port of the original SasView html help file to ReSTructured text 
  • src/sas/calculator/media/sas_calculator_help.rst

    r78f02c3 r920928f  
    1 ..sas_calculator_help.rst 
     1.. sas_calculator_help.rst 
    22 
    33.. This is a port of the original SasView html help file to ReSTructured text 
  • src/sas/calculator/media/sld_calculator_help.rst

    r23a9beb r920928f  
    1 ..sld_calculator_help.rst 
     1.. sld_calculator_help.rst 
    22 
    33.. This is a port of the original SasView html help file to ReSTructured text 
  • src/sas/calculator/media/slit_calculator_help.rst

    r78f02c3 r920928f  
    1 ..slit_calculator_help.rst 
     1.. slit_calculator_help.rst 
    22 
    33.. This is a port of the original SasView html help file to ReSTructured text 
  • src/sas/data_util/media/data_operator_help.rst

    r23a9beb r920928f  
    1 ..data_operator_help.rst 
     1.. data_operator_help.rst 
    22 
    33.. This is a port of the original SasView html help file to ReSTructured text 
     
    3737window. 
    3838 
    39 .. image:: image:: docs/sphinx-docs/source/user/calculator/media/data_oper_pic.png 
     39.. image:: data_oper_pic.png 
  • src/sas/fit/media/fitting_help.rst

    r23a9beb r920928f  
    1 ..fitting_help.rst 
     1.. fitting_help.rst 
    22 
    33.. This is a port of the original SasView html help file to ReSTructured text 
     
    9090each FitPages. 
    9191 
    92 Note that the chi2/Npts returned is the sum of the chi2/Npts of each fits. If one needs the chi2 value only for a page, click the 'Compute' button in the FitPage to recalculate. 
     92Note that the chi2/Npts returned is the sum of the chi2/Npts of each fits. If  
     93one needs the chi2 value only for a page, click the 'Compute' button in the  
     94FitPage to recalculate. 
    9395 
    9496Simultaneous Fit with Constraint 
     
    135137Fitting menubar. 
    136138 
    137 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/batch_button_area.bmp 
     139.. image:: batch_button_area.bmp 
    138140 
    139141Figure 1: MenuBar:  
     
    172174Figure 2). 
    173175 
    174 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/restore_batch_window.bmp 
     176.. image:: restore_batch_window.bmp 
    175177 
    176178Figure 2: Edit Menu:  
     
    197199column in the grid. 
    198200 
    199 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/edit_menu.bmp 
     201.. image:: edit_menu.bmp 
    200202 
    201203Figure 3: Edit Menu: 
     
    226228available only when at least one column will be removed from the grid. 
    227229 
    228 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/file_menu.bmp 
     230.. image:: file_menu.bmp 
    229231 
    230232Figure 4: MenuBar: 
     
    267269with valid entries for plotting to work. The dY-bar is optional (see Figure 5). 
    268270 
    269 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/plot_button.bmp 
     271.. image:: plot_button.bmp 
    270272 
    271273Figure 5: Plotting 
     
    289291data and fits.  
    290292 
    291 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/view_button.bmp 
     293.. image:: view_button.bmp 
    292294 
    293295Figure 6: View Fits 
     
    365367button (Fig. 2). 
    366368 
    367 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/cat_fig0.bmp 
     369.. image:: cat_fig0.bmp 
    368370 
    369371Fig.1 
    370372 
    371 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/cat_fig1.bmp 
     373.. image:: cat_fig1.bmp 
    372374 
    373375Fig.2 
    374376 
    375 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/cat_fig2.bmp 
     377.. image:: cat_fig2.bmp 
    376378 
    377379Fig.3 
     
    414416function are effective after it is re-selected from the combo-box menu. 
    415417 
    416 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/edit_model_menu.bmp 
     418.. image:: edit_model_menu.bmp 
    417419 
    418420.. _New: 
     
    424426can be viewed and further modified by the 'Advanced' option below. 
    425427 
    426 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/new_model.bmp 
     428.. image:: new_model.bmp 
    427429 
    428430.. _Sum_Multi_p1_p2: 
     
    437439for activation. Hit the 'Close' button when it's done. 
    438440 
    439 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sum_model.bmp 
     441.. image:: sum_model.bmp 
    440442 
    441443.. _Advanced: 
     
    494496------------------------ 
    495497 
    496 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image001.png 
     498.. image:: pd_image001.png 
    497499 
    498500The xmean is the mean of the distribution, w is the half-width, and Norm is a  
     
    502504The standard deviation is 
    503505 
    504 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image002.png 
     506.. image:: pd_image002.png 
    505507 
    506508The PD (polydispersity) is 
    507509 
    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 
     510.. image:: pd_image003.png 
     511 
     512.. image:: pd_image004.jpg 
    511513 
    512514.. _Array_Distribution: 
     
    537539--------------------- 
    538540 
    539 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image005.png 
     541.. image:: pd_image005.png 
    540542 
    541543The xmean is the mean of the distribution and Norm is a normalization factor  
     
    544546The PD (polydispersity) is 
    545547 
    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 
     548.. image:: pd_image003.png 
     549 
     550.. image:: pd_image006.jpg 
    549551 
    550552.. _Lognormal_Distribution: 
     
    553555---------------------- 
    554556 
    555 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image007.png 
     557.. image:: pd_image007.png 
    556558 
    557559The /mu/=ln(xmed), xmed is the median value of the distribution, and Norm is a  
     
    562564The PD (polydispersity) is given by /sigma/ 
    563565 
    564 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image008.png 
     566.. image:: pd_image008.png 
    565567 
    566568For the angular distribution 
    567569 
    568 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image009.png 
     570.. image:: pd_image009.png 
    569571 
    570572The mean value is given by xmean=exp(/mu/+p2/2). The peak value is given by  
    571573xpeak=exp(/mu/-p2). 
    572574 
    573 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image010.jpg 
     575.. image:: pd_image010.jpg 
    574576 
    575577This distribution function spreads more and the peak shifts to the left as the  
     
    581583------------------- 
    582584 
    583 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image011.png 
     585.. image:: pd_image011.png 
    584586 
    585587The xmean is the mean of the distribution and Norm is a normalization factor 
     
    590592The PD (polydispersity) is 
    591593 
    592 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image012.png 
     594.. image:: pd_image012.png 
    593595 
    594596Note that the higher PD (polydispersity) might need higher values of Npts and  
     
    596598Nsigmas >= 15 at least. 
    597599 
    598 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image013.jpg 
     600.. image:: pd_image013.jpg 
    599601 
    600602.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     
    618620The sit smeared scattering intensity for SAS is defined by 
    619621 
    620 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image002.gif 
     622.. image:: sm_image002.gif 
    621623 
    622624where Norm = 
    623625 
    624 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image003.gif 
     626.. image:: sm_image003.gif 
    625627 
    626628Equation 1 
    627629 
    628 The functions .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image004.gif and .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image005.gif 
     630The functions .. image:: sm_image004.gif and .. image:: sm_image005.gif 
    629631refer to the slit width weighting function and the slit height weighting  
    630632determined at the q point, respectively. Here, we assumes that the weighting  
    631633function is described by a rectangular function, i.e., 
    632634 
    633 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image006.gif 
     635.. image:: sm_image006.gif 
    634636 
    635637Equation 2 
     
    637639and 
    638640 
    639 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image007.gif 
     641.. image:: sm_image007.gif 
    640642 
    641643Equation 3 
    642644 
    643 so 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  
    646 The .. 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 
     645so that .. image:: sm_image008.gif .. image:: sm_image009.gif for 
     646.. image:: sm_image010.gif and u. 
     647 
     648The .. image:: sm_image011.gif and .. image:: sm_image012.gif stand for 
    647649the slit height (FWHM/2) and the slit width (FWHM/2) in the q space. Now the  
    648650integral of Equation 1 is simplified to 
    649651 
    650 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image013.gif 
     652.. image:: sm_image013.gif 
    651653 
    652654Equation 4 
     
    658660------ 
    659661 
    660 For .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image012.gif = 0 and .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image011.gif =  
     662For .. image:: sm_image012.gif = 0 and .. image:: sm_image011.gif =  
    661663constant. 
    662664 
    663 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image016.gif 
     665.. image:: sm_image016.gif 
    664666 
    665667For discrete q values, at the q values from the data points and at the q  
    666 values extended up to qN= qi + .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image011.gif the smeared  
     668values extended up to qN= qi + .. image:: sm_image011.gif the smeared  
    667669intensity can be calculated approximately 
    668670 
    669 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image017.gif 
     671.. image:: sm_image017.gif 
    670672 
    671673Equation 5 
    672674 
    673 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image018.gif = 0 for *Is* in *j* < *i* or *j* > N-1*. 
     675.. image:: sm_image018.gif = 0 for *Is* in *j* < *i* or *j* > N-1*. 
    674676 
    675677Case 2 
    676678------ 
    677679 
    678 For .. 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. 
     680For .. image:: sm_image012.gif = constant and  
     681.. image:: sm_image011.gif = 0. 
    680682 
    681683Similarly to Case 1, we get 
    682684 
    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  
    685 and 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 
     685.. image:: sm_image019.gif for qp= qi- .. image:: sm_image012.gif 
     686 
     687and qN= qi+ .. image:: sm_image012.gif. .. image:: sm_image018.gif = 0 
    686688for *Is* in *j* < *p* or *j* > *N-1*. 
    687689 
     
    689691------ 
    690692 
    691 For .. 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. 
     693For .. image:: sm_image011.gif = constant and  
     694.. image:: sm_image011.gif = constant. 
    693695 
    694696In this case, the best way is to perform the integration, Equation 1,  
     
    701703numerical integration for the slit width. 
    702704 
    703 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image020.gif 
     705.. image:: sm_image020.gif 
    704706 
    705707Equation 7 
    706708 
    707 for qp= qi- .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image012.gif and 
    708 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 for 
     709for qp= qi- .. image:: sm_image012.gif and 
     710qN= qi+ .. image:: sm_image012.gif. .. image:: sm_image018.gif = 0 for 
    709711*Is* in *j* < *p* or *j* > *N-1*. 
    710712 
     
    718720for this case becomes 
    719721 
    720 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image021.gif 
     722.. image:: sm_image021.gif 
    721723 
    722724Equation 8 
     
    737739except that the weight function used was the 2D elliptical Gaussian function 
    738740 
    739 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image022.gif 
     741.. image:: sm_image022.gif 
    740742 
    741743Equation 9 
     
    748750distribution. The A is a normalization factor. 
    749751 
    750 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image023.gif 
     752.. image:: sm_image023.gif 
    751753 
    752754Now we consider a numerical integration where each bins in /theta/ and R are  
     
    755757within the bins which in turn becomes 
    756758 
    757 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image024.gif 
     759.. image:: sm_image024.gif 
    758760 
    759761Equation 10 
     
    763765axis). Then, for the polar symmetric smear 
    764766 
    765 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image025.gif 
     767.. image:: sm_image025.gif 
    766768 
    767769Equation 11 
     
    769771where 
    770772 
    771 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image026.gif 
     773.. image:: sm_image026.gif 
    772774 
    773775while for the x-y symmetric smear 
    774776 
    775 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image027.gif 
     777.. image:: sm_image027.gif 
    776778 
    777779Equation 12 
     
    779781where 
    780782 
    781 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image028.gif 
     783.. image:: sm_image028.gif 
    782784 
    783785Here, the current version of the SasView uses Equation 11 for 2D smearing  
     
    809811vector *Q* contributes to the the magnetic scattering length. 
    810812 
    811 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/mag_vector.bmp 
     813.. image:: mag_vector.bmp 
    812814 
    813815The magnetic scattering length density is then 
    814816 
    815 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/dm_eq.gif 
     817.. image:: dm_eq.gif 
    816818 
    817819where /gamma/ = -1.913 the gyromagnetic ratio, /mu/B is the Bohr magneton, r0  
     
    826828Spin flips:     (+ -) and (- +) 
    827829 
    828 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/M_angles_pic.bmp 
     830.. image:: M_angles_pic.bmp 
    829831 
    830832Now, let's assume that the angles of the *Q*  vector and the spin-axis (x')  
     
    834836as, for non-spin-flips 
    835837 
    836 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sld1.gif 
     838.. image:: sld1.gif 
    837839 
    838840for spin-flips 
    839841 
    840 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sld2.gif 
     842.. image:: sld2.gif 
    841843 
    842844where 
    843845 
    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 
     846.. image:: mxp.gif 
     847 
     848.. image:: myp.gif 
     849 
     850.. image:: mzp.gif 
     851 
     852.. image:: mqx.gif 
     853 
     854.. image:: mqy.gif 
    853855 
    854856Here, the M0x, M0y and M0z are the x, y and z components of the magnetization  
     
    856858and /phi/M as defined in the Figure (above) 
    857859 
    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 
     860.. image:: m0x_eq.gif 
     861 
     862.. image:: m0y_eq.gif 
     863 
     864.. image:: m0z_eq.gif 
    863865 
    864866The user input parameters are M0_sld = DMM0, Up_theta = /theta/up,  
  • src/sas/perspectives/calculator/media/image_viewer_help.rst

    r78f02c3 r920928f  
    1 ..image_viewer_help.rst 
     1.. image_viewer_help.rst 
    22 
    33.. This is a port of the original SasView html help file to ReSTructured text 
  • src/sas/perspectives/calculator/media/python_shell_help.rst

    r78f02c3 r920928f  
    1 ..python_shell_help.rst 
     1.. python_shell_help.rst 
    22 
    33.. This is a port of the original SasView html help file to ReSTructured text 
Note: See TracChangeset for help on using the changeset viewer.