Changeset 68532f3 in sasmodels for _sources/model/triaxial_ellipsoid.txt


Ignore:
Timestamp:
Nov 1, 2015 4:10:22 PM (8 years ago)
Author:
ajj
Branches:
gh-pages
Children:
4a9a316
Parents:
d1fe925
Message:

Adding docs

File:
1 moved

Legend:

Unmodified
Added
Removed

  • _sources/model/triaxial_ellipsoid.txt

    rd1fe925 r68532f3  
    1 # triaxial ellipsoid model 
    2 # Note: model title and parameter table are inserted automatically 
    3 r""" 
     1.. _triaxial-ellipsoid: 
     2 
     3Triaxial ellipsoid 
     4======================================================= 
     5 
     6Ellipsoid of uniform scattering length density with three independent axes. 
     7 
     8=========== =================================== ============ ============= 
     9Parameter   Description                         Units        Default value 
     10=========== =================================== ============ ============= 
     11scale       Source intensity                    None                     1 
     12background  Source background                   |cm^-1|                  0 
     13sld         Ellipsoid scattering length density |1e-6Ang^-2|             4 
     14solvent_sld Solvent scattering length density   |1e-6Ang^-2|             1 
     15req_minor   Minor equitorial radius             |Ang|                   20 
     16req_major   Major equatorial radius             |Ang|                  400 
     17rpolar      Polar radius                        |Ang|                   10 
     18theta       In plane angle                      degree                  60 
     19phi         Out of plane angle                  degree                  60 
     20psi         Out of plane angle                  degree                  60 
     21=========== =================================== ============ ============= 
     22 
     23The returned value is scaled to units of |cm^-1|. 
     24 
     25 
    426All three axes are of different lengths with $R_a \le R_b <= R_c$ 
    527**Users should maintain this inequality for all calculations**. 
    … …  
    88110L A Feigin and D I Svergun, *Structure Analysis by Small-Angle X-Ray and Neutron Scattering*, Plenum, 
    89111New York, 1987. 
    90 """ 
    91112 
    92 from numpy import inf 
    93  
    94 name = "triaxial_ellipsoid" 
    95 title = "Ellipsoid of uniform scattering length density with three independent axes." 
    96  
    97 description = """\ 
    98 Note: During fitting ensure that the inequality ra<rb<rc is not 
    99         violated. Otherwise the calculation will 
    100         not be correct. 
    101 """ 
    102 category = "shape:ellipsoid" 
    103  
    104 #             ["name", "units", default, [lower, upper], "type","description"], 
    105 parameters = [["sld", "1e-6/Ang^2", 4, [-inf, inf], "", 
    106                "Ellipsoid scattering length density"], 
    107               ["solvent_sld", "1e-6/Ang^2", 1, [-inf, inf], "", 
    108                "Solvent scattering length density"], 
    109               ["req_minor", "Ang", 20, [0, inf], "volume", 
    110                "Minor equitorial radius"], 
    111               ["req_major", "Ang", 400, [0, inf], "volume", 
    112                "Major equatorial radius"], 
    113               ["rpolar", "Ang", 10, [0, inf], "volume", 
    114                "Polar radius"], 
    115               ["theta", "degrees", 60, [-inf, inf], "orientation", 
    116                "In plane angle"], 
    117               ["phi", "degrees", 60, [-inf, inf], "orientation", 
    118                "Out of plane angle"], 
    119               ["psi", "degrees", 60, [-inf, inf], "orientation", 
    120                "Out of plane angle"], 
    121              ] 
    122  
    123 source = ["lib/J1.c", "lib/gauss76.c", "triaxial_ellipsoid.c"] 
    124  
    125 def ER(req_minor, req_major, rpolar): 
    126     import numpy as np 
    127     from .ellipsoid import ER as ellipsoid_ER 
    128     return ellipsoid_ER(rpolar, np.sqrt(req_minor * req_major)) 
    129  
    130 demo = dict(scale=1, background=0, 
    131             sld=6, solvent_sld=1, 
    132             theta=30, phi=15, psi=5, 
    133             req_minor=25, req_major=36, rpolar=50, 
    134             req_minor_pd=0, req_minor_pd_n=1, 
    135             req_major_pd=0, req_major_pd_n=1, 
    136             rpolar_pd=.2, rpolar_pd_n=30, 
    137             theta_pd=15, theta_pd_n=45, 
    138             phi_pd=15, phi_pd_n=1, 
    139             psi_pd=15, psi_pd_n=1) 
    140 oldname = 'TriaxialEllipsoidModel' 
    141 oldpars = dict(theta='axis_theta', phi='axis_phi', psi='axis_psi', 
    142                sld='sldEll', solvent_sld='sldSolv', 
    143                req_minor='semi_axisA', req_major='semi_axisB', 
    144                rpolar='semi_axisC') 
Note: See TracChangeset for help on using the changeset viewer.