Changeset 96f00a0 in sasview for src/sas/sasgui/perspectives/fitting
- Timestamp:
- Sep 5, 2017 3:43:19 PM (7 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, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
- Children:
- 1573220
- Parents:
- 5cb0c87
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
src/sas/sasgui/perspectives/fitting/media/plugin.rst
r72100ee r96f00a0 46 46 47 47 Other models are available for download from our 48 `Model Marketplace <http://marketplace.sasview.org/>`_. You can contribute your own models to the 48 `Model Marketplace <http://marketplace.sasview.org/>`_. You can contribute your own models to the 49 49 Marketplace aswell. 50 50 … … 80 80 - without any capitalization or CamelCase 81 81 - without incorporating the word "model" 82 - examples: *barbell* **not** *BarBell*; *broad_peak* **not** *BroadPeak*; 82 - examples: *barbell* **not** *BarBell*; *broad_peak* **not** *BroadPeak*; 83 83 *barbell* **not** *BarBellModel* 84 84 … … 100 100 at the top of the *.py* file 101 101 - what you write here is abstracted into the SasView help documentation 102 - this is what other users will refer to when they want to know what your model does; 102 - this is what other users will refer to when they want to know what your model does; 103 103 so please be helpful! 104 104 … … 125 125 converted/created the model file 126 126 127 Models that do not conform to these requirements will *never* be incorporated 127 Models that do not conform to these requirements will *never* be incorporated 128 128 into the built-in library. 129 129 … … 306 306 defines the parameters that form the model. 307 307 308 **Note: The order of the parameters in the definition will be the order of the 309 parameters in the user interface and the order of the parameters in Iq(), 310 Iqxy() and form_volume(). And** *scale* **and** *background* **parameters are 308 **Note: The order of the parameters in the definition will be the order of the 309 parameters in the user interface and the order of the parameters in Iq(), 310 Iqxy() and form_volume(). And** *scale* **and** *background* **parameters are 311 311 implicit to all models, so they do not need to be included in the parameter table.** 312 312 … … 489 489 and it includes orientation parameters. 490 490 491 *form_volume* defines the volume of the shape. As in python models, it 491 *form_volume* defines the volume of the shape. As in python models, it 492 492 includes only the volume parameters. 493 493 … … 623 623 624 624 sas_gamma(x): 625 Gamma function $\text{sas_gamma}(x) = \Gamma(x)$.625 Gamma function sas_gamma\ $(x) = \Gamma(x)$. 626 626 627 627 The standard math function, tgamma(x) is unstable for $x < 1$ … … 633 633 sas_erf(x), sas_erfc(x): 634 634 Error function 635 $\text{sas_erf}(x) = \frac{2}{\sqrt\pi}\int_0^x e^{-t^2}\,dt$635 sas_erf\ $(x) = \frac{2}{\sqrt\pi}\int_0^x e^{-t^2}\,dt$ 636 636 and complementary error function 637 $\text{sas_erfc}(x) = \frac{2}{\sqrt\pi}\int_x^{\infty} e^{-t^2}\,dt$.637 sas_erfc $(x) = \frac{2}{\sqrt\pi}\int_x^{\infty} e^{-t^2}\,dt$. 638 638 639 639 The standard math functions erf(x) and erfc(x) are slower and broken … … 644 644 645 645 sas_J0(x): 646 Bessel function of the first kind $\text{sas_J0}(x)=J_0(x)$ where646 Bessel function of the first kind sas_J0\ $(x)=J_0(x)$ where 647 647 $J_0(x) = \frac{1}{\pi}\int_0^\pi \cos(x\sin(\tau))\,d\tau$. 648 648 … … 653 653 654 654 sas_J1(x): 655 Bessel function of the first kind $\text{sas_J1}(x)=J_1(x)$ where655 Bessel function of the first kind sas_J1\ $(x)=J_1(x)$ where 656 656 $J_1(x) = \frac{1}{\pi}\int_0^\pi \cos(\tau - x\sin(\tau))\,d\tau$. 657 657 … … 663 663 sas_JN(n, x): 664 664 Bessel function of the first kind and integer order $n$: 665 $\text{sas_JN}(n, x)=J_n(x)$ where665 sas_JN\ $(n, x)=J_n(x)$ where 666 666 $J_n(x) = \frac{1}{\pi}\int_0^\pi \cos(n\tau - x\sin(\tau))\,d\tau$. 667 667 If $n$ = 0 or 1, it uses sas_J0(x) or sas_J1(x), respectively. … … 673 673 674 674 sas_Si(x): 675 Sine integral $\text{Si}(x) = \int_0^x \tfrac{\sin t}{t}\,dt$.675 Sine integral Si\ $(x) = \int_0^x \tfrac{\sin t}{t}\,dt$. 676 676 677 677 This function uses Taylor series for small and large arguments: … … 698 698 sas_3j1x_x(x): 699 699 Spherical Bessel form 700 $\text{sph_j1c}(x) = 3 j_1(x)/x = 3 (\sin(x) - x \cos(x))/x^3$,700 sph_j1c\ $(x) = 3 j_1(x)/x = 3 (\sin(x) - x \cos(x))/x^3$, 701 701 with a limiting value of 1 at $x=0$, where $j_1(x)$ is the spherical 702 702 Bessel function of the first kind and first order. … … 709 709 710 710 sas_2J1x_x(x): 711 Bessel form $\text{sas_J1c}(x) = 2 J_1(x)/x$, with a limiting value711 Bessel form sas_J1c\ $(x) = 2 J_1(x)/x$, with a limiting value 712 712 of 1 at $x=0$, where $J_1(x)$ is the Bessel function of first kind 713 713 and first order. … … 832 832 one return value for each point in the mesh grid. 833 833 834 *NOTE: we may be removing or modifying this feature soon. As of the 834 *NOTE: we may be removing or modifying this feature soon. As of the 835 835 time of writing, core-shell sphere returns (1., 1.) for VR, giving a volume 836 836 ratio of 1.0.* … … 878 878 ............... 879 879 880 Either open the :ref:`Python_shell` (*Tools* > *Python Shell/Editor*) or the :ref:`Advanced_Plugin_Editor` (*Fitting* > *Plugin Model Operations* > *Advanced 881 Plugin Editor*), load your model, and then select *Run > Check Model* from the 880 Either open the :ref:`Python_shell` (*Tools* > *Python Shell/Editor*) or the :ref:`Advanced_Plugin_Editor` (*Fitting* > *Plugin Model Operations* > *Advanced 881 Plugin Editor*), load your model, and then select *Run > Check Model* from the 882 882 menu bar. 883 883 884 An *Info* box will appear with the results of the compilation and a check that 884 An *Info* box will appear with the results of the compilation and a check that 885 885 the model runs. 886 886 … … 947 947 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 948 948 949 **NB: For now we are not providing pylint with the installer version of SasView; 949 **NB: For now we are not providing pylint with the installer version of SasView; 950 950 so unless you have a SasView build environment available, you can ignore this section!** 951 951
Note: See TracChangeset
for help on using the changeset viewer.