source: sasmodels/sasmodels/models/power_law.py @ 58c3367

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

lint and latex cleanup

  • Property mode set to 100644
File size: 1.4 KB
RevLine 
[48be770]1#power_law model
2#conversion of PowerLawAbsModel.py
[b15849c]3#converted by Steve King, Dec 2015
[48be770]4
5r"""
6This model calculates a simple power law with a flat background.
7
8Definition
9----------
10
11.. math::
12
[eb69cce]13    I(q) = \text{scale} \cdot q^{-\text{power}} + \text{background}
[48be770]14
[841753c]15Note the minus sign in front of the exponent. The exponent *power*
[525f3a9]16should therefore be entered as a **positive** number for fitting.
[48be770]17
[841753c]18Also note that unlike many other models, *scale* in this model
19is NOT explicitly related to a volume fraction. Be careful if
[48be770]20combining this model with other models.
21
22
[eb69cce]23References
24----------
[48be770]25
26None.
27"""
28
[2c74c11]29from numpy import inf, errstate
[48be770]30
[841753c]31name = "power_law"
[48be770]32title = "Simple power law with a flat background"
33
[841753c]34description = """
35    Evaluates the function
36    I(q) = scale * q^(-power) + background
37    NB: enter power as a positive number!
38    """
[48be770]39category = "shape-independent"
40
41#             ["name", "units", default, [lower, upper], "type", "description"],
[525f3a9]42parameters = [["power", "", 4.0, [-inf, inf], "", "Power law exponent"]]
[48be770]43
[525f3a9]44# NB: Scale and Background are implicit parameters on every model
[841753c]45def Iq(q, power):
46    # pylint: disable=missing-docstring
[2c74c11]47    with errstate(divide='ignore'):
[40a87fa]48        result = q**-power
49    return result
[eb69cce]50Iq.vectorized = True  # Iq accepts an array of q values
[48be770]51
[40a87fa]52demo = dict(scale=1.0, power=4.0, background=0.0)
[48be770]53
[8fe0b9b]54tests = [
[841753c]55    [{'scale': 1.0, 'power': 4.0, 'background' : 0.0},
56     [0.0106939, 0.469418], [7.64644e+07, 20.5949]],
57    ]
Note: See TracBrowser for help on using the repository browser.