source: sasmodels/sasmodels/models/gaussian_peak.py

Last change on this file was c1e44e5, checked in by Paul Kienzle <pkienzle@…>, 5 years ago

Add local link to source files. Refs #1263.

  • Property mode set to 100644
File size: 1.7 KB
Line 
1r"""
2
3Definition
4----------
5
6This model describes a Gaussian shaped peak on a flat background
7
8.. math::
9
10    I(q) = (\text{scale}) \exp\left[ -\tfrac12 (q-q_0)^2 / \sigma^2 \right]
11        + \text{background}
12
13with the peak having height of *scale* centered at $q_0$ and having a standard
14deviation of $\sigma$. The FWHM (full-width half-maximum) is $2.354 \sigma$.
15
16For 2D data, scattering intensity is calculated in the same way as 1D,
17where the $q$ vector is defined as
18
19.. math::
20
21    q = \sqrt{q_x^2 + q_y^2}
22
23
24References
25----------
26
27None.
28
29Authorship and Verification
30----------------------------
31
32* **Author:**
33* **Last Modified by:**
34* **Last Reviewed by:**
35"""
36
37import numpy as np
38from numpy import inf
39
40name = "gaussian_peak"
41title = "Gaussian shaped peak"
42description = """
43    Model describes a Gaussian shaped peak including a flat background
44    Provide F(q) = scale*exp( -1/2 *[(q-peak_pos)/sigma]^2 )+ background
45"""
46category = "shape-independent"
47
48#             ["name", "units", default, [lower, upper], "type","description"],
49parameters = [["peak_pos", "1/Ang", 0.05, [-inf, inf], "", "Peak position"],
50              ["sigma", "1/Ang", 0.005, [0, inf], "",
51               "Peak width (standard deviation)"],
52             ]
53
54Iq = """
55    double scaled_dq = (q - peak_pos)/sigma;
56    return exp(-0.5*scaled_dq*scaled_dq); //sqrt(2*M_PI*sigma*sigma);
57    """
58
59def random():
60    """Return a random parameter set for the model."""
61    peak_pos = 10**np.random.uniform(-3, -1)
62    sigma = 10**np.random.uniform(-1.3, -0.3)*peak_pos
63    scale = 10**np.random.uniform(0, 4)
64    pars = dict(
65        #background=1e-8,
66        scale=scale,
67        peak_pos=peak_pos,
68        sigam=sigma,
69    )
70    return pars
Note: See TracBrowser for help on using the repository browser.