Changeset 2802 for trunk/GSASIIpwd.py


Ignore:
Timestamp:
Apr 23, 2017 9:30:38 PM (5 years ago)
Author:
toby
Message:

updates for doc build

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/GSASIIpwd.py

    r2800 r2802  
    7070def PhaseWtSum(G2frame,histo):
    7171    '''
    72     Calculate sum of phase mass*shase fraction for PWDR data (exclude magnetic phases)
     72    Calculate sum of phase mass*phase fraction for PWDR data (exclude magnetic phases)
    7373   
    7474    :param G2frame: GSASII main frame structure
    7575    :param str histo: histogram name
    76     :returns sum(scale*mass) for phases in histo
     76    :returns: sum(scale*mass) for phases in histo
    7777    '''
    7878    Histograms,Phases = G2frame.GetUsedHistogramsAndPhasesfromTree()
     
    22332233    Reflectometry as a function of kz for a set of slabs.
    22342234
    2235     :Parameters:
    2236 
    2237     *kz* : float[n] | |1/Ang|
    2238         Scattering vector $2\pi\sin(\theta)/\lambda$. This is $\tfrac12 Q_z$.
    2239     *depth* :  float[m] | |Ang|
     2235    :param kz: float[n] (1/Ang). Scattering vector, :math:`2\pi\sin(\\theta)/\lambda`.
     2236        This is :math:`\\tfrac12 Q_z`.       
     2237    :param depth:  float[m] (Ang).
    22402238        thickness of each layer.  The thickness of the incident medium
    22412239        and substrate are ignored.
    2242     *rho*, *irho* :  float[n,k] | |1e-6/Ang^2|
    2243         real and imaginary scattering length density for each layer for each kz
     2240    :param rho:  float[n,k] (1e-6/Ang^2)
     2241        Real scattering length density for each layer for each kz
     2242    :param irho:  float[n,k] (1e-6/Ang^2)
     2243        Imaginary scattering length density for each layer for each kz
    22442244        Note: absorption cross section mu = 2 irho/lambda for neutrons
    2245     *sigma* : float[m-1] | |Ang|
     2245    :param sigma: float[m-1] (Ang)
    22462246        interfacial roughness.  This is the roughness between a layer
    22472247        and the previous layer. The sigma array should have m-1 entries.
     
    23682368    '''Simulate powder or selected area diffraction pattern from stacking faults using DIFFaX
    23692369   
    2370     param: Layers dict: 'Laue':'-1','Cell':[False,1.,1.,1.,90.,90.,90,1.],
    2371                         'Width':[[10.,10.],[False,False]],'Toler':0.01,'AtInfo':{},
    2372                         'Layers':[],'Stacking':[],'Transitions':[]}
    2373     param: ctrls string: controls string to be written on DIFFaX controls.dif file
    2374     param: scale float: scale factor
    2375     param: background dict: background parameters
    2376     param: limits list: min/max 2-theta to be calculated
    2377     param: inst dict: instrument parameters dictionary
    2378     param: profile list: powder pattern data
    2379    
    2380     all updated in place   
     2370    :param dict Layers: dict with following items
     2371
     2372      ::
     2373
     2374       {'Laue':'-1','Cell':[False,1.,1.,1.,90.,90.,90,1.],
     2375       'Width':[[10.,10.],[False,False]],'Toler':0.01,'AtInfo':{},
     2376       'Layers':[],'Stacking':[],'Transitions':[]}
     2377       
     2378    :param str ctrls: controls string to be written on DIFFaX controls.dif file
     2379    :param float scale: scale factor
     2380    :param dict background: background parameters
     2381    :param list limits: min/max 2-theta to be calculated
     2382    :param dict inst: instrument parameters dictionary
     2383    :param list profile: powder pattern data
     2384   
     2385    Note that parameters all updated in place   
    23812386    '''
    23822387    import atmdata
Note: See TracChangeset for help on using the changeset viewer.