- Timestamp:
- Feb 15, 2015 8:09:34 AM (10 years ago)
- 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
- Location:
- src/sas
- Files:
-
- 7 edited
Legend:
- Unmodified
- Added
- Removed
-
src/sas/calculator/media/sld_calculator_help.rst
r78f02c3 r23a9beb 3 3 .. This is a port of the original SasView html help file to ReSTructured text 4 4 .. by S King, ISIS, during SasView CodeCamp-III in Feb 2015. 5 6 .. |Ang| unicode:: U+212B 5 7 6 8 SLD Calculator Tool … … 12 14 The neutron scattering length density is defined as 13 15 14 SLD = (b_c1 + b_c2+...+b_cn )/Vm16 SLD = (b_c1 + b_c2 + ... + b_cn) / Vm 15 17 16 18 where … … 24 26 ------------------------------- 25 27 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). 28 To calculate scattering length densities enter the empirical formula of a 29 compound and its mass density and click "Calculate". 29 30 30 * Formula strings consist of counts and atoms such as "CaCO3+6H2O". 31 Entering a wavelength value is optional (a default value of 6.0 |Ang| will 32 be used). 31 33 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". 33 35 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. 35 37 36 * Parentheses can be nested, such as "(CaCO3(H2O)6)1".38 * Groups can be defined using parentheses, such as "CaCO3(H2O)6". 37 39 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". 40 41 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]. 42 44 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". 47 46 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 12 12 last data set could be a number). 13 13 14 When the data1 and data2 are selected, their x (or qx and qy for 2D) value(s)14 When data1 and data2 are selected, their x (or qx and qy for 2D) value(s) 15 15 must match with each other. 16 16 … … 22 22 23 23 2) 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. 25 25 26 26 3) 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). 29 29 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). 32 32 33 33 4) 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. 35 35 36 Note: The errors and warnings will be displayed at the bottom of the SasView36 Note: Any errors and warnings will be displayed at the bottom of the SasView 37 37 window. 38 38 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 15 15 16 16 Load_a_File_ 17 17 18 Single_Fit_ 19 18 20 Simultaneous_Fitting_ 21 19 22 Batch_Fitting_ 23 20 24 Model_Selection_ 25 21 26 Model_Category_Manager_ 27 22 28 Model_Functions_ 29 23 30 Custom_Model_Editor_ 31 24 32 Polydispersity_Distributions_ 33 25 34 Smearing_Computation_ 26 Polarisation/Magnetic_Scattering_ 35 36 Polarisation_Magnetic_Scattering_ 37 27 38 Key_Combinations_ 39 28 40 Status_Bar_Help_ 29 41 … … 100 112 ------------- 101 113 102 .. _Batch_Fit_ 103 .. _Batch_Window_ 104 .. _Edit_Grid_ 105 .. _Save_Grid_ 106 .. _Open_Batch_Results_ 107 .. _Plot_ 108 .. _View_Column_Cell_ 114 Batch_Fit_ 115 116 Batch_Window_ 117 118 Edit_Grid_ 119 120 Save_Grid_ 121 122 Open_Batch_Results_ 123 124 Plot_ 125 126 View_Column_Cell_ 109 127 110 128 .. _Batch_Fit: … … 117 135 Fitting menubar. 118 136 119 .. image:: batch_button_area.bmp137 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/batch_button_area.bmp 120 138 121 139 Figure 1: MenuBar: … … 154 172 Figure 2). 155 173 156 .. image:: restore_batch_window.bmp174 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/restore_batch_window.bmp 157 175 158 176 Figure 2: Edit Menu: … … 179 197 column in the grid. 180 198 181 .. image:: edit_menu.bmp199 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/edit_menu.bmp 182 200 183 201 Figure 3: Edit Menu: … … 191 209 .csv file. 192 210 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 211 *Note:* The grid doesn't save the data array, fits, and the array residuals. 212 As a result, the 'View (fit) Results' functionality will be lost when 213 reloading the saved file. 196 214 197 215 Warning! To ensure accuracy of saved fit results, it is recommended to save … … 208 226 available only when at least one column will be removed from the grid. 209 227 210 .. image:: file_menu.bmp228 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/file_menu.bmp 211 229 212 230 Figure 4: MenuBar: … … 226 244 clicking on the plot button. 227 245 228 *X/Y -Axis Selection Range* can be edited manually. These text controls 229 246 *X/Y -Axis Selection Range* can be edited manually. These text controls 247 allow the following types of expression (operation can be + - * /, or pow) 230 248 231 249 1) if the current axis label range is a function of 1 or more columns, write … … 249 267 with valid entries for plotting to work. The dY-bar is optional (see Figure 5). 250 268 251 .. image:: plot_button.bmp269 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/plot_button.bmp 252 270 253 271 Figure 5: Plotting … … 271 289 data and fits. 272 290 273 .. image:: view_button.bmp291 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/view_button.bmp 274 292 275 293 Figure 6: View Fits … … 280 298 281 299 Model_Type_ 282 Change_Model_Parameters_ 283 Write_your_Own_Model_ 300 301 Change_Model_Parameters_ 302 303 Write_your_Own_Model_ 284 304 285 305 .. _Model_Type: … … 345 365 button (Fig. 2). 346 366 347 .. image:: cat_fig0.bmp367 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/cat_fig0.bmp 348 368 349 369 Fig.1 350 370 351 .. image:: cat_fig1.bmp371 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/cat_fig1.bmp 352 372 353 373 Fig.2 354 374 355 .. image:: cat_fig2.bmp375 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/cat_fig2.bmp 356 376 357 377 Fig.3 … … 374 394 375 395 Description_ 376 New_ 377 Sum_Multi_p1_p2_ 378 Advanced_ 379 Delete_ 396 397 New_ 398 399 Sum_Multi_p1_p2_ 400 401 Advanced_ 402 403 Delete_ 380 404 381 405 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ … … 390 414 function are effective after it is re-selected from the combo-box menu. 391 415 392 .. image:: edit_model_menu.bmp416 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/edit_model_menu.bmp 393 417 394 418 .. _New: … … 400 424 can be viewed and further modified by the 'Advanced' option below. 401 425 402 .. image:: new_model.bmp426 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/new_model.bmp 403 427 404 428 .. _Sum_Multi_p1_p2: … … 413 437 for activation. Hit the 'Close' button when it's done. 414 438 415 .. image:: sum_model.bmp439 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sum_model.bmp 416 440 417 441 .. _Advanced: … … 422 446 The menu option shows all the files in the plugin_models folder. You can edit, 423 447 modify, 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 to448 (-------). In the end of edit, 'Compile' and 'Run' from the menu bar to 425 449 activate or to see the model working properly. 426 450 … … 470 494 ------------------------ 471 495 472 .. image:: img/pd_image001.png496 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image001.png 473 497 474 498 The xmean is the mean of the distribution, w is the half-width, and Norm is a … … 478 502 The standard deviation is 479 503 480 .. image:: img/pd_image002.png504 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image002.png 481 505 482 506 The PD (polydispersity) is 483 507 484 .. image:: img/pd_image003.png485 486 .. image:: img/pd_image004.jpg508 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image003.png 509 510 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image004.jpg 487 511 488 512 .. _Array_Distribution: … … 513 537 --------------------- 514 538 515 .. image:: img/pd_image005.png539 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image005.png 516 540 517 541 The xmean is the mean of the distribution and Norm is a normalization factor … … 520 544 The PD (polydispersity) is 521 545 522 .. image:: img/pd_image003.png523 524 .. image:: img/pd_image006.jpg546 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image003.png 547 548 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image006.jpg 525 549 526 550 .. _Lognormal_Distribution: … … 529 553 ---------------------- 530 554 531 .. image:: img/pd_image007.png555 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image007.png 532 556 533 557 The /mu/=ln(xmed), xmed is the median value of the distribution, and Norm is a … … 538 562 The PD (polydispersity) is given by /sigma/ 539 563 540 .. image:: img/pd_image008.png564 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image008.png 541 565 542 566 For the angular distribution 543 567 544 .. image:: img/pd_image009.png568 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image009.png 545 569 546 570 The mean value is given by xmean=exp(/mu/+p2/2). The peak value is given by 547 571 xpeak=exp(/mu/-p2). 548 572 549 .. image:: img/pd_image010.jpg573 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image010.jpg 550 574 551 575 This distribution function spreads more and the peak shifts to the left as the … … 557 581 ------------------- 558 582 559 .. image:: img/pd_image011.png560 561 The xmean is the mean of the distribution and Norm is a normalization factor583 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image011.png 584 585 The xmean is the mean of the distribution and Norm is a normalization factor 562 586 which is determined during the numerical calculation. 563 587 … … 566 590 The PD (polydispersity) is 567 591 568 .. image:: img/pd_image012.png592 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image012.png 569 593 570 594 Note that the higher PD (polydispersity) might need higher values of Npts and … … 572 596 Nsigmas >= 15 at least. 573 597 574 .. image:: img/pd_image013.jpg598 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/pd_image013.jpg 575 599 576 600 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ … … 582 606 583 607 Slit_Smearing_ 584 Pinhole_Smearing_ 585 2D_Smearing_ 608 609 Pinhole_Smearing_ 610 611 2D_Smearing_ 586 612 587 613 .. _Slit_Smearing: … … 592 618 The sit smeared scattering intensity for SAS is defined by 593 619 594 .. image:: img/sm_image002.gif620 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image002.gif 595 621 596 622 where Norm = 597 623 598 .. image:: img/sm_image003.gif624 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image003.gif 599 625 600 626 Equation 1 601 627 602 The functions .. image:: img/sm_image004.gif and .. image:: img/sm_image005.gif628 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 603 629 refer to the slit width weighting function and the slit height weighting 604 630 determined at the q point, respectively. Here, we assumes that the weighting 605 631 function is described by a rectangular function, i.e., 606 632 607 .. image:: img/sm_image006.gif633 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image006.gif 608 634 609 635 Equation 2 … … 611 637 and 612 638 613 .. image:: img/sm_image007.gif639 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image007.gif 614 640 615 641 Equation 3 616 642 617 so that .. image:: img/sm_image008.gif .. image::img/sm_image009.gif for618 .. image:: img/sm_image010.gif and u.619 620 The .. image:: img/sm_image011.gif and .. image::img/sm_image012.gif stand for643 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 621 647 the slit height (FWHM/2) and the slit width (FWHM/2) in the q space. Now the 622 648 integral of Equation 1 is simplified to 623 649 624 .. image:: img/sm_image013.gif650 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image013.gif 625 651 626 652 Equation 4 … … 632 658 ------ 633 659 634 For .. image:: img/sm_image012.gif = 0 and .. image:: img/sm_image011.gif =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 = 635 661 constant. 636 662 637 .. image:: img/sm_image016.gif663 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image016.gif 638 664 639 665 For 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 smeared666 values extended up to qN= qi + .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image011.gif the smeared 641 667 intensity can be calculated approximately 642 668 643 .. image:: img/sm_image017.gif669 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image017.gif 644 670 645 671 Equation 5 646 672 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*. 648 674 649 675 Case 2 650 676 ------ 651 677 652 For .. image:: img/sm_image012.gif = constant and653 .. image:: img/sm_image011.gif = 0.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. 654 680 655 681 Similarly to Case 1, we get 656 682 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 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 659 686 for *Is* in *j* < *p* or *j* > *N-1*. 660 687 … … 662 689 ------ 663 690 664 For .. image:: img/sm_image011.gif = constant and665 .. image:: img/sm_image011.gif = constant.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. 666 693 667 694 In this case, the best way is to perform the integration, Equation 1, … … 674 701 numerical integration for the slit width. 675 702 676 .. image:: img/sm_image020.gif703 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image020.gif 677 704 678 705 Equation 7 679 706 680 for qp= qi- .. image:: img/sm_image012.gif and681 qN= qi+ .. image:: img/sm_image012.gif. .. image:: img/sm_image018.gif = 0 for707 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 682 709 *Is* in *j* < *p* or *j* > *N-1*. 683 710 684 .. Pinhole_Smearing:711 .. _Pinhole_Smearing: 685 712 686 713 Pinhole Smearing … … 691 718 for this case becomes 692 719 693 .. image:: img/sm_image021.gif720 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image021.gif 694 721 695 722 Equation 8 … … 710 737 except that the weight function used was the 2D elliptical Gaussian function 711 738 712 .. image:: img/sm_image022.gif739 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image022.gif 713 740 714 741 Equation 9 … … 721 748 distribution. The A is a normalization factor. 722 749 723 .. image:: img/sm_image023.gif750 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image023.gif 724 751 725 752 Now we consider a numerical integration where each bins in /theta/ and R are … … 728 755 within the bins which in turn becomes 729 756 730 .. image:: img/sm_image024.gif757 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image024.gif 731 758 732 759 Equation 10 … … 736 763 axis). Then, for the polar symmetric smear 737 764 738 .. image:: img/sm_image025.gif765 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image025.gif 739 766 740 767 Equation 11 … … 742 769 where 743 770 744 .. image:: img/sm_image026.gif771 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image026.gif 745 772 746 773 while for the x-y symmetric smear 747 774 748 .. image:: img/sm_image027.gif775 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image027.gif 749 776 750 777 Equation 12 … … 752 779 where 753 780 754 .. image:: img/sm_image028.gif781 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sm_image028.gif 755 782 756 783 Here, the current version of the SasView uses Equation 11 for 2D smearing … … 782 809 vector *Q* contributes to the the magnetic scattering length. 783 810 784 .. . image:: img/mag_vector.bmp811 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/mag_vector.bmp 785 812 786 813 The magnetic scattering length density is then 787 814 788 .. image:: img/dm_eq.gif815 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/dm_eq.gif 789 816 790 817 where /gamma/ = -1.913 the gyromagnetic ratio, /mu/B is the Bohr magneton, r0 … … 799 826 Spin flips: (+ -) and (- +) 800 827 801 .. image:: img/M_angles_pic.bmp828 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/M_angles_pic.bmp 802 829 803 830 Now, let's assume that the angles of the *Q* vector and the spin-axis (x') … … 807 834 as, for non-spin-flips 808 835 809 .. image:: img/sld1.gif836 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sld1.gif 810 837 811 838 for spin-flips 812 839 813 .. image:: img/sld2.gif840 .. image:: docs/sphinx-docs/source/user/perspectives/fitting/sld2.gif 814 841 815 842 where 816 843 817 .. image:: img/mxp.gif818 819 .. image:: img/myp.gif820 821 .. image:: img/mzp.gif822 823 .. image:: img/mqx.gif824 825 .. image:: img/mqy.gif844 .. 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 826 853 827 854 Here, the M0x, M0y and M0z are the x, y and z components of the magnetization … … 829 856 and /phi/M as defined in the Figure (above) 830 857 831 .. image:: img/m0x_eq.gif832 833 .. image:: img/m0y_eq.gif834 835 .. image:: img/m0z_eq.gif858 .. 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 836 863 837 864 The user input parameters are M0_sld = DMM0, Up_theta = /theta/up, … … 843 870 neutrons before the sample and at the analyzer, respectively. 844 871 845 *Note: The values of the 'Up_frac_i' and 'Up_frac_f' must be in the range872 *Note:* The values of the 'Up_frac_i' and 'Up_frac_f' must be in the range 846 873 between 0 and 1. 847 874 … … 854 881 855 882 Copy_Paste_ 883 856 884 Bookmark_ 885 857 886 Graph_Context_Menu_ 887 858 888 FTolerance_ 859 889 … … 918 948 919 949 Message_Warning_Hint_ 920 Console_ 950 951 Console_ 921 952 922 953 .. _Message_Warning_Hint: -
src/sas/guiframe/media/data_explorer_help.rst
r78f02c3 r23a9beb 1 .. _data_explorer_help.rst1 .. data_explorer_help.rst 2 2 3 3 .. This is a port of the original SasView html help file to ReSTructured text … … 7 7 ============ 8 8 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_ 9 Introduction_ 10 11 Load_Data_ 12 13 Handy_Menu_ 14 15 Activate_Data_ 16 17 Remove_Data_ 18 19 Append_Plot_to_Graph_ 20 21 Create_New_Plot_ 22 23 Freeze_Theory_ 24 25 Send_Data_to_Applications_ 18 26 19 27 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ … … 23 31 Introduction 24 32 ------------ 33 25 34 *Data Explorer* is a panel that allows the user more interactions with data. 26 35 Some functionalities provided by the Data Explorer are also available through … … 35 44 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 36 45 37 .. _Load 46 .. _Load_Data: 38 47 39 48 Load Data … … 48 57 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 49 58 50 .. _Handy 59 .. _Handy_Menu: 51 60 52 61 Handy Menu … … 57 66 context menu. 58 67 59 .. _image:: hand_menu.png68 .. image:: hand_menu.png 60 69 61 70 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 62 71 63 .. _Activate 72 .. _Activate_Data: 64 73 65 74 Activate Data … … 75 84 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 76 85 77 .. _Remove 86 .. _Remove_Data: 78 87 79 88 Remove Data … … 86 95 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 87 96 88 .. _Append Plot toGraph:97 .. _Append_Plot_to_Graph: 89 98 90 99 Append Plot to Graph … … 100 109 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 101 110 102 .. _Create NewPlot:111 .. _Create_New_Plot: 103 112 104 113 Create New Plot … … 110 119 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 111 120 112 .. _Freeze 121 .. _Freeze_Theory: 113 122 114 123 Freeze Theory … … 120 129 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 121 130 122 .. _Send to application:131 .. _Send_Data_to_Applications: 123 132 124 133 Send to Application -
src/sas/guiframe/media/graph_help.rst
r78f02c3 r23a9beb 1 .. graph_help.rst1 .. graph_help.rst 2 2 3 3 .. This is a port of the original SasView html help file to ReSTructured text … … 7 7 ==================== 8 8 9 1. Graph Menu_ 10 2. 2D Data Averaging_ 11 3. Key Combinations_ 12 13 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 14 15 .. _Graph menu: 9 Graph_Menu_ 10 11 2D_Data_Averaging_ 12 13 Key_Combinations_ 14 15 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 16 17 .. _Graph_Menu: 16 18 17 19 Graph Menu 18 20 ---------- 19 21 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: 22 Introduction_ 23 24 Reset_Graph_ 25 26 Hide_Show_Delete_Graph_ 27 28 Data_Info_ 29 30 Save_Plot_Image_ 31 32 Save_Data_ 33 34 Drag_Plot_ 35 36 Zoom_In_Out_ 37 38 Remove_Data_ 39 40 Change_Scale_ 41 42 Linear_Fit_ 43 44 Other_Graph_Modifications_ 45 46 .. _Introduction: 47 48 Introduction 49 ------------ 34 50 35 51 Locating the pointer and right-clicking on a data/theory plot will bring a 36 52 context menu. On the menu, select a menu item. 37 53 38 .. _Reset Graph: 54 .. _Reset_Graph: 55 56 Reset Graph 57 ----------- 39 58 40 59 To reset the graph's axis range, right click on the plot and the context menu … … 42 61 the 'home' icon in tool bar will do the same. 43 62 44 .. _Hide/Show/Delete Graph: 63 .. _Hide_Show_Delete_Graph: 64 65 Hide/Show/Delete Graph 66 ---------------------- 45 67 46 68 To Hide, click the Hide (bar) button in the tool bar.To Show, select the the … … 51 73 computation. 52 74 53 .. _Save Plot Image: 75 .. _Data_Info: 76 77 Data Info 78 --------- 79 80 From the context menu, select 'Data Info' to see the data information dialog 81 panel. 82 83 .. _Save_Plot_Image: 84 85 Save Plot Image 86 --------------- 54 87 55 88 Right click on plot. Context menu will pop-up select save image [file name]. … … 57 90 *Save Image.* 58 91 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 94 Save Data 95 --------- 65 96 66 97 From the context menu, select 'Save points as a file' for 1D, or 'Save as a … … 68 99 saving. 69 100 70 .. _Drag Plot: 101 .. _Drag_Plot: 102 103 Drag Plot 104 --------- 71 105 72 106 Select the *crossed arrows* button on the plot panel *toolbar* to drag the 73 107 plot. To disable dragging mode, unselect the same button on the toolbar. 74 108 75 .. _Remove data from plot: 76 77 Highlight the plot and the context menu appears.Select *remove [file name]*. 109 .. _Zoom_In_Out: 110 111 Zoom In/Out 112 ----------- 113 114 Select the *rectangle* button on the plot panel *toolbar* to zoom in a 115 region of the plot. 116 117 To disable zoom mode, unselect the same button on the toolbar. After zoom in 118 a region, select *left arrow* or *right arrow* button on the toolbar to set 119 the 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 121 details). 122 123 .. _Remove_Data: 124 125 Remove Data from Plot 126 --------------------- 127 128 Highlight the plot and the context menu appears.Select *remove [file name]*. 78 129 The plot selected will disappear. 79 130 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 133 Change Scale 134 ------------ 92 135 93 136 If the loaded data is a 1-D data changing scale or data representation will 94 137 work as follows. *Right click* on the plot window. A context menu pops-up and 95 138 select *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. 139 will pop-up then change the *x* , the *y* and the *view* values as wish. 140 97 141 The 'view' option includes the axis scale short-cuts such as Linear, Guinier, 98 142 Cross-sectional (XC) Guinier, and Porod plot scale. For a proper data set, … … 103 147 bar. 104 148 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 149 If the loaded data is an image. *Right click* on the image to pop-up the 150 context menu. Select to switch from linear to log scale. The scale selected is 151 printed on the status bar. 152 153 .. _Linear_Fit: 154 155 Linear Fit 156 ---------- 157 158 Linear fit is to perform a line model fitting keeping the scale of the plot. 159 Highlight data to fit. From the context menu select *Linear Fit* . A dialog 160 window appears. Change model initial parameters, data limits and hit *fit* 161 button. New parameters values are displayed and the line with the new 162 parameters is added to the plot. Especially for Guinier, XC Guinier, and 163 Porod plot scale, this 'Linear Fit' will provides Rg, Rod diameter, and 164 background, respectively. The following figure shows an example for the 114 165 Guinier scale. 115 166 116 .. _Change scale117 118 If the loaded data is a 1-D data changing scale or data representation will119 work as follows. *Right click* on the plot window. A context menu pops-up and120 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 the123 context menu. Select to switch from linear to log scale. The scale selected is124 printed on the statusbar.125 126 167 .. image:: guinier_fit.png 127 168 128 .. _Other Graph Modifications: 169 .. _Other_Graph_Modifications: 170 171 Other Graph Modifications 172 ------------------------- 129 173 130 174 Some custom modifications of the symbols, text, axis, etc of the graph are 131 provided 132 133 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 134 135 .. _2D data averaging175 provided. 176 177 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 178 179 .. _2D_Data_Averaging: 136 180 137 181 2D Data Averaging 138 182 ----------------- 139 183 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_ 184 Description_ 185 186 How_to_Average_ 187 188 Available_Averagings_ 189 190 Unmasked_Circular_Average_ 191 192 Masked_Circular_Average_ 193 194 Sector_Average_ 195 196 Annular_Average_ 197 198 Box_Sum_ 199 200 Box_Averaging_in_Qx_ 201 202 Box_Averaging_in_Qy_ 150 203 151 204 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 152 205 153 206 .. _Description: 207 208 Description 209 ----------- 154 210 155 211 This feature allows you to perform different types of averages on your data, … … 158 214 dragging the lines around. 159 215 160 .. _How to Average 216 .. _How_to_Average: 217 218 How to Average 219 -------------- 161 220 162 221 Right click on 2D data for the context menu to appear. Select one type of … … 180 239 data.The user can also enter values to select a region. 181 240 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 243 Available Averagings 244 -------------------- 245 246 Some different types of averaging are provided for. 247 248 .. _Unmasked_Circular_Average: 249 250 Unmasked Circular Average 251 ------------------------- 252 253 This operation will perform and average in constant q-rings around the (x,y) pixel 189 254 location of the beam center. 190 255 191 .. _Masked Circular Average: 192 193 This operation is same as 'Perform Circular Average' except that the masked 256 .. _Masked_Circular_Average: 257 258 Masked Circular Average 259 ----------------------- 260 261 This operation is same as 'Masked Circular Average' except that the masked 194 262 region is excluded if masked. 195 263 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 266 Sector Average [Q View] 267 ----------------------- 268 269 This operation averages in constant q-arcs. The width of the sector is specified in 270 degrees (+/- delta phi) each side of the central angle (phi). 271 272 .. _Annular_Average: 273 274 Annular Average [Phi View] 275 -------------------------- 202 276 203 277 It performs an average between two q-values centered in (0,0), and averaged … … 207 281 outer circle. The angle zero starts from the positive x-axis direction. 208 282 209 .. _Box Sum: 283 .. _Box_Sum: 284 285 Box Sum 286 ------- 210 287 211 288 Perform the sum of counts in a 2D region of interest.When editing the slicer, … … 213 290 coordinates of the center of this rectangle. 214 291 215 .. _Box Averaging in Qx: 292 .. _Box_Averaging_in_Qx: 293 294 Box Averaging in Qx 295 ------------------- 216 296 217 297 Computes average I(Qx) for a region of interest. When editing the slicer, the … … 221 301 on the x-axis. 222 302 223 .. _Box Averaging in Qy: 303 .. _Box_Averaging_in_Qy: 304 305 Box Averaging in Qy 306 ------------------- 224 307 225 308 Computes average I(Qy) for a region of interest.When editing the slicer, the … … 231 314 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 232 315 233 .. _Key combination316 .. _Key_Combinations: 234 317 235 318 Key Combination 236 319 --------------- 237 320 238 Floating Panel_ 239 Graph Context Menu_ 240 Zoom In and Out_ 241 242 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 243 244 .. _Floating Panel: 321 Floating_Panel_ 322 323 Graph_Context_Menu_ 324 325 Zoom_ 326 327 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 328 329 .. _Floating_Panel: 330 331 Floating Panel 332 -------------- 245 333 246 334 For a graph panel to float on the top of the SV window: … … 250 338 the menu bar. Otherwise choose 'Dock'. 251 339 252 .. _Graph Context Menu: 340 .. _Graph_Context_Menu: 341 342 Graph Context Menu 343 ------------------ 253 344 254 345 To get the graph context menu to print, copy, save data, (2D)average, etc, … … 256 347 to bring up the full menu. 257 348 258 .. _Zoom In and Out: 349 .. _Zoom: 350 351 Zoom In/Out 352 ----------- 259 353 260 354 To 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.rst1 .. invariant_help.rst 2 2 3 3 .. This is a port of the original SasView html help file to ReSTructured text … … 7 7 ================================= 8 8 9 1. Scattering Invariant_ 10 2. Volume Fraction_ 11 3. Specific Surface Area_ 12 4. Definitions_ 13 5. Reference_ 14 6. How to Use_ 9 Scattering_Invariant_ 10 11 Volume_Fraction_ 12 13 Specific_Surface_Area_ 14 15 Definitions_ 16 17 Reference_ 18 19 How_to_Use_ 15 20 16 21 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 17 22 18 .. _Scattering 23 .. _Scattering_Invariant: 19 24 20 25 Scattering Invariant … … 77 82 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 78 83 79 .. _Volume 84 .. _Volume_Fraction: 80 85 81 86 Volume Fraction … … 94 99 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 95 100 96 .. _Specific SurfaceArea:101 .. _Specific_Surface_Area: 97 102 98 103 Specific Surface Area … … 106 111 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 107 112 108 .. _Definitions 113 .. _Definitions: 109 114 110 115 Definitions … … 115 120 I(Q): the scattering intensity as a function of the momentum transfer Q. 116 121 117 Invariant total is the sum of the invariant calculated from data s q range and122 Invariant total is the sum of the invariant calculated from datas q range and 118 123 the invariant resulting from extrapolation at low q range and at high q range 119 124 if considered. … … 129 134 Press, New York, 1982 130 135 131 http://physchem.kfunigraz.ac.at/sm/ <http://physchem.kfunigraz.ac.at/sm/>_136 http://physchem.kfunigraz.ac.at/sm/ 132 137 133 138 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 134 139 135 .. _How to Use140 .. _How_to_Use: 136 141 137 142 How to Use … … 149 154 3. If you want to calculate the volume fraction and the specific surface 150 155 area, type the optional inputs in the customized input box, and then press 151 Computebutton.156 'Compute' button. 152 157 153 158 4. The invariant can also be calculated including the outside of the data Q 154 159 range: 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,160 extrapolation check box in 'Extrapolation' box. If the power low is chosen, 156 161 the power (exponent) can be either held or fitted by checking the 157 162 corresponding radio button. The Npts that is being used for the extrapolation … … 162 167 proper to calculate the invariant. 163 168 164 6. The details of the calculation is available by clicking the Details169 6. The details of the calculation is available by clicking the 'Details' 165 170 button in the middle of the panel. 166 171 -
src/sas/invariant/media/pr_help.rst
r78f02c3 r23a9beb 1 .. pr_help.rst1 .. pr_help.rst 2 2 3 3 .. This is a port of the original SasView html help file to ReSTructured text 4 4 .. by S King, ISIS, during SasView CodeCamp-III in Feb 2015. 5 6 .. |pi| unicode:: U+03C0 7 .. |chi| unicode:: U+03C7 5 8 6 9 P(r) Inversion Perspective … … 9 12 The inversion approach is based on Moore, J. Appl. Cryst., (1980) 13, 168-175. 10 13 11 P(r) is set to be equal to an expansion of base functions of the type12 phi_n(r) = 2 *r*sin(pi*n*r/D_max).14 P(r) is set to be equal to an expansion of base functions of the type 15 phi_n(r) = 2 * r * sin(|pi| * n * r / D_max). 13 16 14 17 The coefficient of each base function in the expansion is found by performing 15 18 a least square fit with the following fit function: 16 19 17 chi**2 = sum_i[ I_meas(q_i) - I_th(q_i) ]**2/error**2 + Reg_term20 |chi| ^2 = sum_i[ I_meas(q_i) - I_th(q_i) ]^2 / error^2 + Reg_term 18 21 19 22 where I_meas(q) is the measured scattering intensity and I_th(q) is the … … 21 24 22 25 The 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.26 d^2 P(r) / dr^2 integrated over r. It is used to produce a smooth P(r) output. 24 27 25 28 The following are user inputs: 26 29 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. 28 31 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. 31 34 32 - Maximum distance: the maximum distance between any two points in the 35 * Maximum distance: the maximum distance between any two points in the 33 36 system.
Note: See TracChangeset
for help on using the changeset viewer.