source: trunk/GSASIIlattice.py @ 2126

Last change on this file since 2126 was 2126, checked in by vondreele, 6 years ago

add laueUnique to G2lattice for reindexing hkls to just unique Laue part
fix printing error for odd nos. symmetry operators in PrintDistAngle? in G2strmain

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