Changeset 5810f00 in sasmodels

Timestamp:

Nov 26, 2016 8:28:11 PM (8 years ago)

Author:

butler

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

797a8e3

Parents:

755ecc2

Message:

updating documentation to meet standards. Addresses #646

File:

• sasmodels/models/core_shell_parallelepiped.py (modified) (5 diffs)

sasmodels/models/core_shell_parallelepiped.py

@@ -1 @@
-# core_shell_parallelepiped model
-# Note: model title and parameter table are inserted automatically
 r"""
+Definition
+----------
+
 Calculates the form factor for a rectangular solid with a core-shell structure.
 **The thickness and the scattering length density of the shell or "rim"
@@ -15 +16 @@
 of the rectangular solid.
 
-An instrument resolution smeared version of the model is also provided.
-
-
-Definition
-----------
 
 The function calculated is the form factor of the rectangular solid below.
@@ -41 +37 @@
 **meaning that there are "gaps" at the corners of the solid.**
 
-The intensity calculated follows the :ref:`parallelepiped` model, with the core-shell
-intensity being calculated as the square of the sum of the amplitudes of the
-core and shell, in the same manner as a core-shell model.
-
-**For the calculation of the form factor to be valid, the sides of the solid
-MUST be chosen such that** $A < B < C$.
-**If this inequality is not satisfied, the model will not report an error,
-and the calculation will not be correct.**
+The intensity calculated follows the :ref:`parallelepiped` model, with the
+core-shell intensity being calculated as the square of the sum of the
+amplitudes of the core and shell, in the same manner as a core-shell model.
+
+.. math::
+
+    F_{a}(Q,\alpha,\beta)=
+    \Bigg(\frac{sin(Q(L_A+2t_A)/2sin\alpha sin\beta)}{Q(L_A+2t_A)/2sin\alpha
+    sin\beta)}
+    - \frac{sin(QL_A/2sin\alpha sin\beta)}{QL_A/2sin\alpha sin\beta)} \Bigg)
+    + \frac{sin(QL_B/2sin\alpha sin\beta)}{QL_B/2sin\alpha sin\beta)}
+    + \frac{sin(QL_C/2sin\alpha sin\beta)}{QL_C/2sin\alpha sin\beta)}
+
+.. note::
+
+    For the calculation of the form factor to be valid, the sides of the solid
+    MUST be chosen such that** $A < B < C$.
+    If this inequality is not satisfied, the model will not report an error,
+    but the calculation will not be correct and thus the result wrong.
 
 FITTING NOTES
 If the scale is set equal to the particle volume fraction, |phi|, the returned
 value is the scattered intensity per unit volume, $I(q) = \phi P(q)$.
-However, **no interparticle interference effects are included in this calculation.**
+However, **no interparticle interference effects are included in this
+calculation.**
 
 There are many parameters in this model. Hold as many fixed as possible with
@@ -68 +76 @@
 and length $(C+2t_C)$ values, and used as the effective radius
 for $S(Q)$ when $P(Q) * S(Q)$ is applied.
-
-.. Comment by Miguel Gonzalez:
-   The later seems to contradict the previous statement that interparticle interference
-   effects are not included.
 
 To provide easy access to the orientation of the parallelepiped, we define the
@@ -98 +102 @@
 ----------
 
-P Mittelbach and G Porod, *Acta Physica Austriaca*, 14 (1961) 185-211
-Equations (1), (13-14). (in German)
-
+.. [#] P Mittelbach and G Porod, *Acta Physica Austriaca*, 14 (1961) 185-211
+    Equations (1), (13-14). (in German)
+.. [#] D Singh (2009). *Small angle scattering studies of self assembly in
+   lipid mixtures*, John's Hopkins University Thesis (2009) 223-225. `Available
+   from Proquest <http://search.proquest.com/docview/304915826?accountid
+   =26379>`_
+
+Authorship and Verification
+----------------------------
+
+* **Author:** NIST IGOR/DANSE **Date:** pre 2010
+* **Last Modified by:** Paul Butler **Date:** September 30, 2016
+* **Last Reviewed by:** Miguel Gonzales **Date:** March 21, 2016
 """