[5d4777d] | 1 | # ellipsoid model |
---|
| 2 | # Note: model title and parameter table are inserted automatically |
---|
| 3 | r""" |
---|
[404ebbd] | 4 | The form factor is normalized by the particle volume |
---|
[5d4777d] | 5 | |
---|
| 6 | Definition |
---|
| 7 | ---------- |
---|
| 8 | |
---|
| 9 | The output of the 2D scattering intensity function for oriented ellipsoids |
---|
| 10 | is given by (Feigin, 1987) |
---|
| 11 | |
---|
| 12 | .. math:: |
---|
| 13 | |
---|
[cade620] | 14 | P(q,\alpha) = \frac{\text{scale}}{V} F^2(q,\alpha) + \text{background} |
---|
[5d4777d] | 15 | |
---|
| 16 | where |
---|
| 17 | |
---|
| 18 | .. math:: |
---|
| 19 | |
---|
[3b571ae] | 20 | F(q,\alpha) = \Delta \rho V \frac{3(\sin qr - qr \cos qr)}{(qr)^3} |
---|
[5d4777d] | 21 | |
---|
[3b571ae] | 22 | for |
---|
[5d4777d] | 23 | |
---|
| 24 | .. math:: |
---|
| 25 | |
---|
[3b571ae] | 26 | r = \left[ R_e^2 \sin^2 \alpha + R_p^2 \cos^2 \alpha \right]^{1/2} |
---|
[5d4777d] | 27 | |
---|
| 28 | |
---|
| 29 | $\alpha$ is the angle between the axis of the ellipsoid and $\vec q$, |
---|
[3b571ae] | 30 | $V = (4/3)\pi R_pR_e^2$ is the volume of the ellipsoid, $R_p$ is the polar |
---|
| 31 | radius along the rotational axis of the ellipsoid, $R_e$ is the equatorial |
---|
| 32 | radius perpendicular to the rotational axis of the ellipsoid and |
---|
| 33 | $\Delta \rho$ (contrast) is the scattering length density difference between |
---|
| 34 | the scatterer and the solvent. |
---|
[5d4777d] | 35 | |
---|
[3b571ae] | 36 | For randomly oriented particles use the orientational average, |
---|
[416f5c7] | 37 | |
---|
| 38 | .. math:: |
---|
| 39 | |
---|
[3b571ae] | 40 | \langle F^2(q) \rangle = \int_{0}^{\pi/2}{F^2(q,\alpha)\sin(\alpha)\,d\alpha} |
---|
[416f5c7] | 41 | |
---|
| 42 | |
---|
[3b571ae] | 43 | computed via substitution of $u=\sin(\alpha)$, $du=\cos(\alpha)\,d\alpha$ as |
---|
| 44 | |
---|
| 45 | .. math:: |
---|
| 46 | |
---|
| 47 | \langle F^2(q) \rangle = \int_0^1{F^2(q, u)\,du} |
---|
| 48 | |
---|
| 49 | with |
---|
| 50 | |
---|
| 51 | .. math:: |
---|
| 52 | |
---|
| 53 | r = R_e \left[ 1 + u^2\left(R_p^2/R_e^2 - 1\right)\right]^{1/2} |
---|
| 54 | |
---|
[110f69c] | 55 | For 2d data from oriented ellipsoids the direction of the rotation axis of |
---|
| 56 | the ellipsoid is defined using two angles $\theta$ and $\phi$ as for the |
---|
[0a7eec11] | 57 | :ref:`cylinder orientation figure <cylinder-angle-definition>`. |
---|
[5d4777d] | 58 | For the ellipsoid, $\theta$ is the angle between the rotational axis |
---|
[3b571ae] | 59 | and the $z$ -axis in the $xz$ plane followed by a rotation by $\phi$ |
---|
[110f69c] | 60 | in the $xy$ plane, for further details of the calculation and angular |
---|
[eda8b30] | 61 | dispersions see :ref:`orientation` . |
---|
[5d4777d] | 62 | |
---|
| 63 | NB: The 2nd virial coefficient of the solid ellipsoid is calculated based |
---|
| 64 | on the $R_p$ and $R_e$ values, and used as the effective radius for |
---|
[eb69cce] | 65 | $S(q)$ when $P(q) \cdot S(q)$ is applied. |
---|
[5d4777d] | 66 | |
---|
| 67 | |
---|
[eb69cce] | 68 | The $\theta$ and $\phi$ parameters are not used for the 1D output. |
---|
[5d4777d] | 69 | |
---|
| 70 | Validation |
---|
| 71 | ---------- |
---|
| 72 | |
---|
[aa2edb2] | 73 | Validation of the code was done by comparing the output of the 1D model |
---|
[5d4777d] | 74 | to the output of the software provided by the NIST (Kline, 2006). |
---|
| 75 | |
---|
[aa2edb2] | 76 | The implementation of the intensity for fully oriented ellipsoids was |
---|
| 77 | validated by averaging the 2D output using a uniform distribution |
---|
| 78 | $p(\theta,\phi) = 1.0$ and comparing with the output of the 1D calculation. |
---|
[5d4777d] | 79 | |
---|
| 80 | |
---|
| 81 | .. _ellipsoid-comparison-2d: |
---|
| 82 | |
---|
[19dcb933] | 83 | .. figure:: img/ellipsoid_comparison_2d.jpg |
---|
[5d4777d] | 84 | |
---|
| 85 | Comparison of the intensity for uniformly distributed ellipsoids |
---|
| 86 | calculated from our 2D model and the intensity from the NIST SANS |
---|
[19dcb933] | 87 | analysis software. The parameters used were: *scale* = 1.0, |
---|
[a807206] | 88 | *radius_polar* = 20 |Ang|, *radius_equatorial* = 400 |Ang|, |
---|
[19dcb933] | 89 | *contrast* = 3e-6 |Ang^-2|, and *background* = 0.0 |cm^-1|. |
---|
[5d4777d] | 90 | |
---|
[eb69cce] | 91 | The discrepancy above $q$ = 0.3 |cm^-1| is due to the way the form factors |
---|
[5d4777d] | 92 | are calculated in the c-library provided by NIST. A numerical integration |
---|
[eb69cce] | 93 | has to be performed to obtain $P(q)$ for randomly oriented particles. |
---|
[5d4777d] | 94 | The NIST software performs that integration with a 76-point Gaussian |
---|
[eb69cce] | 95 | quadrature rule, which will become imprecise at high $q$ where the amplitude |
---|
| 96 | varies quickly as a function of $q$. The SasView result shown has been |
---|
[5d4777d] | 97 | obtained by summing over 501 equidistant points. Our result was found |
---|
[eb69cce] | 98 | to be stable over the range of $q$ shown for a number of points higher |
---|
[5d4777d] | 99 | than 500. |
---|
| 100 | |
---|
[3b571ae] | 101 | Model was also tested against the triaxial ellipsoid model with equal major |
---|
| 102 | and minor equatorial radii. It is also consistent with the cyclinder model |
---|
| 103 | with polar radius equal to length and equatorial radius equal to radius. |
---|
| 104 | |
---|
[eb69cce] | 105 | References |
---|
| 106 | ---------- |
---|
[5d4777d] | 107 | |
---|
[0507e09] | 108 | .. [#] L A Feigin and D I Svergun. *Structure Analysis by Small-Angle X-Ray and Neutron Scattering*, Plenum Press, New York, 1987 |
---|
| 109 | .. [#] A. Isihara. *J. Chem. Phys.*, 18 (1950) 1446-1449 |
---|
| 110 | |
---|
| 111 | Source |
---|
| 112 | ------ |
---|
| 113 | |
---|
| 114 | `ellipsoid.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/ellipsoid.py>`_ |
---|
[3b571ae] | 115 | |
---|
[0507e09] | 116 | `ellipsoid.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/ellipsoid.c>`_ |
---|
[bb39b4a] | 117 | |
---|
[3b571ae] | 118 | Authorship and Verification |
---|
| 119 | ---------------------------- |
---|
| 120 | |
---|
| 121 | * **Author:** NIST IGOR/DANSE **Date:** pre 2010 |
---|
| 122 | * **Converted to sasmodels by:** Helen Park **Date:** July 9, 2014 |
---|
| 123 | * **Last Modified by:** Paul Kienzle **Date:** March 22, 2017 |
---|
[0507e09] | 124 | * **Source added by :** Steve King **Date:** March 25, 2019 |
---|
[5d4777d] | 125 | """ |
---|
[404ebbd] | 126 | from __future__ import division |
---|
[5d4777d] | 127 | |
---|
[2d81cfe] | 128 | import numpy as np |
---|
[0b56f38] | 129 | from numpy import inf, sin, cos, pi |
---|
[5d4777d] | 130 | |
---|
| 131 | name = "ellipsoid" |
---|
| 132 | title = "Ellipsoid of revolution with uniform scattering length density." |
---|
| 133 | |
---|
| 134 | description = """\ |
---|
| 135 | P(q.alpha)= scale*f(q)^2 + background, where f(q)= 3*(sld |
---|
[3556ad7] | 136 | - sld_solvent)*V*[sin(q*r(Rp,Re,alpha)) |
---|
[3e428ec] | 137 | -q*r*cos(qr(Rp,Re,alpha))] |
---|
| 138 | /[qr(Rp,Re,alpha)]^3" |
---|
[5d4777d] | 139 | |
---|
| 140 | r(Rp,Re,alpha)= [Re^(2)*(sin(alpha))^2 |
---|
[3e428ec] | 141 | + Rp^(2)*(cos(alpha))^2]^(1/2) |
---|
[5d4777d] | 142 | |
---|
[3e428ec] | 143 | sld: SLD of the ellipsoid |
---|
[3556ad7] | 144 | sld_solvent: SLD of the solvent |
---|
[3e428ec] | 145 | V: volume of the ellipsoid |
---|
| 146 | Rp: polar radius of the ellipsoid |
---|
| 147 | Re: equatorial radius of the ellipsoid |
---|
[5d4777d] | 148 | """ |
---|
[a5d0d00] | 149 | category = "shape:ellipsoid" |
---|
[5d4777d] | 150 | |
---|
[3e428ec] | 151 | # ["name", "units", default, [lower, upper], "type","description"], |
---|
[42356c8] | 152 | parameters = [["sld", "1e-6/Ang^2", 4, [-inf, inf], "sld", |
---|
[3e428ec] | 153 | "Ellipsoid scattering length density"], |
---|
[42356c8] | 154 | ["sld_solvent", "1e-6/Ang^2", 1, [-inf, inf], "sld", |
---|
[3e428ec] | 155 | "Solvent scattering length density"], |
---|
[a807206] | 156 | ["radius_polar", "Ang", 20, [0, inf], "volume", |
---|
[3e428ec] | 157 | "Polar radius"], |
---|
[a807206] | 158 | ["radius_equatorial", "Ang", 400, [0, inf], "volume", |
---|
[3e428ec] | 159 | "Equatorial radius"], |
---|
[9b79f29] | 160 | ["theta", "degrees", 60, [-360, 360], "orientation", |
---|
| 161 | "ellipsoid axis to beam angle"], |
---|
| 162 | ["phi", "degrees", 60, [-360, 360], "orientation", |
---|
| 163 | "rotation about beam"], |
---|
[3e428ec] | 164 | ] |
---|
| 165 | |
---|
[c036ddb] | 166 | |
---|
[925ad6e] | 167 | source = ["lib/sas_3j1x_x.c", "lib/gauss76.c", "ellipsoid.c"] |
---|
[c036ddb] | 168 | have_Fq = True |
---|
[ee60aa7] | 169 | effective_radius_type = [ |
---|
[99658f6] | 170 | "average curvature", "equivalent volume sphere", "min radius", "max radius", |
---|
[ee60aa7] | 171 | ] |
---|
[3e428ec] | 172 | |
---|
[404ebbd] | 173 | def random(): |
---|
[b297ba9] | 174 | """Return a random parameter set for the model.""" |
---|
[2d81cfe] | 175 | volume = 10**np.random.uniform(5, 12) |
---|
[404ebbd] | 176 | radius_polar = 10**np.random.uniform(1.3, 4) |
---|
[2d81cfe] | 177 | radius_equatorial = np.sqrt(volume/radius_polar) # ignore 4/3 pi |
---|
[404ebbd] | 178 | pars = dict( |
---|
| 179 | #background=0, sld=0, sld_solvent=1, |
---|
| 180 | radius_polar=radius_polar, |
---|
| 181 | radius_equatorial=radius_equatorial, |
---|
| 182 | ) |
---|
| 183 | return pars |
---|
[3e428ec] | 184 | |
---|
| 185 | demo = dict(scale=1, background=0, |
---|
[3556ad7] | 186 | sld=6, sld_solvent=1, |
---|
[a807206] | 187 | radius_polar=50, radius_equatorial=30, |
---|
[3e428ec] | 188 | theta=30, phi=15, |
---|
[a807206] | 189 | radius_polar_pd=.2, radius_polar_pd_n=15, |
---|
| 190 | radius_equatorial_pd=.2, radius_equatorial_pd_n=15, |
---|
[3e428ec] | 191 | theta_pd=15, theta_pd_n=45, |
---|
| 192 | phi_pd=15, phi_pd_n=1) |
---|
[0b56f38] | 193 | q = 0.1 |
---|
| 194 | # april 6 2017, rkh add unit tests, NOT compared with any other calc method, assume correct! |
---|
| 195 | qx = q*cos(pi/6.0) |
---|
| 196 | qy = q*sin(pi/6.0) |
---|
[2d81cfe] | 197 | tests = [ |
---|
| 198 | [{}, 0.05, 54.8525847025], |
---|
| 199 | [{'theta':80., 'phi':10.}, (qx, qy), 1.74134670026], |
---|
| 200 | ] |
---|
[0b56f38] | 201 | del qx, qy # not necessary to delete, but cleaner |
---|