Changeset 5bc373b in sasmodels


Ignore:
Timestamp:
Mar 4, 2018 10:40:24 PM (4 years ago)
Author:
butler
Branches:
master, core_shell_microgels, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests
Children:
b510b92
Parents:
fc3ae1b
Message:

First edits to core shell parallelipiped docs

Part f ticket 896 effort to ensure the documentation matches the code
now that the code has been fixed and validated.

Location:
sasmodels/models
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • sasmodels/models/core_shell_parallelepiped.py

    r97be877 r5bc373b  
    2020$A < B < C$. 
    2121 
    22 .. image:: img/core_shell_parallelepiped_geometry.jpg 
     22.. figure:: img/parallelepiped_geometry.jpg 
     23 
     24   Core of the core shell Parallelepiped with the corresponding definition 
     25   of sides. 
     26 
    2327 
    2428There are rectangular "slabs" of thickness $t_A$ that add to the $A$ dimension 
     
    2630$(=t_C)$ faces. The projection in the $AB$ plane is then 
    2731 
    28 .. image:: img/core_shell_parallelepiped_projection.jpg 
     32.. figure:: img/core_shell_parallelepiped_projection.jpg 
     33 
     34   AB cut through the core-shell parllelipiped showing the cross secion of 
     35   four of the six shell slabs 
    2936 
    3037The volume of the solid is 
     
    4956.. math:: 
    5057 
    51     F(Q) 
     58    F(q) 
    5259    &= (\rho_\text{core}-\rho_\text{solvent}) 
    5360       S(Q_A, A) S(Q_B, B) S(Q_C, C) \\ 
    5461    &+ (\rho_\text{A}-\rho_\text{solvent}) 
    55         \left[S(Q_A, A+2t_A) - S(Q_A, Q)\right] S(Q_B, B) S(Q_C, C) \\ 
     62        \left[S(Q_A, A+2t_A) - S(Q_A, A)\right] S(Q_B, B) S(Q_C, C) \\ 
    5663    &+ (\rho_\text{B}-\rho_\text{solvent}) 
    5764        S(Q_A, A) \left[S(Q_B, B+2t_B) - S(Q_B, B)\right] S(Q_C, C) \\ 
     
    6976.. math:: 
    7077 
    71     Q_A &= \sin\alpha \sin\beta \\ 
    72     Q_B &= \sin\alpha \cos\beta \\ 
    73     Q_C &= \cos\alpha 
     78    Q_A &= q \sin\alpha \sin\beta \\ 
     79    Q_B &= q \sin\alpha \cos\beta \\ 
     80    Q_C &= q \cos\alpha 
    7481 
    7582 
     
    95102and length $(C+2t_C)$ values, after appropriately sorting the three dimensions 
    96103to give an oblate or prolate particle, to give an effective radius, 
    97 for $S(Q)$ when $P(Q) * S(Q)$ is applied. 
     104for $S(q)$ when $P(q) * S(q)$ is applied. 
    98105 
    99106For 2d data the orientation of the particle is required, described using 
  • sasmodels/models/parallelepiped.py

    ref07e95 r5bc373b  
    1010 
    1111 This model calculates the scattering from a rectangular parallelepiped 
    12  (\:numref:`parallelepiped-image`\). 
     12 (:numref:`parallelepiped-image`). 
    1313 If you need to apply polydispersity, see also :ref:`rectangular-prism`. 
    1414 
Note: See TracChangeset for help on using the changeset viewer.