1 | r""" |
---|
2 | This model calculates intensity using simple linear function |
---|
3 | |
---|
4 | Definition |
---|
5 | ---------- |
---|
6 | |
---|
7 | The scattering intensity $I(q)$ is calculated as |
---|
8 | |
---|
9 | .. math:: |
---|
10 | |
---|
11 | I(q) = \text{scale} (A + B \cdot q) + \text{background} |
---|
12 | |
---|
13 | .. note:: |
---|
14 | For 2D plots intensity has different definition than other shape independent models |
---|
15 | |
---|
16 | .. math:: |
---|
17 | I(q) = \text{scale} (I(qx) \cdot I(qy)) + \text{background} |
---|
18 | |
---|
19 | References |
---|
20 | ---------- |
---|
21 | |
---|
22 | None. |
---|
23 | |
---|
24 | """ |
---|
25 | from numpy import inf |
---|
26 | |
---|
27 | name = "line" |
---|
28 | title = "Line model" |
---|
29 | description = """\ |
---|
30 | I(q) = A + B*q |
---|
31 | |
---|
32 | List of default parameters: |
---|
33 | A = intercept |
---|
34 | B = slope |
---|
35 | """ |
---|
36 | category = "shape-independent" |
---|
37 | |
---|
38 | # pylint: disable=bad-whitespace, line-too-long |
---|
39 | # ["name", "units", default, [lower, upper], "type", "description"], |
---|
40 | parameters = [["intercept", "1/cm", 1.0, [-inf, inf], "", "intercept in linear model"], |
---|
41 | ["slope", "Ang/cm", 1.0, [-inf, inf], "", "slope in linear model"], |
---|
42 | ] |
---|
43 | # pylint: enable=bad-whitespace, line-too-long |
---|
44 | |
---|
45 | def Iq(q, intercept, slope): |
---|
46 | """ |
---|
47 | :param q: Input q-value |
---|
48 | :param intercept: Intrecept in linear model |
---|
49 | :param slope: Slope in linear model |
---|
50 | :return: Calculated Intensity |
---|
51 | """ |
---|
52 | inten = intercept + slope*q |
---|
53 | return inten |
---|
54 | |
---|
55 | Iq.vectorized = True # Iq accepts an array of q values |
---|
56 | |
---|
57 | def Iqxy(qx, qy, *args): |
---|
58 | """ |
---|
59 | :param qx: Input q_x-value |
---|
60 | :param qy: Input q_y-value |
---|
61 | :param args: Remaining arguments |
---|
62 | :return: 2D-Intensity |
---|
63 | """ |
---|
64 | # TODO: SasView documents 2D intensity as Iq(qx)*Iq(qy), but returns Iq(qy) |
---|
65 | # Note: SasView.run([r, theta]) does return Iq(qx)*Iq(qy) |
---|
66 | return Iq(qx, *args)*Iq(qy, *args) |
---|
67 | |
---|
68 | Iqxy.vectorized = True # Iqxy accepts an array of qx qy values |
---|
69 | |
---|
70 | |
---|
71 | tests = [ |
---|
72 | [{'intercept': 1.0, 'slope': 1.0, }, 1.0, 2.001], |
---|
73 | [{'intercept': 1.0, 'slope': 1.0, }, 0.0, 1.001], |
---|
74 | [{'intercept': 1.0, 'slope': 1.0, }, 0.4, 1.401], |
---|
75 | [{'intercept': 1.0, 'slope': 1.0, }, 1.3, 2.301], |
---|
76 | [{'intercept': 1.0, 'slope': 1.0, }, 0.5, 1.501], |
---|
77 | [{'intercept': 1.0, 'slope': 1.0, }, [0.4, 0.5], [1.401, 1.501]], |
---|
78 | [{'intercept': 1.0, 'slope': 1.0, 'background': 0.0, }, (1.3, 1.57), 5.911], |
---|
79 | ] |
---|