source: sasmodels/sasmodels/models/power_law.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: 1.7 KB
Line 
1#power_law model
2#conversion of PowerLawAbsModel.py
3
4r"""
5This model calculates a simple power law with a flat background.
6
7Definition
8----------
9
10.. math::
11
12    I(q) = \text{scale} \cdot q^{-\text{power}} + \text{background}
13
14Note the minus sign in front of the exponent. The exponent *power*
15should therefore be entered as a **positive** number for fitting.
16
17Also note that unlike many other models, *scale* in this model
18is NOT explicitly related to a volume fraction. Be careful if
19combining this model with other models.
20
21.. figure:: img/power_law_1d.jpg
22
23    1D plot using the default values (w/200 data point).
24
25References
26----------
27
28None.
29"""
30
31from numpy import inf, sqrt
32
33name =  "power_law"
34title = "Simple power law with a flat background"
35
36description = """\
37        Evaluates the function
38        I(q) = scale * q^(-power) + background
39        NB: enter power as a positive number!
40        """
41category = "shape-independent"
42
43#             ["name", "units", default, [lower, upper], "type", "description"],
44parameters = [["power", "", 4.0, [-inf, inf], "", "Power law exponent"]]
45
46# NB: Scale and Background are implicit parameters on every model
47def Iq(q,power):
48    inten = (q**-power)
49    return inten
50Iq.vectorized = True  # Iq accepts an array of q values
51
52def Iqxy(qx, qy, *args):
53    return Iq(sqrt(qx ** 2 + qy ** 2), *args)
54Iqxy.vectorized = True # Iqxy accepts an array of qx, qy values
55
56demo = dict(scale=1.0,
57            power=4.0,
58            background=0.0)
59
60oldname = "PowerLawAbsModel"
61oldpars = dict(scale='scale',
62               power='m',
63               background='background')
64
65tests = [
66        [ {'scale': 1.0, 'power': 4.0, 'background' : 0.0}, [0.0106939, 0.469418], [7.64644e+07, 20.5949]]
67        ]
Note: See TracBrowser for help on using the repository browser.