source: sasmodels/sasmodels/models/broad_peak.py @ cf404cb

core_shell_microgelscostrafo411magnetic_modelrelease_v0.94release_v0.95ticket-1257-vesicle-productticket_1156ticket_1265_superballticket_822_more_unit_tests
Last change on this file since cf404cb was eb69cce, checked in by Paul Kienzle <pkienzle@…>, 8 years ago

make model docs more consistent; build pdf docs

  • Property mode set to 100644
File size: 3.1 KB
Line 
1r"""
2This model calculates an empirical functional form for SAS data characterized
3by a broad scattering peak. Many SAS spectra are characterized by a broad peak
4even though they are from amorphous soft materials. For example, soft systems
5that show a SAS peak include copolymers, polyelectrolytes, multiphase systems,
6layered structures, etc.
7
8The d-spacing corresponding to the broad peak is a characteristic distance
9between the scattering inhomogeneities (such as in lamellar, cylindrical, or
10spherical morphologies, or for bicontinuous structures).
11
12Definition
13----------
14
15The scattering intensity $I(q)$ is calculated as
16
17.. math::
18
19    I(q) = \frac{A}{q^n} + \frac{C}{1 + (q\xi)^m} + B
20
21Here the peak position is related to the d-spacing as $q_o = 2\pi / d_o$.
22
23For 2D data the scattering intensity is calculated in the same way as 1D,
24where the $q$ vector is defined as
25
26.. math::
27
28    q = \sqrt{q_x^2 + q_y^2}
29
30
31.. figure:: img/broad_peak_1d.jpg
32
33    1D plot using the default values (w/200 data point).
34
35References
36----------
37
38None.
39
40*2013/09/09 - Description reviewed by King, S and Parker, P.*
41
42"""
43
44from numpy import inf, sqrt
45
46name = "broad_peak"
47title = "Broad Lorentzian type peak on top of a power law decay"
48description = """\
49      I(q) = scale_p/pow(q,exponent)+scale_l/
50      (1.0 + pow((fabs(q-q_peak)*length_l),exponent_l) )+ background
51
52      List of default parameters:
53      porod_scale = Porod term scaling
54      porod_exp = Porod exponent
55      lorentz_scale = Lorentzian term scaling
56      lorentz_length = Lorentzian screening length [A]
57      peak_pos = peak location [1/A]
58      lorentz_exp = Lorentzian exponent
59      background = Incoherent background"""
60category = "shape-independent"
61
62#             ["name", "units", default, [lower, upper], "type", "description"],
63parameters = [["porod_scale", "", 1.0e-05, [-inf, inf], "", "Power law scale factor"],
64              ["porod_exp", "", 3.0, [-inf, inf], "", "Exponent of power law"],
65              ["lorentz_scale", "", 10.0, [-inf, inf], "", "Scale factor for broad Lorentzian peak"],
66              ["lorentz_length", "Ang", 50.0, [-inf, inf], "", "Lorentzian screening length"],
67              ["peak_pos", "1/Ang", 0.1, [-inf, inf], "", "Peak postion in q"],
68              ["lorentz_exp", "", 2.0, [-inf, inf], "", "exponent of Lorentz function"],
69             ]
70
71def Iq(q, porod_scale, porod_exp, lorentz_scale, lorentz_length, peak_pos, lorentz_exp):
72    inten = (porod_scale / q ** porod_exp + lorentz_scale
73             / (1.0 + (abs(q - peak_pos) * lorentz_length) ** lorentz_exp))
74    return inten
75Iq.vectorized = True  # Iq accepts an array of q values
76
77def Iqxy(qx, qy, *args):
78    return Iq(sqrt(qx ** 2 + qy ** 2), *args)
79Iqxy.vectorized = True # Iqxy accepts an array of qx, qy values
80
81
82demo = dict(scale=1, background=0,
83            porod_scale=1.0e-05, porod_exp=3,
84            lorentz_scale=10, lorentz_length=50, peak_pos=0.1, lorentz_exp=2)
85
86oldname = "BroadPeakModel"
87oldpars = dict(porod_scale='scale_p', porod_exp='exponent_p',
88               lorentz_scale='scale_l', lorentz_length='length_l', peak_pos='q_peak',
89               lorentz_exp='exponent_l', scale=None)
Note: See TracBrowser for help on using the repository browser.