Changes in sasmodels/models/hollow_rectangular_prism.py [455aaa1:2d81cfe] in sasmodels

File:

• sasmodels/models/hollow_rectangular_prism.py (modified) (4 diffs)

sasmodels/models/hollow_rectangular_prism.py

@@ -2 +2 @@
 # Note: model title and parameter table are inserted automatically
 r"""
+
+This model provides the form factor, $P(q)$, for a hollow rectangular
+parallelepiped with a wall of thickness $\Delta$.
+It computes only the 1D scattering, not the 2D.
+
 Definition
 ----------
 
-This model provides the form factor, $P(q)$, for a hollow rectangular
-parallelepiped with a wall of thickness $\Delta$. The 1D scattering intensity
-for this model is calculated by forming the difference of the amplitudes of two
-massive parallelepipeds differing in their outermost dimensions in each
-direction by the same length increment $2\Delta$ (\ [#Nayuk2012]_ Nayuk, 2012).
+The 1D scattering intensity for this model is calculated by forming
+the difference of the amplitudes of two massive parallelepipeds
+differing in their outermost dimensions in each direction by the
+same length increment $2\Delta$ (Nayuk, 2012).
 
 As in the case of the massive parallelepiped model (:ref:`rectangular-prism`),
@@ -57 +61 @@
   \rho_\text{solvent})^2 \times P(q) + \text{background}
 
-where $\rho_\text{p}$ is the scattering length density of the parallelepiped,
-$\rho_\text{solvent}$ is the scattering length density of the solvent,
+where $\rho_\text{p}$ is the scattering length of the parallelepiped,
+$\rho_\text{solvent}$ is the scattering length of the solvent,
 and (if the data are in absolute units) *scale* represents the volume fraction
-(which is unitless) of the rectangular shell of material (i.e. not including
-the volume of the solvent filled core).
+(which is unitless).
 
-For 2d data the orientation of the particle is required, described using
-angles $\theta$, $\phi$ and $\Psi$ as in the diagrams below, for further details
-of the calculation and angular dispersions see :ref:`orientation` .
-The angle $\Psi$ is the rotational angle around the long *C* axis. For example,
-$\Psi = 0$ when the *B* axis is parallel to the *x*-axis of the detector.
-
-For 2d, constraints must be applied during fitting to ensure that the inequality
-$A < B < C$ is not violated, and hence the correct definition of angles is
-preserved. The calculation will not report an error if the inequality is *not*
-preserved, but the results may be not correct.
-
-.. figure:: img/parallelepiped_angle_definition.png
-
-    Definition of the angles for oriented hollow rectangular prism.
-    Note that rotation $\theta$, initially in the $xz$ plane, is carried out first, then
-    rotation $\phi$ about the $z$ axis, finally rotation $\Psi$ is now around the axis of the prism.
-    The neutron or X-ray beam is along the $z$ axis.
-
-.. figure:: img/parallelepiped_angle_projection.png
-
-    Examples of the angles for oriented hollow rectangular prisms against the
-    detector plane.
+**The 2D scattering intensity is not computed by this model.**
 
 
@@ -97 +79 @@
 ----------
 
-.. [#Nayuk2012] R Nayuk and K Huber, *Z. Phys. Chem.*, 226 (2012) 837-854
-
-
-Authorship and Verification
-----------------------------
-
-* **Author:** Miguel Gonzales **Date:** February 26, 2016
-* **Last Modified by:** Paul Kienzle **Date:** December 14, 2017
-* **Last Reviewed by:** Paul Butler **Date:** September 06, 2018
+R Nayuk and K Huber, *Z. Phys. Chem.*, 226 (2012) 837-854
 """
 
@@ -139 +113 @@
               ["thickness", "Ang", 1, [0, inf], "volume",
                "Thickness of parallelepiped"],
-              ["theta", "degrees", 0, [-360, 360], "orientation",
-               "c axis to beam angle"],
-              ["phi", "degrees", 0, [-360, 360], "orientation",
-               "rotation about beam"],
-              ["psi", "degrees", 0, [-360, 360], "orientation",
-               "rotation about c axis"],
              ]