source: trunk/GSASIIlattice.py @ 1443

Last change on this file since 1443 was 1443, checked in by vondreele, 7 years ago

add calibration of lam, difC, etc. from index peak positions
new plotCalib routine

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Author Revision URL Id
File size: 58.4 KB
Line 
1# -*- coding: utf-8 -*-
2'''
3*GSASIIlattice: Unit cells*
4---------------------------
5
6Perform lattice-related computations
7
8Note that *g* is the reciprocal lattice tensor, and *G* is its inverse,
9:math:`G = g^{-1}`, where
10
11  .. math::
12
13   G = \\left( \\begin{matrix}
14   a^2 & a b\\cos\gamma & a c\\cos\\beta \\\\
15   a b\\cos\\gamma & b^2 & b c \cos\\alpha \\\\
16   a c\\cos\\beta &  b c \\cos\\alpha & c^2
17   \\end{matrix}\\right)
18
19The "*A* tensor" terms are defined as
20:math:`A = (\\begin{matrix} G_{11} & G_{22} & G_{33} & 2G_{12} & 2G_{13} & 2G_{23}\\end{matrix})` and *A* can be used in this fashion:
21:math:`d^* = \sqrt {A_1 h^2 + A_2 k^2 + A_3 l^2 + A_4 hk + A_5 hl + A_6 kl}`, where
22*d* is the d-spacing, and :math:`d^*` is the reciprocal lattice spacing,
23:math:`Q = 2 \\pi d^* = 2 \\pi / d`
24'''
25########### SVN repository information ###################
26# $Date: 2014-07-28 21:53:56 +0000 (Mon, 28 Jul 2014) $
27# $Author: vondreele $
28# $Revision: 1443 $
29# $URL: trunk/GSASIIlattice.py $
30# $Id: GSASIIlattice.py 1443 2014-07-28 21:53:56Z vondreele $
31########### SVN repository information ###################
32import math
33import numpy as np
34import numpy.linalg as nl
35import GSASIIpath
36import GSASIImath as G2mth
37GSASIIpath.SetVersionNumber("$Revision: 1443 $")
38# trig functions in degrees
39sind = lambda x: np.sin(x*np.pi/180.)
40asind = lambda x: 180.*np.arcsin(x)/np.pi
41tand = lambda x: np.tan(x*np.pi/180.)
42atand = lambda x: 180.*np.arctan(x)/np.pi
43atan2d = lambda y,x: 180.*np.arctan2(y,x)/np.pi
44cosd = lambda x: np.cos(x*np.pi/180.)
45acosd = lambda x: 180.*np.arccos(x)/np.pi
46rdsq2d = lambda x,p: round(1.0/np.sqrt(x),p)
47
48def sec2HMS(sec):
49    """Convert time in sec to H:M:S string
50   
51    :param sec: time in seconds
52    :return: H:M:S string (to nearest 100th second)
53   
54    """
55    H = int(sec/3600)
56    M = int(sec/60-H*60)
57    S = sec-3600*H-60*M
58    return '%d:%2d:%.2f'%(H,M,S)
59   
60def rotdMat(angle,axis=0):
61    """Prepare rotation matrix for angle in degrees about axis(=0,1,2)
62
63    :param angle: angle in degrees
64    :param axis:  axis (0,1,2 = x,y,z) about which for the rotation
65    :return: rotation matrix - 3x3 numpy array
66
67    """
68    if axis == 2:
69        return np.array([[cosd(angle),-sind(angle),0],[sind(angle),cosd(angle),0],[0,0,1]])
70    elif axis == 1:
71        return np.array([[cosd(angle),0,-sind(angle)],[0,1,0],[sind(angle),0,cosd(angle)]])
72    else:
73        return np.array([[1,0,0],[0,cosd(angle),-sind(angle)],[0,sind(angle),cosd(angle)]])
74       
75def rotdMat4(angle,axis=0):
76    """Prepare rotation matrix for angle in degrees about axis(=0,1,2) with scaling for OpenGL
77
78    :param angle: angle in degrees
79    :param axis:  axis (0,1,2 = x,y,z) about which for the rotation
80    :return: rotation matrix - 4x4 numpy array (last row/column for openGL scaling)
81
82    """
83    Mat = rotdMat(angle,axis)
84    return np.concatenate((np.concatenate((Mat,[[0],[0],[0]]),axis=1),[[0,0,0,1],]),axis=0)
85   
86def fillgmat(cell):
87    """Compute lattice metric tensor from unit cell constants
88
89    :param cell: tuple with a,b,c,alpha, beta, gamma (degrees)
90    :return: 3x3 numpy array
91
92    """
93    a,b,c,alp,bet,gam = cell
94    g = np.array([
95        [a*a,  a*b*cosd(gam),  a*c*cosd(bet)],
96        [a*b*cosd(gam),  b*b,  b*c*cosd(alp)],
97        [a*c*cosd(bet) ,b*c*cosd(alp),   c*c]])
98    return g
99           
100def cell2Gmat(cell):
101    """Compute real and reciprocal lattice metric tensor from unit cell constants
102
103    :param cell: tuple with a,b,c,alpha, beta, gamma (degrees)
104    :return: reciprocal (G) & real (g) metric tensors (list of two numpy 3x3 arrays)
105
106    """
107    g = fillgmat(cell)
108    G = nl.inv(g)       
109    return G,g
110
111def A2Gmat(A,inverse=True):
112    """Fill real & reciprocal metric tensor (G) from A.
113
114    :param A: reciprocal metric tensor elements as [G11,G22,G33,2*G12,2*G13,2*G23]
115    :param bool inverse: if True return both G and g; else just G
116    :return: reciprocal (G) & real (g) metric tensors (list of two numpy 3x3 arrays)
117
118    """
119    G = np.zeros(shape=(3,3))
120    G = [
121        [A[0],  A[3]/2.,  A[4]/2.], 
122        [A[3]/2.,A[1],    A[5]/2.], 
123        [A[4]/2.,A[5]/2.,    A[2]]]
124    if inverse:
125        g = nl.inv(G)
126        return G,g
127    else:
128        return G
129
130def Gmat2A(G):
131    """Extract A from reciprocal metric tensor (G)
132
133    :param G: reciprocal maetric tensor (3x3 numpy array
134    :return: A = [G11,G22,G33,2*G12,2*G13,2*G23]
135
136    """
137    return [G[0][0],G[1][1],G[2][2],2.*G[0][1],2.*G[0][2],2.*G[1][2]]
138   
139def cell2A(cell):
140    """Obtain A = [G11,G22,G33,2*G12,2*G13,2*G23] from lattice parameters
141
142    :param cell: [a,b,c,alpha,beta,gamma] (degrees)
143    :return: G reciprocal metric tensor as 3x3 numpy array
144
145    """
146    G,g = cell2Gmat(cell)
147    return Gmat2A(G)
148
149def A2cell(A):
150    """Compute unit cell constants from A
151
152    :param A: [G11,G22,G33,2*G12,2*G13,2*G23] G - reciprocal metric tensor
153    :return: a,b,c,alpha, beta, gamma (degrees) - lattice parameters
154
155    """
156    G,g = A2Gmat(A)
157    return Gmat2cell(g)
158
159def Gmat2cell(g):
160    """Compute real/reciprocal lattice parameters from real/reciprocal metric tensor (g/G)
161    The math works the same either way.
162
163    :param g (or G): real (or reciprocal) metric tensor 3x3 array
164    :return: a,b,c,alpha, beta, gamma (degrees) (or a*,b*,c*,alpha*,beta*,gamma* degrees)
165
166    """
167    oldset = np.seterr('raise')
168    a = np.sqrt(max(0,g[0][0]))
169    b = np.sqrt(max(0,g[1][1]))
170    c = np.sqrt(max(0,g[2][2]))
171    alp = acosd(g[2][1]/(b*c))
172    bet = acosd(g[2][0]/(a*c))
173    gam = acosd(g[0][1]/(a*b))
174    np.seterr(**oldset)
175    return a,b,c,alp,bet,gam
176
177def invcell2Gmat(invcell):
178    """Compute real and reciprocal lattice metric tensor from reciprocal
179       unit cell constants
180       
181    :param invcell: [a*,b*,c*,alpha*, beta*, gamma*] (degrees)
182    :return: reciprocal (G) & real (g) metric tensors (list of two 3x3 arrays)
183
184    """
185    G = fillgmat(invcell)
186    g = nl.inv(G)
187    return G,g
188       
189def calc_rVsq(A):
190    """Compute the square of the reciprocal lattice volume (1/V**2) from A'
191
192    """
193    G,g = A2Gmat(A)
194    rVsq = nl.det(G)
195    if rVsq < 0:
196        return 1
197    return rVsq
198   
199def calc_rV(A):
200    """Compute the reciprocal lattice volume (V*) from A
201    """
202    return np.sqrt(calc_rVsq(A))
203   
204def calc_V(A):
205    """Compute the real lattice volume (V) from A
206    """
207    return 1./calc_rV(A)
208
209def A2invcell(A):
210    """Compute reciprocal unit cell constants from A
211    returns tuple with a*,b*,c*,alpha*, beta*, gamma* (degrees)
212    """
213    G,g = A2Gmat(A)
214    return Gmat2cell(G)
215   
216def Gmat2AB(G):
217    """Computes orthogonalization matrix from reciprocal metric tensor G
218
219    :returns: tuple of two 3x3 numpy arrays (A,B)
220
221       * A for crystal to Cartesian transformations A*x = np.inner(A,x) = X
222       * B (= inverse of A) for Cartesian to crystal transformation B*X = np.inner(B,X) = x
223
224    """
225    cellstar = Gmat2cell(G)
226    g = nl.inv(G)
227    cell = Gmat2cell(g)
228    A = np.zeros(shape=(3,3))
229    # from Giacovazzo (Fundamentals 2nd Ed.) p.75
230    A[0][0] = cell[0]                # a
231    A[0][1] = cell[1]*cosd(cell[5])  # b cos(gamma)
232    A[0][2] = cell[2]*cosd(cell[4])  # c cos(beta)
233    A[1][1] = cell[1]*sind(cell[5])  # b sin(gamma)
234    A[1][2] = -cell[2]*cosd(cellstar[3])*sind(cell[4]) # - c cos(alpha*) sin(beta)
235    A[2][2] = 1/cellstar[2]         # 1/c*
236    B = nl.inv(A)
237    return A,B
238   
239
240def cell2AB(cell):
241    """Computes orthogonalization matrix from unit cell constants
242
243    :param tuple cell: a,b,c, alpha, beta, gamma (degrees)
244    :returns: tuple of two 3x3 numpy arrays (A,B)
245       A for crystal to Cartesian transformations A*x = np.inner(A,x) = X
246       B (= inverse of A) for Cartesian to crystal transformation B*X = np.inner(B,X) = x
247    """
248    G,g = cell2Gmat(cell) 
249    cellstar = Gmat2cell(G)
250    A = np.zeros(shape=(3,3))
251    # from Giacovazzo (Fundamentals 2nd Ed.) p.75
252    A[0][0] = cell[0]                # a
253    A[0][1] = cell[1]*cosd(cell[5])  # b cos(gamma)
254    A[0][2] = cell[2]*cosd(cell[4])  # c cos(beta)
255    A[1][1] = cell[1]*sind(cell[5])  # b sin(gamma)
256    A[1][2] = -cell[2]*cosd(cellstar[3])*sind(cell[4]) # - c cos(alpha*) sin(beta)
257    A[2][2] = 1/cellstar[2]         # 1/c*
258    B = nl.inv(A)
259    return A,B
260   
261def U6toUij(U6):
262    """Fill matrix (Uij) from U6 = [U11,U22,U33,U12,U13,U23]
263    NB: there is a non numpy version in GSASIIspc: U2Uij
264
265    :param list U6: 6 terms of u11,u22,...
266    :returns:
267        Uij - numpy [3][3] array of uij
268    """
269    U = np.array([
270        [U6[0],  U6[3],  U6[4]], 
271        [U6[3],  U6[1],  U6[5]], 
272        [U6[4],  U6[5],  U6[2]]])
273    return U
274
275def UijtoU6(U):
276    """Fill vector [U11,U22,U33,U12,U13,U23] from Uij
277    NB: there is a non numpy version in GSASIIspc: Uij2U
278    """
279    U6 = np.array([U[0][0],U[1][1],U[2][2],U[0][1],U[0][2],U[1][2]])
280    return U6
281
282def Uij2betaij(Uij,G):
283    """
284    Convert Uij to beta-ij tensors -- stub for eventual completion
285   
286    :param Uij: numpy array [Uij]
287    :param G: reciprocal metric tensor
288    :returns: beta-ij - numpy array [beta-ij]
289    """
290    pass
291   
292def cell2GS(cell):
293    ''' returns Uij to betaij conversion matrix'''
294    G,g = cell2Gmat(cell)
295    GS = G
296    GS[0][1] = GS[1][0] = math.sqrt(GS[0][0]*GS[1][1])
297    GS[0][2] = GS[2][0] = math.sqrt(GS[0][0]*GS[2][2])
298    GS[1][2] = GS[2][1] = math.sqrt(GS[1][1]*GS[2][2])
299    return GS   
300   
301def Uij2Ueqv(Uij,GS,Amat):
302    ''' returns 1/3 trace of diagonalized U matrix'''
303    U = np.multiply(U6toUij(Uij),GS)
304    U = np.inner(Amat,np.inner(U,Amat).T)
305    E,R = nl.eigh(U)
306    return np.sum(E)/3.
307       
308def CosAngle(U,V,G):
309    """ calculate cos of angle between U & V in generalized coordinates
310    defined by metric tensor G
311
312    :param U: 3-vectors assume numpy arrays, can be multiple reflections as (N,3) array
313    :param V: 3-vectors assume numpy arrays, only as (3) vector
314    :param G: metric tensor for U & V defined space assume numpy array
315    :returns:
316        cos(phi)
317    """
318    u = (U.T/np.sqrt(np.sum(np.inner(U,G)*U,axis=1))).T
319    v = V/np.sqrt(np.inner(V,np.inner(G,V)))
320    cosP = np.inner(u,np.inner(G,v))
321    return cosP
322   
323def CosSinAngle(U,V,G):
324    """ calculate sin & cos of angle between U & V in generalized coordinates
325    defined by metric tensor G
326
327    :param U: 3-vectors assume numpy arrays
328    :param V: 3-vectors assume numpy arrays
329    :param G: metric tensor for U & V defined space assume numpy array
330    :returns:
331        cos(phi) & sin(phi)
332    """
333    u = U/np.sqrt(np.inner(U,np.inner(G,U)))
334    v = V/np.sqrt(np.inner(V,np.inner(G,V)))
335    cosP = np.inner(u,np.inner(G,v))
336    sinP = np.sqrt(max(0.0,1.0-cosP**2))
337    return cosP,sinP
338   
339def criticalEllipse(prob):
340    """
341    Calculate critical values for probability ellipsoids from probability
342    """
343    if not ( 0.01 <= prob < 1.0):
344        return 1.54 
345    coeff = np.array([6.44988E-09,4.16479E-07,1.11172E-05,1.58767E-04,0.00130554,
346        0.00604091,0.0114921,-0.040301,-0.6337203,1.311582])
347    llpr = math.log(-math.log(prob))
348    return np.polyval(coeff,llpr)
349   
350def CellBlock(nCells):
351    """
352    Generate block of unit cells n*n*n on a side; [0,0,0] centered, n = 2*nCells+1
353    currently only works for nCells = 0 or 1 (not >1)
354    """
355    if nCells:
356        N = 2*nCells+1
357        N2 = N*N
358        N3 = N*N*N
359        cellArray = []
360        A = np.array(range(N3))
361        cellGen = np.array([A/N2-1,A/N%N-1,A%N-1]).T
362        for cell in cellGen:
363            cellArray.append(cell)
364        return cellArray
365    else:
366        return [0,0,0]
367       
368def CellAbsorption(ElList,Volume):
369    '''Compute unit cell absorption
370
371    :param dict ElList: dictionary of element contents including mu and
372      number of atoms be cell
373    :param float Volume: unit cell volume
374    :returns: mu-total/Volume
375    '''
376    muT = 0
377    for El in ElList:
378        muT += ElList[El]['mu']*ElList[El]['FormulaNo']
379    return muT/Volume
380   
381#Permutations and Combinations
382# Four routines: combinations,uniqueCombinations, selections & permutations
383#These taken from Python Cookbook, 2nd Edition. 19.15 p724-726
384#   
385def _combinators(_handle, items, n):
386    """ factored-out common structure of all following combinators """
387    if n==0:
388        yield [ ]
389        return
390    for i, item in enumerate(items):
391        this_one = [ item ]
392        for cc in _combinators(_handle, _handle(items, i), n-1):
393            yield this_one + cc
394def combinations(items, n):
395    """ take n distinct items, order matters """
396    def skipIthItem(items, i):
397        return items[:i] + items[i+1:]
398    return _combinators(skipIthItem, items, n)
399def uniqueCombinations(items, n):
400    """ take n distinct items, order is irrelevant """
401    def afterIthItem(items, i):
402        return items[i+1:]
403    return _combinators(afterIthItem, items, n)
404def selections(items, n):
405    """ take n (not necessarily distinct) items, order matters """
406    def keepAllItems(items, i):
407        return items
408    return _combinators(keepAllItems, items, n)
409def permutations(items):
410    """ take all items, order matters """
411    return combinations(items, len(items))
412
413#reflection generation routines
414#for these: H = [h,k,l]; A is as used in calc_rDsq; G - inv metric tensor, g - metric tensor;
415#           cell - a,b,c,alp,bet,gam in A & deg
416   
417def Pos2dsp(Inst,pos):
418    ''' convert powder pattern position (2-theta or TOF, musec) to d-spacing
419    ignores secondary effects (e.g. difA,difB in TOF)
420    '''
421    if 'C' in Inst['Type'][0]:
422        wave = G2mth.getWave(Inst)
423        dsp = wave/(2.0*sind((pos-Inst['Zero'][1])/2.0))
424    else:   #'T'OF - ignore difA, difB
425        dsp = (pos-Inst['Zero'][1])/Inst['difC'][1]
426    return dsp
427   
428def Dsp2pos(Inst,dsp):
429    ''' convert d-spacing to powder pattern position (2-theta or TOF, musec)
430    '''
431    if 'C' in Inst['Type'][0]:
432        wave = G2mth.getWave(Inst)
433        pos = 2.0*asind(wave/(2.*dsp))+Inst['Zero'][1]             
434    else:   #'T'OF
435        pos = Inst['difC'][1]*dsp+Inst['Zero'][1]+Inst['difA'][1]*dsp**2+Inst.get('difB',[0,0,False])[1]*dsp**3
436    return pos
437   
438def getPeakPos(dataType,parmdict,dsp):
439    ''' convert d-spacing to powder pattern position (2-theta or TOF, musec)
440    '''
441    if 'C' in dataType:
442        pos = 2.0*asind(parmdict['Lam']/(2.*dsp))+parmdict['Zero']
443    else:   #'T'OF
444        pos = parmdict['difC']*dsp+parmdict['difA']*dsp**2+parmdict['difB']*dsp**3+parmdict['Zero']
445    return pos
446                   
447   
448def calc_rDsq(H,A):
449    'needs doc string'
450    rdsq = H[0]*H[0]*A[0]+H[1]*H[1]*A[1]+H[2]*H[2]*A[2]+H[0]*H[1]*A[3]+H[0]*H[2]*A[4]+H[1]*H[2]*A[5]
451    return rdsq
452   
453def calc_rDsq2(H,G):
454    'needs doc string'
455    return np.inner(H,np.inner(G,H))
456   
457def calc_rDsqZ(H,A,Z,tth,lam):
458    'needs doc string'
459    rpd = np.pi/180.
460    rdsq = calc_rDsq(H,A)+Z*sind(tth)*2.0*rpd/lam**2
461    return rdsq
462       
463def MaxIndex(dmin,A):
464    'needs doc string'
465    Hmax = [0,0,0]
466    try:
467        cell = A2cell(A)
468    except:
469        cell = [1,1,1,90,90,90]
470    for i in range(3):
471        Hmax[i] = int(round(cell[i]/dmin))
472    return Hmax
473   
474def sortHKLd(HKLd,ifreverse,ifdup):
475    '''needs doc string
476
477    :param HKLd: a list of [h,k,l,d,...];
478    :param ifreverse: True for largest d first
479    :param ifdup: True if duplicate d-spacings allowed
480    '''
481    T = []
482    for i,H in enumerate(HKLd):
483        if ifdup:
484            T.append((H[3],i))
485        else:
486            T.append(H[3])           
487    D = dict(zip(T,HKLd))
488    T.sort()
489    if ifreverse:
490        T.reverse()
491    X = []
492    okey = ''
493    for key in T: 
494        if key != okey: X.append(D[key])    #remove duplicate d-spacings
495        okey = key
496    return X
497   
498def SwapIndx(Axis,H):
499    'needs doc string'
500    if Axis in [1,-1]:
501        return H
502    elif Axis in [2,-3]:
503        return [H[1],H[2],H[0]]
504    else:
505        return [H[2],H[0],H[1]]
506       
507def Rh2Hx(Rh):
508    'needs doc string'
509    Hx = [0,0,0]
510    Hx[0] = Rh[0]-Rh[1]
511    Hx[1] = Rh[1]-Rh[2]
512    Hx[2] = np.sum(Rh)
513    return Hx
514   
515def Hx2Rh(Hx):
516    'needs doc string'
517    Rh = [0,0,0]
518    itk = -Hx[0]+Hx[1]+Hx[2]
519    if itk%3 != 0:
520        return 0        #error - not rhombohedral reflection
521    else:
522        Rh[1] = itk/3
523        Rh[0] = Rh[1]+Hx[0]
524        Rh[2] = Rh[1]-Hx[1]
525        if Rh[0] < 0:
526            for i in range(3):
527                Rh[i] = -Rh[i]
528        return Rh
529       
530def CentCheck(Cent,H):
531    'needs doc string'
532    h,k,l = H
533    if Cent == 'A' and (k+l)%2:
534        return False
535    elif Cent == 'B' and (h+l)%2:
536        return False
537    elif Cent == 'C' and (h+k)%2:
538        return False
539    elif Cent == 'I' and (h+k+l)%2:
540        return False
541    elif Cent == 'F' and ((h+k)%2 or (h+l)%2 or (k+l)%2):
542        return False
543    elif Cent == 'R' and (-h+k+l)%3:
544        return False
545    else:
546        return True
547                                   
548def GetBraviasNum(center,system):
549    """Determine the Bravais lattice number, as used in GenHBravais
550   
551    :param center: one of: 'P', 'C', 'I', 'F', 'R' (see SGLatt from GSASIIspc.SpcGroup)
552    :param system: one of 'cubic', 'hexagonal', 'tetragonal', 'orthorhombic', 'trigonal' (for R)
553      'monoclinic', 'triclinic' (see SGSys from GSASIIspc.SpcGroup)
554    :return: a number between 0 and 13
555      or throws a ValueError exception if the combination of center, system is not found (i.e. non-standard)
556
557    """
558    if center.upper() == 'F' and system.lower() == 'cubic':
559        return 0
560    elif center.upper() == 'I' and system.lower() == 'cubic':
561        return 1
562    elif center.upper() == 'P' and system.lower() == 'cubic':
563        return 2
564    elif center.upper() == 'R' and system.lower() == 'trigonal':
565        return 3
566    elif center.upper() == 'P' and system.lower() == 'hexagonal':
567        return 4
568    elif center.upper() == 'I' and system.lower() == 'tetragonal':
569        return 5
570    elif center.upper() == 'P' and system.lower() == 'tetragonal':
571        return 6
572    elif center.upper() == 'F' and system.lower() == 'orthorhombic':
573        return 7
574    elif center.upper() == 'I' and system.lower() == 'orthorhombic':
575        return 8
576    elif center.upper() == 'C' and system.lower() == 'orthorhombic':
577        return 9
578    elif center.upper() == 'P' and system.lower() == 'orthorhombic':
579        return 10
580    elif center.upper() == 'C' and system.lower() == 'monoclinic':
581        return 11
582    elif center.upper() == 'P' and system.lower() == 'monoclinic':
583        return 12
584    elif center.upper() == 'P' and system.lower() == 'triclinic':
585        return 13
586    raise ValueError,'non-standard Bravais lattice center=%s, cell=%s' % (center,system)
587
588def GenHBravais(dmin,Bravais,A):
589    """Generate the positionally unique powder diffraction reflections
590     
591    :param dmin: minimum d-spacing in A
592    :param Bravais: lattice type (see GetBraviasNum). Bravais is one of::
593             0 F cubic
594             1 I cubic
595             2 P cubic
596             3 R hexagonal (trigonal not rhombohedral)
597             4 P hexagonal
598             5 I tetragonal
599             6 P tetragonal
600             7 F orthorhombic
601             8 I orthorhombic
602             9 C orthorhombic
603             10 P orthorhombic
604             11 C monoclinic
605             12 P monoclinic
606             13 P triclinic
607           
608    :param A: reciprocal metric tensor elements as [G11,G22,G33,2*G12,2*G13,2*G23]
609    :return: HKL unique d list of [h,k,l,d,-1] sorted with largest d first
610           
611    """
612    import math
613    if Bravais in [9,11]:
614        Cent = 'C'
615    elif Bravais in [1,5,8]:
616        Cent = 'I'
617    elif Bravais in [0,7]:
618        Cent = 'F'
619    elif Bravais in [3]:
620        Cent = 'R'
621    else:
622        Cent = 'P'
623    Hmax = MaxIndex(dmin,A)
624    dminsq = 1./(dmin**2)
625    HKL = []
626    if Bravais == 13:                       #triclinic
627        for l in range(-Hmax[2],Hmax[2]+1):
628            for k in range(-Hmax[1],Hmax[1]+1):
629                hmin = 0
630                if (k < 0): hmin = 1
631                if (k ==0 and l < 0): hmin = 1
632                for h in range(hmin,Hmax[0]+1):
633                    H=[h,k,l]
634                    rdsq = calc_rDsq(H,A)
635                    if 0 < rdsq <= dminsq:
636                        HKL.append([h,k,l,rdsq2d(rdsq,6),-1])
637    elif Bravais in [11,12]:                #monoclinic - b unique
638        Hmax = SwapIndx(2,Hmax)
639        for h in range(Hmax[0]+1):
640            for k in range(-Hmax[1],Hmax[1]+1):
641                lmin = 0
642                if k < 0:lmin = 1
643                for l in range(lmin,Hmax[2]+1):
644                    [h,k,l] = SwapIndx(-2,[h,k,l])
645                    H = []
646                    if CentCheck(Cent,[h,k,l]): H=[h,k,l]
647                    if H:
648                        rdsq = calc_rDsq(H,A)
649                        if 0 < rdsq <= dminsq:
650                            HKL.append([h,k,l,rdsq2d(rdsq,6),-1])
651                    [h,k,l] = SwapIndx(2,[h,k,l])
652    elif Bravais in [7,8,9,10]:            #orthorhombic
653        for h in range(Hmax[0]+1):
654            for k in range(Hmax[1]+1):
655                for l in range(Hmax[2]+1):
656                    H = []
657                    if CentCheck(Cent,[h,k,l]): H=[h,k,l]
658                    if H:
659                        rdsq = calc_rDsq(H,A)
660                        if 0 < rdsq <= dminsq:
661                            HKL.append([h,k,l,rdsq2d(rdsq,6),-1])
662    elif Bravais in [5,6]:                  #tetragonal
663        for l in range(Hmax[2]+1):
664            for k in range(Hmax[1]+1):
665                for h in range(k,Hmax[0]+1):
666                    H = []
667                    if CentCheck(Cent,[h,k,l]): H=[h,k,l]
668                    if H:
669                        rdsq = calc_rDsq(H,A)
670                        if 0 < rdsq <= dminsq:
671                            HKL.append([h,k,l,rdsq2d(rdsq,6),-1])
672    elif Bravais in [3,4]:
673        lmin = 0
674        if Bravais == 3: lmin = -Hmax[2]                  #hexagonal/trigonal
675        for l in range(lmin,Hmax[2]+1):
676            for k in range(Hmax[1]+1):
677                hmin = k
678                if l < 0: hmin += 1
679                for h in range(hmin,Hmax[0]+1):
680                    H = []
681                    if CentCheck(Cent,[h,k,l]): H=[h,k,l]
682                    if H:
683                        rdsq = calc_rDsq(H,A)
684                        if 0 < rdsq <= dminsq:
685                            HKL.append([h,k,l,rdsq2d(rdsq,6),-1])
686
687    else:                                   #cubic
688        for l in range(Hmax[2]+1):
689            for k in range(l,Hmax[1]+1):
690                for h in range(k,Hmax[0]+1):
691                    H = []
692                    if CentCheck(Cent,[h,k,l]): H=[h,k,l]
693                    if H:
694                        rdsq = calc_rDsq(H,A)
695                        if 0 < rdsq <= dminsq:
696                            HKL.append([h,k,l,rdsq2d(rdsq,6),-1])
697    return sortHKLd(HKL,True,False)
698   
699def getHKLmax(dmin,SGData,A):
700    'finds maximum allowed hkl for given A within dmin'
701    SGLaue = SGData['SGLaue']
702    if SGLaue in ['3R','3mR']:        #Rhombohedral axes
703        Hmax = [0,0,0]
704        cell = A2cell(A)
705        aHx = cell[0]*math.sqrt(2.0*(1.0-cosd(cell[3])))
706        cHx = cell[0]*math.sqrt(3.0*(1.0+2.0*cosd(cell[3])))
707        Hmax[0] = Hmax[1] = int(round(aHx/dmin))
708        Hmax[2] = int(round(cHx/dmin))
709        #print Hmax,aHx,cHx
710    else:                           # all others
711        Hmax = MaxIndex(dmin,A)
712    return Hmax
713   
714def GenHLaue(dmin,SGData,A):
715    """Generate the crystallographically unique powder diffraction reflections
716    for a lattice and Bravais type
717   
718    :param dmin: minimum d-spacing
719    :param SGData: space group dictionary with at least
720   
721        * 'SGLaue': Laue group symbol: one of '-1','2/m','mmm','4/m','6/m','4/mmm','6/mmm', '3m1', '31m', '3', '3R', '3mR', 'm3', 'm3m'
722        * 'SGLatt': lattice centering: one of 'P','A','B','C','I','F'
723        * 'SGUniq': code for unique monoclinic axis one of 'a','b','c' (only if 'SGLaue' is '2/m') otherwise an empty string
724       
725    :param A: reciprocal metric tensor elements as [G11,G22,G33,2*G12,2*G13,2*G23]
726    :return: HKL = list of [h,k,l,d] sorted with largest d first and is unique
727            part of reciprocal space ignoring anomalous dispersion
728           
729    """
730    import math
731    SGLaue = SGData['SGLaue']
732    SGLatt = SGData['SGLatt']
733    SGUniq = SGData['SGUniq']
734    #finds maximum allowed hkl for given A within dmin
735    Hmax = getHKLmax(dmin,SGData,A)
736       
737    dminsq = 1./(dmin**2)
738    HKL = []
739    if SGLaue == '-1':                       #triclinic
740        for l in range(-Hmax[2],Hmax[2]+1):
741            for k in range(-Hmax[1],Hmax[1]+1):
742                hmin = 0
743                if (k < 0) or (k ==0 and l < 0): hmin = 1
744                for h in range(hmin,Hmax[0]+1):
745                    H = []
746                    if CentCheck(SGLatt,[h,k,l]): H=[h,k,l]
747                    if H:
748                        rdsq = calc_rDsq(H,A)
749                        if 0 < rdsq <= dminsq:
750                            HKL.append([h,k,l,1/math.sqrt(rdsq)])
751    elif SGLaue == '2/m':                #monoclinic
752        axisnum = 1 + ['a','b','c'].index(SGUniq)
753        Hmax = SwapIndx(axisnum,Hmax)
754        for h in range(Hmax[0]+1):
755            for k in range(-Hmax[1],Hmax[1]+1):
756                lmin = 0
757                if k < 0:lmin = 1
758                for l in range(lmin,Hmax[2]+1):
759                    [h,k,l] = SwapIndx(-axisnum,[h,k,l])
760                    H = []
761                    if CentCheck(SGLatt,[h,k,l]): H=[h,k,l]
762                    if H:
763                        rdsq = calc_rDsq(H,A)
764                        if 0 < rdsq <= dminsq:
765                            HKL.append([h,k,l,1/math.sqrt(rdsq)])
766                    [h,k,l] = SwapIndx(axisnum,[h,k,l])
767    elif SGLaue in ['mmm','4/m','6/m']:            #orthorhombic
768        for l in range(Hmax[2]+1):
769            for h in range(Hmax[0]+1):
770                kmin = 1
771                if SGLaue == 'mmm' or h ==0: kmin = 0
772                for k in range(kmin,Hmax[1]+1):
773                    H = []
774                    if CentCheck(SGLatt,[h,k,l]): H=[h,k,l]
775                    if H:
776                        rdsq = calc_rDsq(H,A)
777                        if 0 < rdsq <= dminsq:
778                            HKL.append([h,k,l,1/math.sqrt(rdsq)])
779    elif SGLaue in ['4/mmm','6/mmm']:                  #tetragonal & hexagonal
780        for l in range(Hmax[2]+1):
781            for h in range(Hmax[0]+1):
782                for k in range(h+1):
783                    H = []
784                    if CentCheck(SGLatt,[h,k,l]): H=[h,k,l]
785                    if H:
786                        rdsq = calc_rDsq(H,A)
787                        if 0 < rdsq <= dminsq:
788                            HKL.append([h,k,l,1/math.sqrt(rdsq)])
789    elif SGLaue in ['3m1','31m','3','3R','3mR']:                  #trigonals
790        for l in range(-Hmax[2],Hmax[2]+1):
791            hmin = 0
792            if l < 0: hmin = 1
793            for h in range(hmin,Hmax[0]+1):
794                if SGLaue in ['3R','3']:
795                    kmax = h
796                    kmin = -int((h-1.)/2.)
797                else:
798                    kmin = 0
799                    kmax = h
800                    if SGLaue in ['3m1','3mR'] and l < 0: kmax = h-1
801                    if SGLaue == '31m' and l < 0: kmin = 1
802                for k in range(kmin,kmax+1):
803                    H = []
804                    if CentCheck(SGLatt,[h,k,l]): H=[h,k,l]
805                    if SGLaue in ['3R','3mR']:
806                        H = Hx2Rh(H)
807                    if H:
808                        rdsq = calc_rDsq(H,A)
809                        if 0 < rdsq <= dminsq:
810                            HKL.append([H[0],H[1],H[2],1/math.sqrt(rdsq)])
811    else:                                   #cubic
812        for h in range(Hmax[0]+1):
813            for k in range(h+1):
814                lmin = 0
815                lmax = k
816                if SGLaue =='m3':
817                    lmax = h-1
818                    if h == k: lmax += 1
819                for l in range(lmin,lmax+1):
820                    H = []
821                    if CentCheck(SGLatt,[h,k,l]): H=[h,k,l]
822                    if H:
823                        rdsq = calc_rDsq(H,A)
824                        if 0 < rdsq <= dminsq:
825                            HKL.append([h,k,l,1/math.sqrt(rdsq)])
826    return sortHKLd(HKL,True,True)
827
828#Spherical harmonics routines
829def OdfChk(SGLaue,L,M):
830    'needs doc string'
831    if not L%2 and abs(M) <= L:
832        if SGLaue == '0':                      #cylindrical symmetry
833            if M == 0: return True
834        elif SGLaue == '-1':
835            return True
836        elif SGLaue == '2/m':
837            if not abs(M)%2: return True
838        elif SGLaue == 'mmm':
839            if not abs(M)%2 and M >= 0: return True
840        elif SGLaue == '4/m':
841            if not abs(M)%4: return True
842        elif SGLaue == '4/mmm':
843            if not abs(M)%4 and M >= 0: return True
844        elif SGLaue in ['3R','3']:
845            if not abs(M)%3: return True
846        elif SGLaue in ['3mR','3m1','31m']:
847            if not abs(M)%3 and M >= 0: return True
848        elif SGLaue == '6/m':
849            if not abs(M)%6: return True
850        elif SGLaue == '6/mmm':
851            if not abs(M)%6 and M >= 0: return True
852        elif SGLaue == 'm3':
853            if M > 0:
854                if L%12 == 2:
855                    if M <= L/12: return True
856                else:
857                    if M <= L/12+1: return True
858        elif SGLaue == 'm3m':
859            if M > 0:
860                if L%12 == 2:
861                    if M <= L/12: return True
862                else:
863                    if M <= L/12+1: return True
864    return False
865       
866def GenSHCoeff(SGLaue,SamSym,L,IfLMN=True):
867    'needs doc string'
868    coeffNames = []
869    for iord in [2*i+2 for i in range(L/2)]:
870        for m in [i-iord for i in range(2*iord+1)]:
871            if OdfChk(SamSym,iord,m):
872                for n in [i-iord for i in range(2*iord+1)]:
873                    if OdfChk(SGLaue,iord,n):
874                        if IfLMN:
875                            coeffNames.append('C(%d,%d,%d)'%(iord,m,n))
876                        else:
877                            coeffNames.append('C(%d,%d)'%(iord,n))
878    return coeffNames
879   
880def CrsAng(H,cell,SGData):
881    'needs doc string'
882    a,b,c,al,be,ga = cell
883    SQ3 = 1.732050807569
884    H1 = np.array([1,0,0])
885    H2 = np.array([0,1,0])
886    H3 = np.array([0,0,1])
887    H4 = np.array([1,1,1])
888    G,g = cell2Gmat(cell)
889    Laue = SGData['SGLaue']
890    Naxis = SGData['SGUniq']
891    DH = np.inner(H,np.inner(G,H))
892    if Laue == '2/m':
893        if Naxis == 'a':
894            DR = np.inner(H1,np.inner(G,H1))
895            DHR = np.inner(H,np.inner(G,H1))
896        elif Naxis == 'b':
897            DR = np.inner(H2,np.inner(G,H2))
898            DHR = np.inner(H,np.inner(G,H2))
899        else:
900            DR = np.inner(H3,np.inner(G,H3))
901            DHR = np.inner(H,np.inner(G,H3))
902    elif Laue in ['R3','R3m']:
903        DR = np.inner(H4,np.inner(G,H4))
904        DHR = np.inner(H,np.inner(G,H4))
905       
906    else:
907        DR = np.inner(H3,np.inner(G,H3))
908        DHR = np.inner(H,np.inner(G,H3))
909    DHR /= np.sqrt(DR*DH)
910    phi = np.where(DHR <= 1.0,acosd(DHR),0.0)
911    if Laue == '-1':
912        BA = H[1]*a/(b-H[0]*cosd(ga))
913        BB = H[0]*sind(ga)**2
914    elif Laue == '2/m':
915        if Naxis == 'a':
916            BA = H[2]*b/(c-H[1]*cosd(al))
917            BB = H[1]*sind(al)**2
918        elif Naxis == 'b':
919            BA = H[0]*c/(a-H[2]*cosd(be))
920            BB = H[2]*sind(be)**2
921        else:
922            BA = H[1]*a/(b-H[0]*cosd(ga))
923            BB = H[0]*sind(ga)**2
924    elif Laue in ['mmm','4/m','4/mmm']:
925        BA = H[1]*a
926        BB = H[0]*b
927   
928    elif Laue in ['3R','3mR']:
929        BA = H[0]+H[1]-2.0*H[2]
930        BB = SQ3*(H[0]-H[1])
931    elif Laue in ['m3','m3m']:
932        BA = H[1]
933        BB = H[0]
934    else:
935        BA = H[0]+2.0*H[1]
936        BB = SQ3*H[0]
937    beta = atan2d(BA,BB)
938    return phi,beta
939   
940def SamAng(Tth,Gangls,Sangl,IFCoup):
941    """Compute sample orientation angles vs laboratory coord. system
942
943    :param Tth:        Signed theta                                   
944    :param Gangls:     Sample goniometer angles phi,chi,omega,azmuth 
945    :param Sangl:      Sample angle zeros om-0, chi-0, phi-0         
946    :param IFCoup:     True if omega & 2-theta coupled in CW scan
947    :returns: 
948        psi,gam:    Sample odf angles                             
949        dPSdA,dGMdA:    Angle zero derivatives
950    """                         
951   
952    rpd = math.pi/180.
953    if IFCoup:
954        GSomeg = sind(Gangls[2]+Tth)
955        GComeg = cosd(Gangls[2]+Tth)
956    else:
957        GSomeg = sind(Gangls[2])
958        GComeg = cosd(Gangls[2])
959    GSTth = sind(Tth)
960    GCTth = cosd(Tth)     
961    GSazm = sind(Gangls[3])
962    GCazm = cosd(Gangls[3])
963    GSchi = sind(Gangls[1])
964    GCchi = cosd(Gangls[1])
965    GSphi = sind(Gangls[0]+Sangl[2])
966    GCphi = cosd(Gangls[0]+Sangl[2])
967    SSomeg = sind(Sangl[0])
968    SComeg = cosd(Sangl[0])
969    SSchi = sind(Sangl[1])
970    SCchi = cosd(Sangl[1])
971    AT = -GSTth*GComeg+GCTth*GCazm*GSomeg
972    BT = GSTth*GSomeg+GCTth*GCazm*GComeg
973    CT = -GCTth*GSazm*GSchi
974    DT = -GCTth*GSazm*GCchi
975   
976    BC1 = -AT*GSphi+(CT+BT*GCchi)*GCphi
977    BC2 = DT-BT*GSchi
978    BC3 = AT*GCphi+(CT+BT*GCchi)*GSphi
979     
980    BC = BC1*SComeg*SCchi+BC2*SComeg*SSchi-BC3*SSomeg     
981    psi = acosd(BC)
982   
983    BD = 1.0-BC**2
984    if BD > 0.:
985        C = rpd/math.sqrt(BD)
986    else:
987        C = 0.
988    dPSdA = [-C*(-BC1*SSomeg*SCchi-BC2*SSomeg*SSchi-BC3*SComeg),
989        -C*(-BC1*SComeg*SSchi+BC2*SComeg*SCchi),
990        -C*(-BC1*SSomeg-BC3*SComeg*SCchi)]
991     
992    BA = -BC1*SSchi+BC2*SCchi
993    BB = BC1*SSomeg*SCchi+BC2*SSomeg*SSchi+BC3*SComeg
994    gam = atan2d(BB,BA)
995
996    BD = (BA**2+BB**2)/rpd
997
998    dBAdO = 0
999    dBAdC = -BC1*SCchi-BC2*SSchi
1000    dBAdF = BC3*SSchi
1001   
1002    dBBdO = BC1*SComeg*SCchi+BC2*SComeg*SSchi-BC3*SSomeg
1003    dBBdC = -BC1*SSomeg*SSchi+BC2*SSomeg*SCchi
1004    dBBdF = BC1*SComeg-BC3*SSomeg*SCchi
1005   
1006    if BD > 0.:
1007        dGMdA = [(BA*dBBdO-BB*dBAdO)/BD,(BA*dBBdC-BB*dBAdC)/BD,(BA*dBBdF-BB*dBAdF)/BD]
1008    else:
1009        dGMdA = [0.0,0.0,0.0]
1010
1011       
1012    return psi,gam,dPSdA,dGMdA
1013
1014BOH = {
1015'L=2':[[],[],[]],
1016'L=4':[[0.30469720,0.36418281],[],[]],
1017'L=6':[[-0.14104740,0.52775103],[],[]],
1018'L=8':[[0.28646862,0.21545346,0.32826995],[],[]],
1019'L=10':[[-0.16413497,0.33078546,0.39371345],[],[]],
1020'L=12':[[0.26141975,0.27266871,0.03277460,0.32589402],
1021    [0.09298802,-0.23773812,0.49446631,0.0],[]],
1022'L=14':[[-0.17557309,0.25821932,0.27709173,0.33645360],[],[]],
1023'L=16':[[0.24370673,0.29873515,0.06447688,0.00377,0.32574495],
1024    [0.12039646,-0.25330128,0.23950998,0.40962508,0.0],[]],
1025'L=18':[[-0.16914245,0.17017340,0.34598142,0.07433932,0.32696037],
1026    [-0.06901768,0.16006562,-0.24743528,0.47110273,0.0],[]],
1027'L=20':[[0.23067026,0.31151832,0.09287682,0.01089683,0.00037564,0.32573563],
1028    [0.13615420,-0.25048007,0.12882081,0.28642879,0.34620433,0.0],[]],
1029'L=22':[[-0.16109560,0.10244188,0.36285175,0.13377513,0.01314399,0.32585583],
1030    [-0.09620055,0.20244115,-0.22389483,0.17928946,0.42017231,0.0],[]],
1031'L=24':[[0.22050742,0.31770654,0.11661736,0.02049853,0.00150861,0.00003426,0.32573505],
1032    [0.13651722,-0.21386648,0.00522051,0.33939435,0.10837396,0.32914497,0.0],
1033    [0.05378596,-0.11945819,0.16272298,-0.26449730,0.44923956,0.0,0.0]],
1034'L=26':[[-0.15435003,0.05261630,0.35524646,0.18578869,0.03259103,0.00186197,0.32574594],
1035    [-0.11306511,0.22072681,-0.18706142,0.05439948,0.28122966,0.35634355,0.0],[]],
1036'L=28':[[0.21225019,0.32031716,0.13604702,0.03132468,0.00362703,0.00018294,0.00000294,0.32573501],
1037    [0.13219496,-0.17206256,-0.08742608,0.32671661,0.17973107,0.02567515,0.32619598,0.0],
1038    [0.07989184,-0.16735346,0.18839770,-0.20705337,0.12926808,0.42715602,0.0,0.0]],
1039'L=30':[[-0.14878368,0.01524973,0.33628434,0.22632587,0.05790047,0.00609812,0.00022898,0.32573594],
1040    [-0.11721726,0.20915005,-0.11723436,-0.07815329,0.31318947,0.13655742,0.33241385,0.0],
1041    [-0.04297703,0.09317876,-0.11831248,0.17355132,-0.28164031,0.42719361,0.0,0.0]],
1042'L=32':[[0.20533892,0.32087437,0.15187897,0.04249238,0.00670516,0.00054977,0.00002018,0.00000024,0.32573501],
1043    [0.12775091,-0.13523423,-0.14935701,0.28227378,0.23670434,0.05661270,0.00469819,0.32578978,0.0],
1044    [0.09703829,-0.19373733,0.18610682,-0.14407046,0.00220535,0.26897090,0.36633402,0.0,0.0]],
1045'L=34':[[-0.14409234,-0.01343681,0.31248977,0.25557722,0.08571889,0.01351208,0.00095792,0.00002550,0.32573508],
1046    [-0.11527834,0.18472133,-0.04403280,-0.16908618,0.27227021,0.21086614,0.04041752,0.32688152,0.0],
1047    [-0.06773139,0.14120811,-0.15835721,0.18357456,-0.19364673,0.08377174,0.43116318,0.0,0.0]]
1048}
1049
1050Lnorm = lambda L: 4.*np.pi/(2.0*L+1.)
1051
1052def GetKcl(L,N,SGLaue,phi,beta):
1053    'needs doc string'
1054    import pytexture as ptx
1055    RSQ2PI = 0.3989422804014
1056    SQ2 = 1.414213562373
1057    if SGLaue in ['m3','m3m']:
1058        Kcl = 0.0
1059        for j in range(0,L+1,4):
1060            im = j/4+1
1061            pcrs,dum = ptx.pyplmpsi(L,j,1,phi)
1062            Kcl += BOH['L='+str(L)][N-1][im-1]*pcrs*cosd(j*beta)       
1063    else:
1064        pcrs,dum = ptx.pyplmpsi(L,N,1,phi)
1065        pcrs *= RSQ2PI
1066        if N:
1067            pcrs *= SQ2
1068        if SGLaue in ['mmm','4/mmm','6/mmm','R3mR','3m1','31m']:
1069            if SGLaue in ['3mR','3m1','31m']: 
1070                if N%6 == 3:
1071                    Kcl = pcrs*sind(N*beta)
1072                else:
1073                    Kcl = pcrs*cosd(N*beta)
1074            else:
1075                Kcl = pcrs*cosd(N*beta)
1076        else:
1077            Kcl = pcrs*(cosd(N*beta)+sind(N*beta))
1078    return Kcl
1079   
1080def GetKsl(L,M,SamSym,psi,gam):
1081    'needs doc string'
1082    import pytexture as ptx
1083    RSQPI = 0.5641895835478
1084    SQ2 = 1.414213562373
1085    psrs,dpdps = ptx.pyplmpsi(L,M,1,psi)
1086    psrs *= RSQPI
1087    dpdps *= RSQPI
1088    if M == 0:
1089        psrs /= SQ2
1090        dpdps /= SQ2
1091    if SamSym in ['mmm',]:
1092        dum = cosd(M*gam)
1093        Ksl = psrs*dum
1094        dKsdp = dpdps*dum
1095        dKsdg = -psrs*M*sind(M*gam)
1096    else:
1097        dum = cosd(M*gam)+sind(M*gam)
1098        Ksl = psrs*dum
1099        dKsdp = dpdps*dum
1100        dKsdg = psrs*M*(-sind(M*gam)+cosd(M*gam))
1101    return Ksl,dKsdp,dKsdg
1102   
1103def GetKclKsl(L,N,SGLaue,psi,phi,beta):
1104    """
1105    This is used for spherical harmonics description of preferred orientation;
1106        cylindrical symmetry only (M=0) and no sample angle derivatives returned
1107    """
1108    import pytexture as ptx
1109    RSQ2PI = 0.3989422804014
1110    SQ2 = 1.414213562373
1111    Ksl,x = ptx.pyplmpsi(L,0,1,psi)
1112    Ksl *= RSQ2PI
1113    if SGLaue in ['m3','m3m']:
1114        Kcl = 0.0
1115        for j in range(0,L+1,4):
1116            im = j/4+1
1117            pcrs,dum = ptx.pyplmpsi(L,j,1,phi)
1118            Kcl += BOH['L='+str(L)][N-1][im-1]*pcrs*cosd(j*beta)       
1119    else:
1120        pcrs,dum = ptx.pyplmpsi(L,N,1,phi)
1121        pcrs *= RSQ2PI
1122        if N:
1123            pcrs *= SQ2
1124        if SGLaue in ['mmm','4/mmm','6/mmm','R3mR','3m1','31m']:
1125            if SGLaue in ['3mR','3m1','31m']: 
1126                if N%6 == 3:
1127                    Kcl = pcrs*sind(N*beta)
1128                else:
1129                    Kcl = pcrs*cosd(N*beta)
1130            else:
1131                Kcl = pcrs*cosd(N*beta)
1132        else:
1133            Kcl = pcrs*(cosd(N*beta)+sind(N*beta))
1134    return Kcl*Ksl,Lnorm(L)
1135   
1136def Glnh(Start,SHCoef,psi,gam,SamSym):
1137    'needs doc string'
1138    import pytexture as ptx
1139    RSQPI = 0.5641895835478
1140    SQ2 = 1.414213562373
1141
1142    if Start:
1143        ptx.pyqlmninit()
1144        Start = False
1145    Fln = np.zeros(len(SHCoef))
1146    for i,term in enumerate(SHCoef):
1147        l,m,n = eval(term.strip('C'))
1148        pcrs,dum = ptx.pyplmpsi(l,m,1,psi)
1149        pcrs *= RSQPI
1150        if m == 0:
1151            pcrs /= SQ2
1152        if SamSym in ['mmm',]:
1153            Ksl = pcrs*cosd(m*gam)
1154        else:
1155            Ksl = pcrs*(cosd(m*gam)+sind(m*gam))
1156        Fln[i] = SHCoef[term]*Ksl*Lnorm(l)
1157    ODFln = dict(zip(SHCoef.keys(),list(zip(SHCoef.values(),Fln))))
1158    return ODFln
1159
1160def Flnh(Start,SHCoef,phi,beta,SGData):
1161    'needs doc string'
1162    import pytexture as ptx
1163   
1164    FORPI = 12.5663706143592
1165    RSQPI = 0.5641895835478
1166    SQ2 = 1.414213562373
1167
1168    if Start:
1169        ptx.pyqlmninit()
1170        Start = False
1171    Fln = np.zeros(len(SHCoef))
1172    for i,term in enumerate(SHCoef):
1173        l,m,n = eval(term.strip('C'))
1174        if SGData['SGLaue'] in ['m3','m3m']:
1175            Kcl = 0.0
1176            for j in range(0,l+1,4):
1177                im = j/4+1
1178                pcrs,dum = ptx.pyplmpsi(l,j,1,phi)
1179                Kcl += BOH['L='+str(l)][n-1][im-1]*pcrs*cosd(j*beta)       
1180        else:                #all but cubic
1181            pcrs,dum = ptx.pyplmpsi(l,n,1,phi)
1182            pcrs *= RSQPI
1183            if n == 0:
1184                pcrs /= SQ2
1185            if SGData['SGLaue'] in ['mmm','4/mmm','6/mmm','R3mR','3m1','31m']:
1186               if SGData['SGLaue'] in ['3mR','3m1','31m']: 
1187                   if n%6 == 3:
1188                       Kcl = pcrs*sind(n*beta)
1189                   else:
1190                       Kcl = pcrs*cosd(n*beta)
1191               else:
1192                   Kcl = pcrs*cosd(n*beta)
1193            else:
1194                Kcl = pcrs*(cosd(n*beta)+sind(n*beta))
1195        Fln[i] = SHCoef[term]*Kcl*Lnorm(l)
1196    ODFln = dict(zip(SHCoef.keys(),list(zip(SHCoef.values(),Fln))))
1197    return ODFln
1198   
1199def polfcal(ODFln,SamSym,psi,gam):
1200    'needs doc string'
1201    import pytexture as ptx
1202    RSQPI = 0.5641895835478
1203    SQ2 = 1.414213562373
1204    PolVal = np.ones_like(gam)
1205    for term in ODFln:
1206        if abs(ODFln[term][1]) > 1.e-3:
1207            l,m,n = eval(term.strip('C'))
1208            psrs,dum = ptx.pyplmpsi(l,m,len(psi),psi)
1209            if SamSym in ['-1','2/m']:
1210                if m != 0:
1211                    Ksl = RSQPI*psrs*(cosd(m*gam)+sind(m*gam))
1212                else:
1213                    Ksl = RSQPI*psrs/SQ2
1214            else:
1215                if m != 0:
1216                    Ksl = RSQPI*psrs*cosd(m*gam)
1217                else:
1218                    Ksl = RSQPI*psrs/SQ2
1219            PolVal += ODFln[term][1]*Ksl
1220    return PolVal
1221   
1222def invpolfcal(ODFln,SGData,phi,beta):
1223    'needs doc string'
1224    import pytexture as ptx
1225   
1226    FORPI = 12.5663706143592
1227    RSQPI = 0.5641895835478
1228    SQ2 = 1.414213562373
1229
1230    invPolVal = np.ones_like(beta)
1231    for term in ODFln:
1232        if abs(ODFln[term][1]) > 1.e-3:
1233            l,m,n = eval(term.strip('C'))
1234            if SGData['SGLaue'] in ['m3','m3m']:
1235                Kcl = 0.0
1236                for j in range(0,l+1,4):
1237                    im = j/4+1
1238                    pcrs,dum = ptx.pyplmpsi(l,j,len(beta),phi)
1239                    Kcl += BOH['L='+str(l)][n-1][im-1]*pcrs*cosd(j*beta)       
1240            else:                #all but cubic
1241                pcrs,dum = ptx.pyplmpsi(l,n,len(beta),phi)
1242                pcrs *= RSQPI
1243                if n == 0:
1244                    pcrs /= SQ2
1245                if SGData['SGLaue'] in ['mmm','4/mmm','6/mmm','R3mR','3m1','31m']:
1246                   if SGData['SGLaue'] in ['3mR','3m1','31m']: 
1247                       if n%6 == 3:
1248                           Kcl = pcrs*sind(n*beta)
1249                       else:
1250                           Kcl = pcrs*cosd(n*beta)
1251                   else:
1252                       Kcl = pcrs*cosd(n*beta)
1253                else:
1254                    Kcl = pcrs*(cosd(n*beta)+sind(n*beta))
1255            invPolVal += ODFln[term][1]*Kcl
1256    return invPolVal
1257   
1258   
1259def textureIndex(SHCoef):
1260    'needs doc string'
1261    Tindx = 1.0
1262    for term in SHCoef:
1263        l = eval(term.strip('C'))[0]
1264        Tindx += SHCoef[term]**2/(2.0*l+1.)
1265    return Tindx
1266   
1267# self-test materials follow.
1268selftestlist = []
1269'''Defines a list of self-tests'''
1270selftestquiet = True
1271def _ReportTest():
1272    'Report name and doc string of current routine when ``selftestquiet`` is False'
1273    if not selftestquiet:
1274        import inspect
1275        caller = inspect.stack()[1][3]
1276        doc = eval(caller).__doc__
1277        if doc is not None:
1278            print('testing '+__file__+' with '+caller+' ('+doc+')')
1279        else:
1280            print('testing '+__file__()+" with "+caller)
1281NeedTestData = True
1282def TestData():
1283    array = np.array
1284    global NeedTestData
1285    NeedTestData = False
1286    global CellTestData
1287    # output from uctbx computed on platform darwin on 2010-05-28
1288    CellTestData = [
1289# cell, g, G, cell*, V, V*
1290  [(4, 4, 4, 90, 90, 90), 
1291   array([[  1.60000000e+01,   9.79717439e-16,   9.79717439e-16],
1292       [  9.79717439e-16,   1.60000000e+01,   9.79717439e-16],
1293       [  9.79717439e-16,   9.79717439e-16,   1.60000000e+01]]), array([[  6.25000000e-02,   3.82702125e-18,   3.82702125e-18],
1294       [  3.82702125e-18,   6.25000000e-02,   3.82702125e-18],
1295       [  3.82702125e-18,   3.82702125e-18,   6.25000000e-02]]), (0.25, 0.25, 0.25, 90.0, 90.0, 90.0), 64.0, 0.015625],
1296# cell, g, G, cell*, V, V*
1297  [(4.0999999999999996, 5.2000000000000002, 6.2999999999999998, 100, 80, 130), 
1298   array([[ 16.81      , -13.70423184,   4.48533243],
1299       [-13.70423184,  27.04      ,  -5.6887143 ],
1300       [  4.48533243,  -5.6887143 ,  39.69      ]]), array([[ 0.10206349,  0.05083339, -0.00424823],
1301       [ 0.05083339,  0.06344997,  0.00334956],
1302       [-0.00424823,  0.00334956,  0.02615544]]), (0.31947376387537696, 0.25189277536327803, 0.16172643497798223, 85.283666420376008, 94.716333579624006, 50.825714168082683), 100.98576357983838, 0.0099023858863968445],
1303# cell, g, G, cell*, V, V*
1304  [(3.5, 3.5, 6, 90, 90, 120), 
1305   array([[  1.22500000e+01,  -6.12500000e+00,   1.28587914e-15],
1306       [ -6.12500000e+00,   1.22500000e+01,   1.28587914e-15],
1307       [  1.28587914e-15,   1.28587914e-15,   3.60000000e+01]]), array([[  1.08843537e-01,   5.44217687e-02,   3.36690552e-18],
1308       [  5.44217687e-02,   1.08843537e-01,   3.36690552e-18],
1309       [  3.36690552e-18,   3.36690552e-18,   2.77777778e-02]]), (0.32991443953692895, 0.32991443953692895, 0.16666666666666669, 90.0, 90.0, 60.000000000000021), 63.652867178156257, 0.015710211406520427],
1310  ]
1311    global CoordTestData
1312    CoordTestData = [
1313# cell, ((frac, ortho),...)
1314  ((4,4,4,90,90,90,), [
1315 ((0.10000000000000001, 0.0, 0.0),(0.40000000000000002, 0.0, 0.0)),
1316 ((0.0, 0.10000000000000001, 0.0),(2.4492935982947065e-17, 0.40000000000000002, 0.0)),
1317 ((0.0, 0.0, 0.10000000000000001),(2.4492935982947065e-17, -2.4492935982947065e-17, 0.40000000000000002)),
1318 ((0.10000000000000001, 0.20000000000000001, 0.29999999999999999),(0.40000000000000013, 0.79999999999999993, 1.2)),
1319 ((0.20000000000000001, 0.29999999999999999, 0.10000000000000001),(0.80000000000000016, 1.2, 0.40000000000000002)),
1320 ((0.29999999999999999, 0.20000000000000001, 0.10000000000000001),(1.2, 0.80000000000000004, 0.40000000000000002)),
1321 ((0.5, 0.5, 0.5),(2.0, 1.9999999999999998, 2.0)),
1322]),
1323# cell, ((frac, ortho),...)
1324  ((4.1,5.2,6.3,100,80,130,), [
1325 ((0.10000000000000001, 0.0, 0.0),(0.40999999999999998, 0.0, 0.0)),
1326 ((0.0, 0.10000000000000001, 0.0),(-0.33424955703700043, 0.39834311042186865, 0.0)),
1327 ((0.0, 0.0, 0.10000000000000001),(0.10939835193016617, -0.051013289294572106, 0.6183281045774256)),
1328 ((0.10000000000000001, 0.20000000000000001, 0.29999999999999999),(0.069695941716497567, 0.64364635296002093, 1.8549843137322766)),
1329 ((0.20000000000000001, 0.29999999999999999, 0.10000000000000001),(-0.073350319180835066, 1.1440160419710339, 0.6183281045774256)),
1330 ((0.29999999999999999, 0.20000000000000001, 0.10000000000000001),(0.67089923785616512, 0.74567293154916525, 0.6183281045774256)),
1331 ((0.5, 0.5, 0.5),(0.92574397446582857, 1.7366491056364828, 3.0916405228871278)),
1332]),
1333# cell, ((frac, ortho),...)
1334  ((3.5,3.5,6,90,90,120,), [
1335 ((0.10000000000000001, 0.0, 0.0),(0.35000000000000003, 0.0, 0.0)),
1336 ((0.0, 0.10000000000000001, 0.0),(-0.17499999999999993, 0.3031088913245536, 0.0)),
1337 ((0.0, 0.0, 0.10000000000000001),(3.6739403974420595e-17, -3.6739403974420595e-17, 0.60000000000000009)),
1338 ((0.10000000000000001, 0.20000000000000001, 0.29999999999999999),(2.7675166561703527e-16, 0.60621778264910708, 1.7999999999999998)),
1339 ((0.20000000000000001, 0.29999999999999999, 0.10000000000000001),(0.17500000000000041, 0.90932667397366063, 0.60000000000000009)),
1340 ((0.29999999999999999, 0.20000000000000001, 0.10000000000000001),(0.70000000000000018, 0.6062177826491072, 0.60000000000000009)),
1341 ((0.5, 0.5, 0.5),(0.87500000000000067, 1.5155444566227676, 3.0)),
1342]),
1343]
1344    global LaueTestData             #generated by GSAS
1345    LaueTestData = {
1346    'R 3 m':[(4.,4.,6.,90.,90.,120.),((1,0,1,6),(1,0,-2,6),(0,0,3,2),(1,1,0,6),(2,0,-1,6),(2,0,2,6),
1347        (1,1,3,12),(1,0,4,6),(2,1,1,12),(2,1,-2,12),(3,0,0,6),(1,0,-5,6),(2,0,-4,6),(3,0,-3,6),(3,0,3,6),
1348        (0,0,6,2),(2,2,0,6),(2,1,4,12),(2,0,5,6),(3,1,-1,12),(3,1,2,12),(1,1,6,12),(2,2,3,12),(2,1,-5,12))],
1349    'R 3':[(4.,4.,6.,90.,90.,120.),((1,0,1,6),(1,0,-2,6),(0,0,3,2),(1,1,0,6),(2,0,-1,6),(2,0,2,6),(1,1,3,6),
1350        (1,1,-3,6),(1,0,4,6),(3,-1,1,6),(2,1,1,6),(3,-1,-2,6),(2,1,-2,6),(3,0,0,6),(1,0,-5,6),(2,0,-4,6),
1351        (2,2,0,6),(3,0,3,6),(3,0,-3,6),(0,0,6,2),(3,-1,4,6),(2,0,5,6),(2,1,4,6),(4,-1,-1,6),(3,1,-1,6),
1352        (3,1,2,6),(4,-1,2,6),(2,2,-3,6),(1,1,-6,6),(1,1,6,6),(2,2,3,6),(2,1,-5,6),(3,-1,-5,6))],
1353    'P 3':[(4.,4.,6.,90.,90.,120.),((0,0,1,2),(1,0,0,6),(1,0,1,6),(0,0,2,2),(1,0,-1,6),(1,0,2,6),(1,0,-2,6),
1354        (1,1,0,6),(0,0,3,2),(1,1,1,6),(1,1,-1,6),(1,0,3,6),(1,0,-3,6),(2,0,0,6),(2,0,-1,6),(1,1,-2,6),
1355        (1,1,2,6),(2,0,1,6),(2,0,-2,6),(2,0,2,6),(0,0,4,2),(1,1,-3,6),(1,1,3,6),(1,0,-4,6),(1,0,4,6),
1356        (2,0,-3,6),(2,1,0,6),(2,0,3,6),(3,-1,0,6),(2,1,1,6),(3,-1,-1,6),(2,1,-1,6),(3,-1,1,6),(1,1,4,6),
1357        (3,-1,2,6),(3,-1,-2,6),(1,1,-4,6),(0,0,5,2),(2,1,2,6),(2,1,-2,6),(3,0,0,6),(3,0,1,6),(2,0,4,6),
1358        (2,0,-4,6),(3,0,-1,6),(1,0,-5,6),(1,0,5,6),(3,-1,-3,6),(2,1,-3,6),(2,1,3,6),(3,-1,3,6),(3,0,-2,6),
1359        (3,0,2,6),(1,1,5,6),(1,1,-5,6),(2,2,0,6),(3,0,3,6),(3,0,-3,6),(0,0,6,2),(2,0,-5,6),(2,1,-4,6),
1360        (2,2,-1,6),(3,-1,-4,6),(2,2,1,6),(3,-1,4,6),(2,1,4,6),(2,0,5,6),(1,0,-6,6),(1,0,6,6),(4,-1,0,6),
1361        (3,1,0,6),(3,1,-1,6),(3,1,1,6),(4,-1,-1,6),(2,2,2,6),(4,-1,1,6),(2,2,-2,6),(3,1,2,6),(3,1,-2,6),
1362        (3,0,4,6),(3,0,-4,6),(4,-1,-2,6),(4,-1,2,6),(2,2,-3,6),(1,1,6,6),(1,1,-6,6),(2,2,3,6),(3,-1,5,6),
1363        (2,1,5,6),(2,1,-5,6),(3,-1,-5,6))],
1364    'P 3 m 1':[(4.,4.,6.,90.,90.,120.),((0,0,1,2),(1,0,0,6),(1,0,-1,6),(1,0,1,6),(0,0,2,2),(1,0,-2,6),
1365        (1,0,2,6),(1,1,0,6),(0,0,3,2),(1,1,1,12),(1,0,-3,6),(1,0,3,6),(2,0,0,6),(1,1,2,12),(2,0,1,6),
1366        (2,0,-1,6),(0,0,4,2),(2,0,-2,6),(2,0,2,6),(1,1,3,12),(1,0,-4,6),(1,0,4,6),(2,0,3,6),(2,1,0,12),
1367        (2,0,-3,6),(2,1,1,12),(2,1,-1,12),(1,1,4,12),(2,1,2,12),(0,0,5,2),(2,1,-2,12),(3,0,0,6),(1,0,-5,6),
1368        (3,0,1,6),(3,0,-1,6),(1,0,5,6),(2,0,4,6),(2,0,-4,6),(2,1,3,12),(2,1,-3,12),(3,0,-2,6),(3,0,2,6),
1369        (1,1,5,12),(3,0,-3,6),(0,0,6,2),(2,2,0,6),(3,0,3,6),(2,1,4,12),(2,2,1,12),(2,0,5,6),(2,1,-4,12),
1370        (2,0,-5,6),(1,0,-6,6),(1,0,6,6),(3,1,0,12),(3,1,-1,12),(3,1,1,12),(2,2,2,12),(3,1,2,12),
1371        (3,0,4,6),(3,1,-2,12),(3,0,-4,6),(1,1,6,12),(2,2,3,12))],
1372    'P 3 1 m':[(4.,4.,6.,90.,90.,120.),((0,0,1,2),(1,0,0,6),(0,0,2,2),(1,0,1,12),(1,0,2,12),(1,1,0,6),
1373        (0,0,3,2),(1,1,-1,6),(1,1,1,6),(1,0,3,12),(2,0,0,6),(2,0,1,12),(1,1,2,6),(1,1,-2,6),(2,0,2,12),
1374        (0,0,4,2),(1,1,-3,6),(1,1,3,6),(1,0,4,12),(2,1,0,12),(2,0,3,12),(2,1,1,12),(2,1,-1,12),(1,1,-4,6),
1375        (1,1,4,6),(0,0,5,2),(2,1,-2,12),(2,1,2,12),(3,0,0,6),(1,0,5,12),(2,0,4,12),(3,0,1,12),(2,1,-3,12),
1376        (2,1,3,12),(3,0,2,12),(1,1,5,6),(1,1,-5,6),(3,0,3,12),(0,0,6,2),(2,2,0,6),(2,1,-4,12),(2,0,5,12),
1377        (2,2,-1,6),(2,2,1,6),(2,1,4,12),(3,1,0,12),(1,0,6,12),(2,2,2,6),(3,1,-1,12),(2,2,-2,6),(3,1,1,12),
1378        (3,1,-2,12),(3,0,4,12),(3,1,2,12),(1,1,-6,6),(2,2,3,6),(2,2,-3,6),(1,1,6,6))],
1379    }
1380   
1381    global FLnhTestData
1382    FLnhTestData = [{
1383    'C(4,0,0)': (0.965, 0.42760447),
1384    'C(2,0,0)': (1.0122, -0.80233610),
1385    'C(2,0,2)': (0.0061, 8.37491546E-03),
1386    'C(6,0,4)': (-0.0898, 4.37985696E-02),
1387    'C(6,0,6)': (-0.1369, -9.04081762E-02),
1388    'C(6,0,0)': (0.5935, -0.18234928),
1389    'C(4,0,4)': (0.1872, 0.16358127),
1390    'C(6,0,2)': (0.6193, 0.27573633),
1391    'C(4,0,2)': (-0.1897, 0.12530720)},[1,0,0]]
1392def test0():
1393    if NeedTestData: TestData()
1394    msg = 'test cell2Gmat, fillgmat, Gmat2cell'
1395    for (cell, tg, tG, trcell, tV, trV) in CellTestData:
1396        G, g = cell2Gmat(cell)
1397        assert np.allclose(G,tG),msg
1398        assert np.allclose(g,tg),msg
1399        tcell = Gmat2cell(g)
1400        assert np.allclose(cell,tcell),msg
1401        tcell = Gmat2cell(G)
1402        assert np.allclose(tcell,trcell),msg
1403selftestlist.append(test0)
1404
1405def test1():
1406    'test cell2A and A2Gmat'
1407    _ReportTest()
1408    if NeedTestData: TestData()
1409    msg = 'test cell2A and A2Gmat'
1410    for (cell, tg, tG, trcell, tV, trV) in CellTestData:
1411        G, g = A2Gmat(cell2A(cell))
1412        assert np.allclose(G,tG),msg
1413        assert np.allclose(g,tg),msg
1414selftestlist.append(test1)
1415
1416def test2():
1417    'test Gmat2A, A2cell, A2Gmat, Gmat2cell'
1418    _ReportTest()
1419    if NeedTestData: TestData()
1420    msg = 'test Gmat2A, A2cell, A2Gmat, Gmat2cell'
1421    for (cell, tg, tG, trcell, tV, trV) in CellTestData:
1422        G, g = cell2Gmat(cell)
1423        tcell = A2cell(Gmat2A(G))
1424        assert np.allclose(cell,tcell),msg
1425selftestlist.append(test2)
1426
1427def test3():
1428    'test invcell2Gmat'
1429    _ReportTest()
1430    if NeedTestData: TestData()
1431    msg = 'test invcell2Gmat'
1432    for (cell, tg, tG, trcell, tV, trV) in CellTestData:
1433        G, g = invcell2Gmat(trcell)
1434        assert np.allclose(G,tG),msg
1435        assert np.allclose(g,tg),msg
1436selftestlist.append(test3)
1437
1438def test4():
1439    'test calc_rVsq, calc_rV, calc_V'
1440    _ReportTest()
1441    if NeedTestData: TestData()
1442    msg = 'test calc_rVsq, calc_rV, calc_V'
1443    for (cell, tg, tG, trcell, tV, trV) in CellTestData:
1444        assert np.allclose(calc_rV(cell2A(cell)),trV), msg
1445        assert np.allclose(calc_V(cell2A(cell)),tV), msg
1446selftestlist.append(test4)
1447
1448def test5():
1449    'test A2invcell'
1450    _ReportTest()
1451    if NeedTestData: TestData()
1452    msg = 'test A2invcell'
1453    for (cell, tg, tG, trcell, tV, trV) in CellTestData:
1454        rcell = A2invcell(cell2A(cell))
1455        assert np.allclose(rcell,trcell),msg
1456selftestlist.append(test5)
1457
1458def test6():
1459    'test cell2AB'
1460    _ReportTest()
1461    if NeedTestData: TestData()
1462    msg = 'test cell2AB'
1463    for (cell,coordlist) in CoordTestData:
1464        A,B = cell2AB(cell)
1465        for (frac,ortho) in coordlist:
1466            to = np.inner(A,frac)
1467            tf = np.inner(B,to)
1468            assert np.allclose(ortho,to), msg
1469            assert np.allclose(frac,tf), msg
1470            to = np.sum(A*frac,axis=1)
1471            tf = np.sum(B*to,axis=1)
1472            assert np.allclose(ortho,to), msg
1473            assert np.allclose(frac,tf), msg
1474selftestlist.append(test6)
1475
1476def test7():
1477    'test GetBraviasNum(...) and GenHBravais(...)'
1478    _ReportTest()
1479    import os.path
1480    import sys
1481    import GSASIIspc as spc
1482    testdir = os.path.join(os.path.split(os.path.abspath( __file__ ))[0],'testinp')
1483    if os.path.exists(testdir):
1484        if testdir not in sys.path: sys.path.insert(0,testdir)
1485    import sgtbxlattinp
1486    derror = 1e-4
1487    def indexmatch(hklin, hkllist, system):
1488        for hklref in hkllist:
1489            hklref = list(hklref)
1490            # these permutations are far from complete, but are sufficient to
1491            # allow the test to complete
1492            if system == 'cubic':
1493                permlist = [(1,2,3),(1,3,2),(2,1,3),(2,3,1),(3,1,2),(3,2,1),]
1494            elif system == 'monoclinic':
1495                permlist = [(1,2,3),(-1,2,-3)]
1496            else:
1497                permlist = [(1,2,3)]
1498
1499            for perm in permlist:
1500                hkl = [abs(i) * hklin[abs(i)-1] / i for i in perm]
1501                if hkl == hklref: return True
1502                if [-i for i in hkl] == hklref: return True
1503        else:
1504            return False
1505
1506    for key in sgtbxlattinp.sgtbx7:
1507        spdict = spc.SpcGroup(key)
1508        cell = sgtbxlattinp.sgtbx7[key][0]
1509        system = spdict[1]['SGSys']
1510        center = spdict[1]['SGLatt']
1511
1512        bravcode = GetBraviasNum(center, system)
1513
1514        g2list = GenHBravais(sgtbxlattinp.dmin, bravcode, cell2A(cell))
1515
1516        assert len(sgtbxlattinp.sgtbx7[key][1]) == len(g2list), 'Reflection lists differ for %s' % key
1517        for h,k,l,d,num in g2list:
1518            for hkllist,dref in sgtbxlattinp.sgtbx7[key][1]: 
1519                if abs(d-dref) < derror:
1520                    if indexmatch((h,k,l,), hkllist, system):
1521                        break
1522            else:
1523                assert 0,'No match for %s at %s (%s)' % ((h,k,l),d,key)
1524selftestlist.append(test7)
1525
1526def test8():
1527    'test GenHLaue'
1528    _ReportTest()
1529    import GSASIIspc as spc
1530    import sgtbxlattinp
1531    derror = 1e-4
1532    dmin = sgtbxlattinp.dmin
1533
1534    def indexmatch(hklin, hklref, system, axis):
1535        # these permutations are far from complete, but are sufficient to
1536        # allow the test to complete
1537        if system == 'cubic':
1538            permlist = [(1,2,3),(1,3,2),(2,1,3),(2,3,1),(3,1,2),(3,2,1),]
1539        elif system == 'monoclinic' and axis=='b':
1540            permlist = [(1,2,3),(-1,2,-3)]
1541        elif system == 'monoclinic' and axis=='a':
1542            permlist = [(1,2,3),(1,-2,-3)]
1543        elif system == 'monoclinic' and axis=='c':
1544            permlist = [(1,2,3),(-1,-2,3)]
1545        elif system == 'trigonal':
1546            permlist = [(1,2,3),(2,1,3),(-1,-2,3),(-2,-1,3)]
1547        elif system == 'rhombohedral':
1548            permlist = [(1,2,3),(2,3,1),(3,1,2)]
1549        else:
1550            permlist = [(1,2,3)]
1551
1552        hklref = list(hklref)
1553        for perm in permlist:
1554            hkl = [abs(i) * hklin[abs(i)-1] / i for i in perm]
1555            if hkl == hklref: return True
1556            if [-i for i in hkl] == hklref: return True
1557        return False
1558
1559    for key in sgtbxlattinp.sgtbx8:
1560        spdict = spc.SpcGroup(key)[1]
1561        cell = sgtbxlattinp.sgtbx8[key][0]
1562        center = spdict['SGLatt']
1563        Laue = spdict['SGLaue']
1564        Axis = spdict['SGUniq']
1565        system = spdict['SGSys']
1566
1567        g2list = GenHLaue(dmin,spdict,cell2A(cell))
1568        #if len(g2list) != len(sgtbxlattinp.sgtbx8[key][1]):
1569        #    print 'failed',key,':' ,len(g2list),'vs',len(sgtbxlattinp.sgtbx8[key][1])
1570        #    print 'GSAS-II:'
1571        #    for h,k,l,d in g2list: print '  ',(h,k,l),d
1572        #    print 'SGTBX:'
1573        #    for hkllist,dref in sgtbxlattinp.sgtbx8[key][1]: print '  ',hkllist,dref
1574        assert len(g2list) == len(sgtbxlattinp.sgtbx8[key][1]), (
1575            'Reflection lists differ for %s' % key
1576            )
1577        #match = True
1578        for h,k,l,d in g2list:
1579            for hkllist,dref in sgtbxlattinp.sgtbx8[key][1]: 
1580                if abs(d-dref) < derror:
1581                    if indexmatch((h,k,l,), hkllist, system, Axis): break
1582            else:
1583                assert 0,'No match for %s at %s (%s)' % ((h,k,l),d,key)
1584                #match = False
1585        #if not match:
1586            #for hkllist,dref in sgtbxlattinp.sgtbx8[key][1]: print '  ',hkllist,dref
1587            #print center, Laue, Axis, system
1588selftestlist.append(test8)
1589           
1590def test9():
1591    'test GenHLaue'
1592    _ReportTest()
1593    import GSASIIspc as G2spc
1594    if NeedTestData: TestData()
1595    for spc in LaueTestData:
1596        data = LaueTestData[spc]
1597        cell = data[0]
1598        hklm = np.array(data[1])
1599        H = hklm[-1][:3]
1600        hklO = hklm.T[:3].T
1601        A = cell2A(cell)
1602        dmin = 1./np.sqrt(calc_rDsq(H,A))
1603        SGData = G2spc.SpcGroup(spc)[1]
1604        hkls = np.array(GenHLaue(dmin,SGData,A))
1605        hklN = hkls.T[:3].T
1606        #print spc,hklO.shape,hklN.shape
1607        err = True
1608        for H in hklO:
1609            if H not in hklN:
1610                print H,' missing from hkl from GSASII'
1611                err = False
1612        assert(err)
1613selftestlist.append(test9)
1614       
1615       
1616   
1617
1618if __name__ == '__main__':
1619    # run self-tests
1620    selftestquiet = False
1621    for test in selftestlist:
1622        test()
1623    print "OK"
Note: See TracBrowser for help on using the repository browser.