source: trunk/GSASIIspc.py @ 4876

Last change on this file since 4876 was 4876, checked in by toby, 6 months ago

fix cell offsets in CIF export

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Author Revision URL Id
File size: 175.0 KB
Line 
1# -*- coding: utf-8 -*-
2"""
3*GSASIIspc: Space group module*
4-------------------------------
5
6Space group interpretation routines. Note that space group information is
7stored in a :ref:`Space Group (SGData)<SGData_table>` object.
8
9"""
10########### SVN repository information ###################
11# $Date: 2021-04-08 22:34:29 +0000 (Thu, 08 Apr 2021) $
12# $Author: toby $
13# $Revision: 4876 $
14# $URL: trunk/GSASIIspc.py $
15# $Id: GSASIIspc.py 4876 2021-04-08 22:34:29Z toby $
16########### SVN repository information ###################
17from __future__ import division, print_function
18import numpy as np
19import numpy.linalg as nl
20import scipy.optimize as so
21import sys
22import copy
23import os.path as ospath
24
25import GSASIIpath
26GSASIIpath.SetVersionNumber("$Revision: 4876 $")
27
28npsind = lambda x: np.sin(x*np.pi/180.)
29npcosd = lambda x: np.cos(x*np.pi/180.)
30nxs = np.newaxis
31DEBUG = False
32   
33################################################################################
34#### Space group codes
35################################################################################
36
37def SpcGroup(SGSymbol):
38    """
39    Determines cell and symmetry information from a short H-M space group name
40
41    :param SGSymbol: space group symbol (string) with spaces between axial fields
42    :returns: (SGError,SGData)
43   
44       * SGError = 0 for no errors; >0 for errors (see SGErrors below for details)
45       * SGData - is a dict (see :ref:`Space Group object<SGData_table>`) with entries:
46       
47             * 'SpGrp': space group symbol, slightly cleaned up
48             * 'SGFixed': True if space group data can not be changed, e.g. from magnetic cif; otherwise False
49             * 'SGGray': True if 1' in symbol - gray group for mag. incommensurate phases
50             * 'SGLaue':  one of '-1', '2/m', 'mmm', '4/m', '4/mmm', '3R',
51               '3mR', '3', '3m1', '31m', '6/m', '6/mmm', 'm3', 'm3m'
52             * 'SGInv': boolean; True if centrosymmetric, False if not
53             * 'SGLatt': one of 'P', 'A', 'B', 'C', 'I', 'F', 'R'
54             * 'SGUniq': one of 'a', 'b', 'c' if monoclinic, '' otherwise
55             * 'SGCen': cell centering vectors [0,0,0] at least
56             * 'SGOps': symmetry operations as [M,T] so that M*x+T = x'
57             * 'SGSys': one of 'triclinic', 'monoclinic', 'orthorhombic',
58               'tetragonal', 'rhombohedral', 'trigonal', 'hexagonal', 'cubic'
59             * 'SGPolax': one of ' ', 'x', 'y', 'x y', 'z', 'x z', 'y z',
60               'xyz', '111' for arbitrary axes
61             * 'SGPtGrp': one of 32 point group symbols (with some permutations), which
62                is filled by SGPtGroup, is external (KE) part of supersymmetry point group
63             * 'SSGKl': default internal (Kl) part of supersymmetry point group; modified
64                in supersymmetry stuff depending on chosen modulation vector for Mono & Ortho
65             * 'BNSlattsym': BNS lattice symbol & cenering op - used for magnetic structures
66
67    """
68    LaueSym = ('-1','2/m','mmm','4/m','4/mmm','3R','3mR','3','3m1','31m','6/m','6/mmm','m3','m3m')
69    LattSym = ('P','A','B','C','I','F','R')
70    UniqSym = ('','','a','b','c','',)
71    SysSym = ('triclinic','monoclinic','orthorhombic','tetragonal','rhombohedral','trigonal','hexagonal','cubic')
72    SGData = {}
73    if len(SGSymbol.split()) < 2:
74        return SGErrors(0),SGData
75    if ':R' in SGSymbol:
76        SGSymbol = SGSymbol.replace(':',' ')    #get rid of ':' in R space group symbols from some cif files
77    SGData['SGGray'] = False
78    if "1'" in SGSymbol:        #set for incommensurate magnetic
79        SGData['SGGray'] = True
80        SGSymbol = SGSymbol.replace("1'",'')
81    SGSymbol = SGSymbol.split(':')[0]   #remove :1/2 setting symbol from some cif files
82    if '-2' in SGSymbol:    #replace bad but legal symbols with correct equivalents
83        SGSymbol = SGSymbol.replace('-2','m')
84    if SGSymbol.split()[1] =='3/m':
85        SGSymbol = SGSymbol.replace('3/m','-6')
86    import pyspg
87    SGInfo = pyspg.sgforpy(SGSymbol)
88    SGData['SpGrp'] = SGSymbol.strip().lower().capitalize()
89    SGData['SGLaue'] = LaueSym[SGInfo[0]-1]
90    SGData['SGInv'] = bool(SGInfo[1])
91    SGData['SGLatt'] = LattSym[SGInfo[2]-1]
92    SGData['SGUniq'] = UniqSym[SGInfo[3]+1]
93    SGData['SGFixed'] = False
94    SGData['SGOps'] = []
95    SGData['SGGen'] = []
96    for i in range(SGInfo[5]):
97        Mat = np.array(SGInfo[6][i])
98        Trns = np.array(SGInfo[7][i])
99        SGData['SGOps'].append([Mat,Trns])
100        if 'array' in str(type(SGInfo[8])):        #patch for old fortran bin?
101            SGData['SGGen'].append(int(SGInfo[8][i]))
102    SGData['BNSlattsym'] = [LattSym[SGInfo[2]-1],[0,0,0]]
103    lattSpin = []
104    if SGData['SGLatt'] == 'P':
105        SGData['SGCen'] = np.array(([0,0,0],))
106    elif SGData['SGLatt'] == 'A':
107        SGData['SGCen'] = np.array(([0,0,0],[0,.5,.5]))
108        lattSpin += [1,]
109    elif SGData['SGLatt'] == 'B':
110        SGData['SGCen'] = np.array(([0,0,0],[.5,0,.5]))
111        lattSpin += [1,]
112    elif SGData['SGLatt'] == 'C':
113        SGData['SGCen'] = np.array(([0,0,0],[.5,.5,0,]))
114        lattSpin += [1,]
115    elif SGData['SGLatt'] == 'I':
116        SGData['SGCen'] = np.array(([0,0,0],[.5,.5,.5]))
117        lattSpin += [1,]
118    elif SGData['SGLatt'] == 'F':
119        SGData['SGCen'] = np.array(([0,0,0],[0,.5,.5],[.5,0,.5],[.5,.5,0,]))
120        lattSpin += [1,1,1,1]
121    elif SGData['SGLatt'] == 'R':
122        SGData['SGCen'] = np.array(([0,0,0],[2./3,1./3,1./3],[1./3,2./3,2./3]))
123
124    if SGData['SGInv']:
125        if SGData['SGLaue'] in ['-1','2/m','mmm']:
126            Ibar = 7
127        elif SGData['SGLaue'] in ['4/m','4/mmm']:
128            Ibar = 1
129        elif SGData['SGLaue'] in ['3R','3mR','3','3m1','31m','6/m','6/mmm']:
130            Ibar = 15 #8+4+2+1
131        else:
132            Ibar = 4
133        Ibarx = Ibar&14
134    else:
135        Ibarx = 8
136        if SGData['SGLaue'] in ['-1','2/m','mmm','m3','m3m']:
137            Ibarx = 0
138    moregen = []
139    for i,gen in enumerate(SGData['SGGen']):
140        if SGData['SGLaue'] in ['m3','m3m']:
141            if gen in [1,2,4]:
142                SGData['SGGen'][i] = 4
143            elif gen < 7:
144                SGData['SGGen'][i] = 0
145        elif SGData['SGLaue'] in ['4/m','4/mmm','3R','3mR','3','3m1','31m','6/m','6/mmm']:
146            if gen == 2:
147                SGData['SGGen'][i] = 4
148            elif gen in [3,5]:
149                SGData['SGGen'][i] = 3
150            elif gen == 6:
151                if SGData['SGLaue'] in ['4/m','4/mmm']:
152                    SGData['SGGen'][i] = 128
153                else:
154                    SGData['SGGen'][i] = 16
155            elif not SGData['SGInv'] and gen == 12:
156                SGData['SGGen'][i] = 8
157            elif (not SGData['SGInv']) and (SGData['SGLaue'] in ['3','3m1','31m','6/m','6/mmm']) and (gen == 1):
158                SGData['SGGen'][i] = 24
159        gen = SGData['SGGen'][i]
160        if gen == 99:
161            gen = 8
162            if SGData['SGLaue'] in ['3m1','31m','6/m','6/mmm']:
163                gen = 3
164            elif SGData['SGLaue'] == 'm3m':
165                gen = 12
166            SGData['SGGen'][i] = gen
167        elif gen == 98:
168            gen = 8
169            if SGData['SGLaue'] in ['3m1','31m','6/m','6/mmm']:
170                gen = 4
171            SGData['SGGen'][i] = gen
172        elif not SGData['SGInv'] and gen in [23,] and SGData['SGLaue'] in ['m3','m3m']:
173            SGData['SGGen'][i] = 24
174        elif gen >= 16 and gen != 128:
175            if not SGData['SGInv']:
176                gen = 31
177            else:
178                gen ^= Ibarx
179            SGData['SGGen'][i] = gen
180        if SGData['SGInv']:
181            if gen < 128:
182                moregen.append(SGData['SGGen'][i]^Ibar)
183            else:
184                moregen.append(1)
185    SGData['SGGen'] += moregen
186    if SGData['SGLaue'] in '-1':
187        SGData['SGSys'] = SysSym[0]
188    elif SGData['SGLaue'] in '2/m':
189        SGData['SGSys'] = SysSym[1]
190    elif SGData['SGLaue'] in 'mmm':
191        SGData['SGSys'] = SysSym[2]
192    elif SGData['SGLaue'] in ['4/m','4/mmm']:
193        SGData['SGSys'] = SysSym[3]
194    elif SGData['SGLaue'] in ['3R','3mR']:
195        SGData['SGSys'] = SysSym[4]
196    elif SGData['SGLaue'] in ['3','3m1','31m']:
197        SGData['SGSys'] = SysSym[5]
198    elif SGData['SGLaue'] in ['6/m','6/mmm']:
199        SGData['SGSys'] = SysSym[6]
200    elif SGData['SGLaue'] in ['m3','m3m']:
201        SGData['SGSys'] = SysSym[7]
202    SGData['SGPolax'] = SGpolar(SGData)
203    SGData['SGPtGrp'],SGData['SSGKl'] = SGPtGroup(SGData)
204
205    if SGData['SGLatt'] == 'R':
206        if SGData['SGPtGrp'] in ['3',]:
207            SGData['SGSpin'] = 3*[1,]
208        elif SGData['SGPtGrp'] in  ['-3','32','3m']:
209            SGData['SGSpin'] = 4*[1,]
210        elif SGData['SGPtGrp'] in  ['-3m',]:
211            SGData['SGSpin'] = 5*[1,]
212       
213    else:
214        if SGData['SGPtGrp'] in ['1','3','23',]:
215            SGData['SGSpin'] = lattSpin+[1,]
216        elif SGData['SGPtGrp'] in ['-1','2','m','4','-4','-3','312','321','3m1','31m','6','-6','432','-43m']:
217            SGData['SGSpin'] = lattSpin+[1,1,]
218        elif SGData['SGPtGrp'] in ['2/m','4/m','422','4mm','-42m','-4m2','-3m1','-31m',
219            '6/m','622','6mm','-6m2','-62m','m3','m3m']:
220            SGData['SGSpin'] = lattSpin+[1,1,1,]
221        else: #'222'-'mmm','4/mmm','6/mmm'
222            SGData['SGSpin'] = lattSpin+[1,1,1,1,]
223    return SGInfo[-1],SGData
224
225def SGErrors(IErr):
226    '''
227    Interprets the error message code from SpcGroup. Used in SpaceGroup.
228   
229    :param IErr: see SGError in :func:`SpcGroup`
230    :returns:
231        ErrString - a string with the error message or "Unknown error"
232    '''
233
234    ErrString = [' ',
235        'Less than 2 operator fields were found',
236        'Illegal Lattice type, not P, A, B, C, I, F or R',
237        'Rhombohedral lattice requires a 3-axis',
238        'Minus sign does not preceed 1, 2, 3, 4 or 6',
239        'Either a 5-axis anywhere or a 3-axis in field not allowed',
240        ' ',
241        'I for COMPUTED GO TO out of range.',
242        'An a-glide mirror normal to A not allowed',
243        'A b-glide mirror normal to B not allowed',
244        'A c-glide mirror normal to C not allowed',
245        'D-glide in a primitive lattice not allowed',
246        'A 4-axis not allowed in the 2nd operator field',
247        'A 6-axis not allowed in the 2nd operator field',
248        'More than 24 matrices needed to define group',
249        ' ',
250        'Improper construction of a rotation operator',
251        'Mirror following a / not allowed',
252        'A translation conflict between operators',
253        'The 2bar operator is not allowed',
254        '3 fields are legal only in R & m3 cubic groups',
255        'Syntax error. Expected I -4 3 d at this point',
256        ' ',
257        'A or B centered tetragonal not allowed',
258        ' ','unknown error in sgroup',' ',' ',' ',
259        'Illegal character in the space group symbol',
260        ]
261    try:
262        return ErrString[IErr]
263    except:
264        return "Unknown error"
265
266def SGpolar(SGData):
267    '''
268    Determine identity of polar axes if any
269    '''
270    POL = ('','x','y','x y','z','x z','y z','xyz','111')
271    NP = [1,2,4]
272    NPZ = [0,1]
273    for M,T in SGData['SGOps']:
274        for i in range(3):
275            if M[i][i] <= 0.: NP[i] = 0
276        if M[0][2] > 0: NPZ[0] = 8
277        if M[1][2] > 0: NPZ[1] = 0
278    NPol = (NP[0]+NP[1]+NP[2]+NPZ[0]*NPZ[1])*(1-int(SGData['SGInv']))
279    return POL[NPol]
280   
281def SGPtGroup(SGData):
282    '''
283    Determine point group of the space group - done after space group symbol has
284    been evaluated by SpcGroup. Only short symbols are allowed
285   
286    :param SGData: from :func SpcGroup
287    :returns: SSGPtGrp & SSGKl (only defaults for Mono & Ortho)
288    '''
289    Flds = SGData['SpGrp'].split()
290    if len(Flds) < 2:
291        return '',[]
292    if SGData['SGLaue'] == '-1':    #triclinic
293        if '-' in Flds[1]:
294            return '-1',[-1,]
295        else:
296            return '1',[1,]
297    elif SGData['SGLaue'] == '2/m': #monoclinic - default for 2D modulation vector
298        if '/' in SGData['SpGrp']:
299            return '2/m',[-1,1]
300        elif '2' in SGData['SpGrp']:
301            return '2',[-1,]
302        else:
303            return 'm',[1,]
304    elif SGData['SGLaue'] == 'mmm': #orthorhombic
305        if SGData['SpGrp'].count('2') == 3:
306            return '222',[-1,-1,-1]
307        elif SGData['SpGrp'].count('2') == 1:
308            if SGData['SGPolax'] == 'x':
309                return '2mm',[-1,1,1]
310            elif SGData['SGPolax'] == 'y':
311                return 'm2m',[1,-1,1]
312            elif SGData['SGPolax'] == 'z':
313                return 'mm2',[1,1,-1]
314        else:
315            return 'mmm',[1,1,1]
316    elif SGData['SGLaue'] == '4/m': #tetragonal
317        if '/' in SGData['SpGrp']:
318            return '4/m',[1,-1]
319        elif '-' in Flds[1]:
320            return '-4',[-1,]
321        else:
322            return '4',[1,]
323    elif SGData['SGLaue'] == '4/mmm':
324        if '/' in SGData['SpGrp']:
325            return '4/mmm',[1,-1,1,1]
326        elif '-' in Flds[1]:
327            if '2' in Flds[2]:
328                return '-42m',[-1,-1,1]
329            else:
330                return '-4m2',[-1,1,-1]             
331        elif '2' in Flds[2:]:
332            return '422',[1,-1,-1]
333        else:
334            return '4mm',[1,1,1]
335    elif SGData['SGLaue'] in ['3','3R']:  #trigonal/rhombohedral
336        if '-' in Flds[1]:
337            return '-3',[-1,]
338        else:
339            return '3',[1,]
340    elif SGData['SGLaue'] == '3mR' or 'R' in Flds[0]:
341        if '2' in Flds[2]:
342            return '32',[1,-1]
343        elif '-' in Flds[1]:
344            return '-3m',[-1,1]
345        else:
346            return '3m',[1,1]
347    elif SGData['SGLaue'] == '3m1':
348        if '2' in Flds[2]:
349            return '321',[1,-1,1]
350        elif '-' in Flds[1]:
351            return '-3m1',[-1,1,1]
352        else:
353            return '3m1',[1,1,1]
354    elif SGData['SGLaue'] == '31m':
355        if '2' in Flds[3]:
356            return '312',[1,1,-1]
357        elif '-' in Flds[1]:
358            return '-31m',[-1,1,1]
359        else:
360            return '31m',[1,1,1]
361    elif SGData['SGLaue'] == '6/m': #hexagonal
362        if '/' in SGData['SpGrp']:
363            return '6/m',[1,-1]
364        elif '-' in SGData['SpGrp']:
365            return '-6',[-1,]
366        else:
367            return '6',[1,]
368    elif SGData['SGLaue'] == '6/mmm':
369        if '/' in SGData['SpGrp']:
370            return '6/mmm',[1,-1,1,1]
371        elif '-' in Flds[1]:
372            if '2' in Flds[2]:
373                return '-62m',[-1,-1,1]
374            else:
375                return '-6m2',[-1,1,-1]                 
376        elif '2' in Flds[2:]:
377            return '622',[1,-1,-1]
378        else:
379            return '6mm',[1,1,1]   
380    elif SGData['SGLaue'] == 'm3':      #cubic - no (3+1) supersymmetry
381        if '2' in Flds[1]:
382            return '23',[]
383        else: 
384            return 'm3',[]
385    elif SGData['SGLaue'] == 'm3m':
386        if '4' in Flds[1]:
387            if '-' in Flds[1]:
388                return '-43m',[]
389            else:
390                return '432',[]
391        else:
392            return 'm3m',[]
393   
394def SGPrint(SGData,AddInv=False):
395    '''
396    Print the output of SpcGroup in a nicely formatted way. Used in SpaceGroup
397
398    :param SGData: from :func:`SpcGroup`
399    :returns:
400        SGText - list of strings with the space group details
401        SGTable - list of strings for each of the operations
402    '''
403    if SGData.get('SGFixed',False):       #inverses included in ops for cif fixed
404        Mult = len(SGData['SGCen'])*len(SGData['SGOps'])
405    else:
406        Mult = len(SGData['SGCen'])*len(SGData['SGOps'])*(int(SGData['SGInv'])+1)
407    SGText = []
408    SGText.append(' Space Group: '+SGData['SpGrp'])
409    SGCen = list(SGData['SGCen'])
410    if SGData.get('SGGray',False):
411        SGText[-1] += " 1'"
412        if SGData.get('SGFixed',False): 
413            Mult //= 2
414        else:
415            SGCen += list(SGData['SGCen']+[0,0,0])
416            SGCen =  np.array(SGCen)%1.
417    CentStr = 'centrosymmetric'
418    if not SGData['SGInv']:
419        CentStr = 'non'+CentStr
420    if SGData['SGLatt'] in 'ABCIFR':
421        SGText.append(' The lattice is '+CentStr+' '+SGData['SGLatt']+'-centered '+SGData['SGSys'].lower())
422    else:
423        SGText.append(' The lattice is '+CentStr+' '+'primitive '+SGData['SGSys'].lower()) 
424    SGText.append(' The Laue symmetry is '+SGData['SGLaue'])
425    if 'SGPtGrp' in SGData:         #patch
426        SGText.append(' The lattice point group is '+SGData['SGPtGrp'])
427    SGText.append(' Multiplicity of a general site is '+str(Mult))
428    if SGData['SGUniq'] in ['a','b','c']:
429        SGText.append(' The unique monoclinic axis is '+SGData['SGUniq'])
430    if SGData['SGInv']:
431        SGText.append(' The inversion center is located at 0,0,0')
432    if SGData['SGPolax']:
433        SGText.append(' The location of the origin is arbitrary in '+SGData['SGPolax'])
434    SGText.append(' ')
435    if len(SGData['SGCen']) == 1:
436        SGText.append(' The equivalent positions are:\n')
437    else:   
438        SGText.append(' The equivalent positions are:\n')
439        SGText.append(' ('+Latt2text(SGCen)+')+\n')
440    SGTable = []
441    for i,Opr in enumerate(SGData['SGOps']):
442        SGTable.append('(%2d) %s'%(i+1,MT2text(Opr)))
443    if AddInv and SGData['SGInv']:
444        for i,Opr in enumerate(SGData['SGOps']):
445            IOpr = [-Opr[0],-Opr[1]]
446            SGTable.append('(%2d) %s'%(i+1,MT2text(IOpr)))       
447    return SGText,SGTable
448
449def AllOps(SGData):
450    '''
451    Returns a list of all operators for a space group, including those for
452    centering and a center of symmetry
453   
454    :param SGData: from :func:`SpcGroup`
455    :returns: (SGTextList,offsetList,symOpList,G2oprList) where
456
457      * SGTextList: a list of strings with formatted and normalized
458        symmetry operators.
459      * offsetList: a tuple of (dx,dy,dz) offsets that relate the GSAS-II
460        symmetry operation to the operator in SGTextList and symOpList.
461        these dx (etc.) values are added to the GSAS-II generated
462        positions to provide the positions that are generated
463        by the normalized symmetry operators.       
464      * symOpList: a list of tuples with the normalized symmetry
465        operations as (M,T) values
466        (see ``SGOps`` in the :ref:`Space Group object<SGData_table>`)
467      * G2oprList: a list with the GSAS-II operations for each symmetry operation as
468        a tuple with (center,mult,opnum,opcode), where center is (0,0,0), (0.5,0,0),
469        (0.5,0.5,0.5),...; where mult is 1 or -1 for the center of symmetry
470        where opnum is the number for the symmetry operation, in ``SGOps``
471        (starting with 0) and opcode is mult*(100*icen+j+1).
472      * G2opcodes: a list with the name that GSAS-II uses for each symmetry
473        operation (same as opcode, above)
474    '''
475    SGTextList = []
476    offsetList = []
477    symOpList = []
478    G2oprList = []
479    G2opcodes = []
480    onebar = (1,)
481    if SGData['SGInv']:
482        onebar += (-1,)
483    for icen,cen in enumerate(SGData['SGCen']):
484        for mult in onebar:
485            for j,(M,T) in enumerate(SGData['SGOps']):
486                offset = [0,0,0]
487                Tprime = (mult*T)+cen
488                for i in range(3):
489                    while Tprime[i] < 0:
490                        Tprime[i] += 1
491                        offset[i] += 1
492                    while Tprime[i] >= 1:
493                        Tprime[i] += -1
494                        offset[i] += -1
495                Opr = [mult*M,Tprime]
496                OPtxt = MT2text(Opr)
497                SGTextList.append(OPtxt.replace(' ',''))
498                offsetList.append(tuple(offset))
499                symOpList.append((mult*M,Tprime))
500                G2oprList.append((cen,mult,j))
501                G2opcodes.append(mult*(100*icen+j+1))
502    return SGTextList,offsetList,symOpList,G2oprList,G2opcodes
503
504def TextOps(text,table,reverse=False):
505    ''' Makes formatted operator list
506        :param text,table: arrays of text made by SGPrint
507        :param reverse: True for x+1/2 form; False for 1/2+x form
508        :returns: OpText: full list of symmetry operators; one operation per line
509        generally printed to console for use via cut/paste in other programs, but
510        could be used for direct input
511    '''
512    OpText = []
513    Inv = True
514    Super = False
515    if 'noncentro' in text[1]:
516        Inv = False
517    if 'Super' in text[0]:
518        Super = True
519    Cent = [[0,0,0],]
520    if Super:
521        Cent = [[0,0,0,0],]
522    if '0,0,0' in text[-1]:
523        Cent = np.array(eval(text[-1].split('+')[0].replace(';','),(')))
524    OpsM = []
525    OpsT = []
526    for item in table:
527        if 'for' in item: continue
528        if Super:
529            M,T = MagSSText2MTS(item.split(')')[1].replace(' ',''),G2=True)[:2]
530        else:
531            M,T = Text2MT(item.split(')')[1].replace(' ',''),CIF=True)
532        OpsM.append(M)
533        OpsT.append(T)
534    OpsM = np.array(OpsM)
535    OpsT = np.array(OpsT)
536    if Inv and not Super:   #inversion ops altready listed in supersymmetries
537        OpsM = np.concatenate((OpsM,-OpsM))
538        OpsT = np.concatenate((OpsT,-OpsT%1.))
539    for cent in Cent:
540        for iop,opM in enumerate(list(OpsM)):
541            if Super:
542                txt = SSMT2text([opM,(OpsT[iop]+cent)%1.])
543            else:
544                txt = MT2text([opM,(OpsT[iop]+cent)%1.],reverse)
545            OpText.append(txt.replace(' ','').lower())
546    return OpText
547
548def TextGen(SGData,reverse=False):      #does not always work correctly - not used anyway
549    GenSym,GenFlg,BNSsym = GetGenSym(SGData)
550    SGData['GenSym'] = GenSym
551    SGData['GenFlg'] = GenFlg
552    text,table = SGPrint(SGData)
553    GenText = []
554    OprNames = GetOprNames(SGData)
555    OpText = TextOps(text,table,reverse)
556    for name in SGData['GenSym']:
557        gid = OprNames.index(name.replace(' ',''))
558        GenText.append(OpText[gid])
559    if len(SGData['SGCen']) > 1:
560        GenText.append(OpText[-1])
561    return GenText
562
563def GetOprNames(SGData):
564    OprNames = [GetOprPtrName(str(irtx)) for irtx in PackRot(SGData['SGOps'])]
565    if SGData['SGInv']:
566        OprNames += [GetOprPtrName(str(-irtx)) for irtx in PackRot(SGData['SGOps'])]
567    return OprNames
568   
569def MT2text(Opr,reverse=False):
570    "From space group matrix/translation operator returns text version"
571    XYZ = ('-Z','-Y','-X','X-Y','ERR','Y-X','X','Y','Z')
572    TRA = ('   ','ERR','1/6','1/4','1/3','ERR','1/2','ERR','2/3','3/4','5/6','ERR')
573    Fld = ''
574    M,T = Opr
575    for j in range(3):
576        IJ = int(round(2*M[j][0]+3*M[j][1]+4*M[j][2]+4))%12
577        IK = int(round(T[j]*12))%12
578        if IK:
579            if IJ < 3:
580                if reverse:
581                    Fld += (XYZ[IJ]+'+'+TRA[IK]).rjust(5)
582                else:
583                    Fld += (TRA[IK]+XYZ[IJ]).rjust(5)
584            else:
585                if reverse:
586                    Fld += (XYZ[IJ]+'+'+TRA[IK]).rjust(5)
587                else:
588                    Fld += (TRA[IK]+'+'+XYZ[IJ]).rjust(5)
589        else:
590            Fld += XYZ[IJ].rjust(5)
591        if j != 2: Fld += ', '
592    return Fld
593   
594def Latt2text(Cen):
595    "From lattice centering vectors returns ';' delimited cell centering vectors"
596    lattTxt = ''
597    fracList = ['1/2','1/3','2/3','1/4','3/4','1/5','2/5','3/5','4/5','1/6','5/6',
598        '1/7','2/7','3/7','4/7','5/7','6/7','1/8','3/8','5/8','7/8','1/9','2/9','4/9','5/9','7/9','8/9']
599    mulList = [2,3,3,4,4,5,5,5,5,6,6,7,7,7,7,7,7,8,8,8,8,9,9,9,9,9,9]
600    prodList = [1.,1.,2.,1.,3.,1.,2.,3.,4.,1.,5.,1.,2.,3.,4.,5.,6.,1.,3.,5.,7.,1.,2.,4.,5.,7.,8.]
601    nCen = len(Cen)
602    for i,cen in enumerate(Cen):
603        txt = ''
604        for icen in cen:
605            if icen == 1:
606                txt += '1,'
607                continue
608            if not icen:
609                txt += '0,'
610                continue
611            if icen < 0:
612                txt += '-'
613                icen *= -1
614            for mul,prod,frac in zip(mulList,prodList,fracList):
615                if abs(icen*mul-prod) < 1.e-5:
616                    txt += frac+','
617                    break
618        lattTxt += txt[:-1]+'; '
619        if i and not i%8 and i < nCen-1:    #not for the last cen!
620            lattTxt += '\n     '
621    return lattTxt[:-2]
622
623def SpaceGroup(SGSymbol):
624    '''
625    Print the output of SpcGroup in a nicely formatted way.
626
627    :param SGSymbol: space group symbol (string) with spaces between axial fields
628    :returns: nothing
629    '''
630    E,A = SpcGroup(SGSymbol)
631    if E > 0:
632        print (SGErrors(E))
633        return
634    for l in SGPrint(A):
635        print (l)
636################################################################################
637#### Magnetic space group stuff
638################################################################################
639       
640def SetMagnetic(SGData):
641    GenSym,GenFlg,BNSsym = GetGenSym(SGData)
642    SGData['GenSym'] = GenSym
643    SGData['GenFlg'] = GenFlg
644    OprNames,SpnFlp = GenMagOps(SGData)
645    SGData['SpnFlp'] = SpnFlp
646    SGData['MagSpGrp'] = MagSGSym(SGData)
647
648def GetGenSym(SGData):
649    '''
650    Get the space group generator symbols
651    :param SGData: from :func:`SpcGroup`
652    LaueSym = ('-1','2/m','mmm','4/m','4/mmm','3R','3mR','3','3m1','31m','6/m','6/mmm','m3','m3m')
653    LattSym = ('P','A','B','C','I','F','R')
654   
655    '''
656    OprNames = [GetOprPtrName(str(irtx)) for irtx in PackRot(SGData['SGOps'])]
657    if SGData['SGInv']:
658        OprNames += [GetOprPtrName(str(-irtx)) for irtx in PackRot(SGData['SGOps'])]
659    Nsyms = len(SGData['SGOps'])
660    if SGData['SGInv'] and not SGData['SGFixed']: Nsyms *= 2
661    UsymOp = ['1',]
662    OprFlg = [0,] 
663    if Nsyms == 2:                    #Centric triclinic or acentric monoclinic
664        UsymOp.append(OprNames[1])
665        OprFlg.append(SGData['SGGen'][1])
666    elif Nsyms == 4:                    #Point symmetry 2/m, 222, 22m, or 4
667        if '4z' in OprNames[1]:          #Point symmetry 4 or -4
668            UsymOp.append(OprNames[1])
669            OprFlg.append(SGData['SGGen'][1])
670        elif not SGData['SGInv']:       #Acentric Orthorhombic
671            if 'm' in OprNames[1:4]:    #22m, 2m2 or m22
672                if '2' in OprNames[1]:      #Acentric orthorhombic, 2mm
673                    UsymOp.append(OprNames[2])
674                    OprFlg.append(SGData['SGGen'][2])
675                    UsymOp.append(OprNames[3])
676                    OprFlg.append(SGData['SGGen'][3])
677                elif '2' in OprNames[2]:    #Acentric orthorhombic, m2m
678                    UsymOp.append(OprNames[1])
679                    OprFlg.append(SGData['SGGen'][1])
680                    UsymOp.append(OprNames[3])
681                    OprFlg.append(SGData['SGGen'][3])
682                else:                       #Acentric orthorhombic, mm2
683                    UsymOp.append(OprNames[1])
684                    OprFlg.append(SGData['SGGen'][1])
685                    UsymOp.append(OprNames[2])
686                    OprFlg.append(SGData['SGGen'][2])
687            else:                           #Acentric orthorhombic, 222
688                SGData['SGGen'][1:] = [4,2,1]
689                UsymOp.append(OprNames[1])
690                OprFlg.append(SGData['SGGen'][1])
691                UsymOp.append(OprNames[2])
692                OprFlg.append(SGData['SGGen'][2])
693                UsymOp.append(OprNames[3])
694                OprFlg.append(SGData['SGGen'][3])
695        else:                               #Centric Monoclinic
696            UsymOp.append(OprNames[1])
697            OprFlg.append(SGData['SGGen'][1])
698            UsymOp.append(OprNames[3])
699            OprFlg.append(SGData['SGGen'][3])
700    elif Nsyms == 6:                    #Point symmetry 32, 3m or 6
701            if '6' in OprNames[1]:      #Hexagonal 6/m Laue symmetry
702                UsymOp.append(OprNames[1])
703                OprFlg.append(SGData['SGGen'][1])
704            else:                       #Trigonal
705                UsymOp.append(OprNames[4])
706                OprFlg.append(SGData['SGGen'][3])
707                if '2110' in OprNames[1]: UsymOp[-1] = ' 2100 '
708    elif Nsyms == 8:                    #Point symmetry mmm, 4/m, or 422, etc
709        if '4' in OprNames[1]:           #Tetragonal
710            if SGData['SGInv']:         #4/m
711                UsymOp.append(OprNames[1])
712                OprFlg.append(SGData['SGGen'][1])
713                UsymOp.append(OprNames[6])
714                OprFlg.append(SGData['SGGen'][6])
715            else:
716                if 'x' in OprNames[4]:      #4mm type group
717                    UsymOp.append(OprNames[4])
718                    OprFlg.append(6)
719                    UsymOp.append(OprNames[7])
720                    OprFlg.append(8)
721                else:                       #-42m, -4m2, and 422 type groups
722                    UsymOp.append(OprNames[5])
723                    OprFlg.append(8)
724                    UsymOp.append(OprNames[6])
725                    OprFlg.append(19)
726        else:                               #Orthorhombic, mmm
727            UsymOp.append(OprNames[1])
728            OprFlg.append(SGData['SGGen'][1])
729            UsymOp.append(OprNames[2])
730            OprFlg.append(SGData['SGGen'][2])
731            UsymOp.append(OprNames[7])
732            OprFlg.append(SGData['SGGen'][7])
733    elif Nsyms == 12 and '3' in OprNames[1] and SGData['SGSys'] != 'cubic':        #Trigonal
734        UsymOp.append(OprNames[3])
735        OprFlg.append(SGData['SGGen'][3])
736        UsymOp.append(OprNames[9])
737        OprFlg.append(SGData['SGGen'][9])
738    elif Nsyms == 12 and '6' in OprNames[1]:        #Hexagonal
739        if 'mz' in OprNames[9]:                     #6/m
740            UsymOp.append(OprNames[1])
741            OprFlg.append(SGData['SGGen'][1])
742            UsymOp.append(OprNames[6])
743            OprFlg.append(SGData['SGGen'][6])
744        else:                                       #6mm, -62m, -6m2 or 622
745            UsymOp.append(OprNames[6])
746            OprFlg.append(18)
747            if 'm' in UsymOp[-1]: OprFlg[-1] = 20
748            UsymOp.append(OprNames[7])
749            OprFlg.append(24)
750    elif Nsyms in [16,24]:
751        if '3' in OprNames[1]:
752            UsymOp.append('')
753            OprFlg.append(SGData['SGGen'][3])
754            for i in range(Nsyms):
755                if 'mx' in OprNames[i]:
756                    UsymOp[-1] = OprNames[i]
757                elif 'm11' in OprNames[i]:
758                    UsymOp[-1] = OprNames[i]
759                elif '211' in OprNames[i]:
760                    UsymOp[-1] = OprNames[i]
761                    OprFlg[-1] = 24
762        else:                                     #4/mmm or 6/mmm
763            UsymOp.append('  mz  ')
764            OprFlg.append(1)
765            if '4' in OprNames[1]:                  #4/mmm
766                UsymOp.append('  mx  ')
767                OprFlg.append(20)
768                UsymOp.append(' m110 ')
769                OprFlg.append(24)
770            else:                                   #6/mmm
771                UsymOp.append(' m110 ')
772                OprFlg.append(4)
773                UsymOp.append(' m+-0 ')
774                OprFlg.append(8)
775    else:                                           #System is cubic
776        if Nsyms == 48:
777            UsymOp.append('  mx  ')
778            OprFlg.append(4)
779            UsymOp.append(' m110 ')
780            OprFlg.append(24)
781           
782    if 'P' in SGData['SGLatt']:
783        if SGData['SGSys'] == 'triclinic':
784            BNSsym = {'P_a':[.5,0,0],'P_b':[0,.5,0],'P_c':[0,0,.5]}           
785        elif SGData['SGSys'] == 'monoclinic':
786            BNSsym = {'P_a':[.5,0,0],'P_b':[0,.5,0],'P_c':[0,0,.5],'P_I':[.5,.5,.5]}
787            if SGData['SGUniq'] == 'a':
788                BNSsym.update({'P_B':[.5,0,.5],'P_C':[.5,.5,0]})
789            elif SGData['SGUniq'] == 'b':
790                BNSsym.update({'P_A':[.5,.5,0],'P_C':[0,.5,.5]})
791            elif SGData['SGUniq'] == 'c':
792                BNSsym.update({'P_A':[0,.5,.5],'P_B':[.5,0,.5]})
793        elif SGData['SGSys'] == 'orthorhombic':
794            BNSsym = {'P_a':[.5,0,0],'P_b':[0,.5,0],'P_c':[0,0,.5],
795                'P_A':[0,.5,.5],'P_B':[.5,0,.5],'P_C':[.5,.5,0],'P_I':[.5,.5,.5]}
796        elif SGData['SGSys'] == 'tetragonal':
797            BNSsym = {'P_c':[0,0,.5],'P_C':[.5,.5,0],'P_I':[.5,.5,.5]}           
798        elif SGData['SGSys'] in ['trigonal','hexagonal']:
799            BNSsym = {'P_c':[0,0,.5]}           
800        elif SGData['SGSys'] == 'cubic':
801            BNSsym = {'P_I':[.5,.5,.5]}           
802           
803    elif 'A' in SGData['SGLatt']:
804        if SGData['SGSys'] == 'monoclinic':
805            BNSsym = {}
806            if SGData['SGUniq'] == 'b':
807                BNSsym.update({'A_a':[.5,0,0],'A_c':[0,0,.5]})
808            elif SGData['SGUniq'] == 'c':
809                BNSsym.update({'A_a':[.5,0,0],'A_b':[0,.5,0]})
810        elif SGData['SGSys'] == 'orthorhombic':
811            BNSsym = {'A_a':[.5,0,0],'A_b':[0,.5,0],'A_c':[0,0,.5],
812               'A_B':[.5,0,.5],'A_C':[.5,.5,0]}   
813        elif SGData['SGSys'] == 'triclinic':
814            BNSsym = {'A_a':[.5,0,0],'A_b':[0,.5,0],'A_c':[0,0,.5]}   
815           
816    elif 'B' in SGData['SGLatt']:
817        if SGData['SGSys'] == 'monoclinic':
818            BNSsym = {}
819            if SGData['SGUniq'] == 'a':
820                BNSsym.update({'B_b':[0,.5,0],'B_c':[0,0,.5]})
821            elif SGData['SGUniq'] == 'c':
822                BNSsym.update({'B_a':[.5,0,0],'B_b':[0,.5,0]})
823        elif SGData['SGSys'] == 'orthorhombic':
824            BNSsym = {'B_a':[.5,0,0],'B_b':[0,.5,0],'B_c':[0,0,.5],
825                'B_A':[0,.5,.5],'B_C':[.5,.5,0]}     
826        elif SGData['SGSys'] == 'triclinic':
827            BNSsym = {'B_a':[.5,0,0],'B_b':[0,.5,0],'B_c':[0,0,.5]}     
828           
829    elif 'C' in SGData['SGLatt']:
830        if SGData['SGSys'] == 'monoclinic':
831            BNSsym = {}
832            if SGData['SGUniq'] == 'a':
833                BNSsym.update({'C_b':[0,.5,.0],'C_c':[0,0,.5]})
834            elif SGData['SGUniq'] == 'b':
835                BNSsym.update({'C_a':[.5,0,0],'C_c':[0,0,.5],'C_B':[.5,0.,.5]})
836        elif SGData['SGSys'] == 'orthorhombic':
837            BNSsym = {'C_a':[.5,0,0],'C_b':[0,.5,0],'C_c':[0,0,.5],
838                'C_A':[0,.5,.5],'C_B':[.5,0,.5]}     
839        elif SGData['SGSys'] == 'triclinic':
840            BNSsym = {'C_a':[.5,0,0],'C_b':[0,.5,0],'C_c':[0,0,.5]}     
841           
842    elif 'I' in SGData['SGLatt']:
843        if SGData['SGSys'] in ['monoclinic','orthorhombic','triclinic']:
844            BNSsym = {'I_a':[.5,0,0],'I_b':[0,.5,0],'I_c':[0,0,.5]}
845        elif SGData['SGSys'] == 'tetragonal':
846            BNSsym = {'I_c':[0,0,.5]}
847        elif SGData['SGSys'] == 'cubic':
848            BNSsym = {} 
849           
850    elif 'F' in SGData['SGLatt']:
851        if SGData['SGSys'] in ['monoclinic','orthorhombic','cubic','triclinic']:
852            BNSsym = {'F_S':[.5,.5,.5]}
853           
854    elif 'R' in SGData['SGLatt']:
855        BNSsym = {'R_I':[0,0,.5]}
856       
857    if SGData['SGGray']:
858        for bns in BNSsym:
859            BNSsym[bns].append(0.5)
860           
861    return UsymOp,OprFlg,BNSsym
862
863def ApplyBNSlatt(SGData,BNSlatt):
864    Tmat = np.eye(3)
865    BNS = BNSlatt[0]
866    A = np.array(BNSlatt[1])
867    Laue = SGData['SGLaue']
868    SGCen = SGData['SGCen']
869    if '_a' in BNS:
870        Tmat[0,0] = 2.0
871    elif '_b' in BNS:
872        Tmat[1,1] = 2.0
873    elif '_c' in BNS:
874        Tmat[2,2] = 2.0
875    elif '_A' in BNS:
876        Tmat[0,0] = 2.0
877    elif '_B' in BNS:
878        Tmat[1,1] = 2.0
879    elif '_C' in BNS:
880        Tmat[2,2] = 2.0
881    elif '_I' in BNS:
882        Tmat *= 2.0
883        if 'R' in Laue:
884            SGData['SGSpin'][-1] = -1
885        else:
886            SGData['SGSpin'].append(-1)
887    elif '_S' in BNS:
888        SGData['SGSpin'][-1] = -1
889        SGData['SGSpin'] += [-1,-1,-1,]
890        Tmat *= 2.0
891    else:
892        return Tmat
893    if SGData.get('SGGray',False):
894        SGData['SGSpin'].append(1)     #BNS centering are spin invrsion
895    else:
896        SGData['SGSpin'].append(-1)     #BNS centering in grey are not spin invrsion
897    C = SGCen+A[:3]
898    SGData['SGCen'] = np.vstack((SGCen,C))%1.
899    return Tmat
900       
901def CheckSpin(isym,SGData):
902    ''' Check for exceptions in spin rules
903    '''
904    if SGData['SGPtGrp'] in ['222','mm2','2mm','m2m']:      #only 2/3 can be red; not 1/3 or 3/3
905        if SGData['SGSpin'][1]*SGData['SGSpin'][2]*SGData['SGSpin'][3] < 0:
906            SGData['SGSpin'][(isym+1)%3+1] *= -1
907        if SGData['SpGrp'][0] == 'F' and isym > 2:
908            SGData['SGSpin'][(isym+1)%3+3] == 1
909    elif SGData['SGPtGrp'] == 'mmm':
910        if SGData['SpGrp'][0] == 'F' and isym > 2:
911            SGData['SGSpin'][(isym+1)%3+3] == 1
912
913def MagSGSym(SGData):       #needs to use SGPtGrp not SGLaue!
914    SGLaue = SGData['SGLaue']
915    if '1' not in SGData['GenSym']:        #patch for old gpx files
916        SGData['GenSym'] = ['1',]+SGData['GenSym']
917        SGData['SGSpin'] = [1,]+list(SGData['SGSpin'])
918    if len(SGData['SGSpin'])<len(SGData['GenSym']):
919        SGData['SGSpin'] = [1,]+list(SGData['SGSpin'])      #end patch
920    GenSym = SGData['GenSym'][1:]       #skip identity
921    SpnFlp = SGData['SGSpin']
922#    print('SpnFlp',SpnFlp)
923    SGPtGrp = SGData['SGPtGrp']
924    if len(SpnFlp) == 1:
925        SGData['MagPtGp'] = SGPtGrp
926        return SGData['SpGrp']
927    magSym = SGData['SpGrp'].split()
928    if SGLaue in ['-1',]:
929        SGData['MagPtGp'] = SGPtGrp
930        if SpnFlp[1] == -1:
931            magSym[1] += "'"
932            SGData['MagPtGp'] += "'"
933    elif SGLaue in ['2/m','4/m','6/m']: #all ok
934        Uniq = {'a':1,'b':2,'c':3,'':1}
935        Id = [0,1]
936        if len(magSym) > 2:
937            Id = [0,Uniq[SGData['SGUniq']]]
938        sym = magSym[Id[1]].split('/')
939        Ptsym = SGLaue.split('/')
940        if len(GenSym) == 3:
941            for i in [0,1,2]:
942                if SpnFlp[i+1] < 0:
943                    sym[i] += "'"
944                    Ptsym[i] += "'"
945        else:
946            for i in range(len(GenSym)):
947                if SpnFlp[i+1] < 0:                     
948                    sym[i] += "'"
949                    Ptsym[i] += "'"
950        SGData['MagPtGp'] = '/'.join(Ptsym)
951        magSym[Id[1]] = '/'.join(sym)
952    elif SGPtGrp in ['mmm','mm2','m2m','2mm','222']:
953        SGData['MagPtGp'] = ''
954        for i in [0,1,2]:
955            SGData['MagPtGp'] += SGPtGrp[i]
956            if SpnFlp[i+1] < 0:
957                magSym[i+1] += "'"
958                SGData['MagPtGp'] += "'"
959    elif SGLaue == '6/mmm': #ok
960        magPtGp = list(SGPtGrp)
961        if len(GenSym) == 2:
962            for i in [0,1]:
963                if SpnFlp[i+1] < 0:
964                    magSym[i+2] += "'"
965                    magPtGp[i+1] += "'"
966            if SpnFlp[1]*SpnFlp[2] < 0:
967                magSym[1] += "'"
968                magPtGp[0] += "'"
969        else:
970            sym = magSym[1].split('/')
971            Ptsym = ['6','m']
972            magPtGp = ['','m','m']
973            for i in [0,1,2]:
974                if SpnFlp[i+1] < 0:
975                    if i:
976                        magSym[i+1] += "'"
977                        magPtGp[i] += "'"
978                    else:
979                        sym[1] += "'"
980                        Ptsym[0] += "'"
981            if SpnFlp[2]*SpnFlp[3] < 0:
982                sym[0] += "'"                   
983                Ptsym[0] += "'"                   
984            magSym[1] = '/'.join(sym)
985            magPtGp[0] = '/'.join(Ptsym)
986        SGData['MagPtGp'] = ''.join(magPtGp)
987    elif SGLaue == '4/mmm':
988        magPtGp = list(SGPtGrp)
989        if len(GenSym) == 2:
990            for i in [0,1]:
991                if SpnFlp[i+1] < 0:
992                    magSym[i+2] += "'"
993                    magPtGp[i+1] += "'"
994            if SpnFlp[1]*SpnFlp[2] < 0:
995                magSym[1] += "'"
996                magPtGp[0] += "'"
997        else:
998            if '/' in magSym[1]:    #P 4/m m m, etc.
999                sym = magSym[1].split('/')
1000                Ptsym = ['4','m']
1001                magPtGp = ['','m','m']
1002                for i in [0,1,2]:
1003                    if SpnFlp[i+1] < 0:
1004                        if i:
1005                            magSym[i+1] += "'"
1006                            magPtGp[i] += "'"
1007                        else:
1008                            sym[1] += "'"
1009                            Ptsym[1] += "'"
1010                if SpnFlp[2]*SpnFlp[3] < 0:
1011                    sym[0] += "'"                   
1012                    Ptsym[0] += "'"                   
1013                magSym[1] = '/'.join(sym)
1014                magPtGp[0] = '/'.join(Ptsym)
1015            else:
1016                for i in [0,1]:
1017                    if SpnFlp[i+1] < 0:
1018                        magSym[i+2] += "'"
1019                if SpnFlp[1]*SpnFlp[2] < 0:
1020                    magSym[1] += "'"
1021        SGData['MagPtGp'] = ''.join(magPtGp)
1022    elif SGLaue in ['3','3m1','31m']:   #ok
1023        Ptsym = list(SGPtGrp)
1024        if len(GenSym) == 1:    #all ok
1025            Id = 2
1026            if (len(magSym) == 4) and (magSym[2] == '1'):
1027                Id = 3
1028            if '3' in GenSym[0]:
1029                Id = 1
1030            magSym[Id].strip("'")
1031            if SpnFlp[1] < 0:
1032                magSym[Id] += "'"
1033                Ptsym[Id-1] += "'"
1034        elif len(GenSym) == 2:
1035            if 'R' in GenSym[1]:
1036                magSym[-1].strip("'")
1037                if SpnFlp[1] < 0:
1038                    magSym[-1] += "'"
1039                    Ptsym[-1] += "'"
1040            else:
1041                i,j = [1,2]
1042                if magSym[2] == '1':
1043                    i,j = [1,3]
1044                magSym[i].strip("'")
1045                Ptsym[i-1].strip("'")
1046                magSym[j].strip("'")
1047                Ptsym[j-1].strip("'")
1048                if SpnFlp[1:3] == [1,-1]:
1049                    magSym[i] += "'"
1050                    Ptsym[i-1] += "'"
1051                elif SpnFlp[1:3] == [-1,-1]:
1052                    magSym[j] += "'"
1053                    Ptsym[j-1] += "'"
1054                elif SpnFlp[1:3] == [-1,1]:
1055                    magSym[i] += "'"
1056                    Ptsym[i-1] += "'"
1057                    magSym[j] += "'"
1058                    Ptsym[j-1] += "'"
1059        elif len(GenSym):
1060            if 'c' not in magSym[2]:
1061                i,j = [1,2]
1062                magSym[i].strip("'")
1063                Ptsym[i-1].strip("'")
1064                magSym[j].strip("'")
1065                Ptsym[j-1].strip("'")
1066                if SpnFlp[1:3] == [1,-1]:
1067                    magSym[i] += "'"
1068                    Ptsym[i-1] += "'"
1069                elif SpnFlp[1:3] == [-1,-1]:
1070                    magSym[j] += "'"
1071                    Ptsym[j-1] += "'"
1072                elif SpnFlp[2] == [-1,1]:
1073                    magSym[i] += "'"
1074                    Ptsym[i-1] += "'"
1075                    magSym[j] += "'"
1076                    Ptsym[j-1] += "'"
1077        SGData['MagPtGp'] = ''.join(Ptsym)
1078    elif SGData['SGPtGrp'] == '23' and len(magSym):
1079        SGData['MagPtGp'] = '23'
1080    elif SGData['SGPtGrp'] == 'm3':
1081        SGData['MagPtGp'] = "m3"
1082        if SpnFlp[1] < 0:
1083            magSym[1] += "'"
1084            magSym[2] += "'"
1085            SGData['MagPtGp'] = "m'3'"
1086        if SpnFlp[1] < 0:
1087            if not 'm' in magSym[1]:    #only Ia3
1088                magSym[1].strip("'")
1089                SGData['MagPtGp'] = "m3'"
1090    elif SGData['SGPtGrp'] in ['432','-43m']:
1091        Ptsym = SGData['SGPtGrp'].split('3')
1092        if SpnFlp[1] < 0:
1093            magSym[1] += "'"
1094            Ptsym[0] += "'"
1095            magSym[3] += "'"
1096            Ptsym[1] += "'"
1097        SGData['MagPtGp'] = '3'.join(Ptsym)
1098    elif SGData['SGPtGrp'] == 'm3m':
1099        Ptsym = ['m','3','m']
1100        if SpnFlp[1:3] == [-1,1]:
1101            magSym[1] += "'"
1102            Ptsym[0] += "'"
1103            magSym[2] += "'"
1104            Ptsym[1] += "'"
1105        elif SpnFlp[1:3] == [1,-1]:
1106            magSym[3] += "'"
1107            Ptsym[2] += "'"
1108        elif SpnFlp[1:3] == [-1,-1]:
1109            magSym[1] += "'"
1110            Ptsym[0] += "'"
1111            magSym[2] += "'"
1112            Ptsym[1] += "'"
1113            magSym[3] += "'"
1114            Ptsym[2] += "'"
1115        SGData['MagPtGp'] = ''.join(Ptsym)
1116#    print SpnFlp
1117    magSym[0] = SGData.get('BNSlattsym',[SGData['SGLatt'],[0,0,0]])[0]
1118    return ' '.join(magSym)
1119
1120def fixMono(SpGrp):
1121    'fixes b-unique monoclinics in e.g. P 1 2/1c 1 --> P 21/c '
1122    Flds = SpGrp.split()
1123    if len(Flds) == 4:
1124        if Flds[2] != '1':
1125            return '%s %s'%(Flds[0],Flds[2])
1126        else:
1127            return None
1128    else:
1129        return SpGrp
1130
1131def Trans2Text(Trans):
1132    "from transformation matrix to text"
1133    cells = ['a','b','c']
1134    Text = ''
1135    for row in Trans:
1136        Fld = ''
1137        for i in [0,1,2]:
1138            if row[i]:
1139                if Fld and row[i] > 0.:
1140                    Fld += '+'
1141                Fld += '%3.1f'%(row[i])+cells[i]
1142        Text += Fld
1143        Text += ','
1144        Text = Text.replace('1.0','').replace('.0','').replace('0.5','1/2')
1145    return Text[:-1]
1146
1147def getlattSym(Trans):
1148    Fives = {'ababc':'abc','bcbca':'cba','acacb':'acb','cabab':'cab','abcab':'acb'}
1149    transText = Trans2Text(Trans)
1150    lattSym = ''
1151    for fld in transText.split(','):
1152        if 'a' in fld: lattSym += 'a'
1153        if 'b' in fld: lattSym += 'b'
1154        if 'c' in fld: lattSym += 'c'
1155    if len(lattSym) != 3:
1156        lattSym = 'abc'
1157#        lattSym = Fives[lattSym]
1158    return lattSym
1159
1160def Text2MT(mcifOpr,CIF=True):
1161    "From space group cif text returns matrix/translation"
1162    XYZ = {'x':[1,0,0],'+x':[1,0,0],'-x':[-1,0,0],'y':[0,1,0],'+y':[0,1,0],'-y':[0,-1,0],
1163           'z':[0,0,1],'+z':[0,0,1],'-z':[0,0,-1],'x-y':[1,-1,0],'-x+y':[-1,1,0],'y-x':[-1,1,0],
1164           '+x-y':[1,-1,0],'+y-x':[-1,1,0]}
1165    ops = mcifOpr.split(",")
1166    M = []
1167    T = []
1168    for op in ops[:3]:
1169        ip = len(op)
1170        if '/' in op:
1171            try:    #mcif format
1172                nP = op.count('+')
1173                opMT = op.split('+')
1174                T.append(eval(opMT[nP]))
1175                if nP == 2:
1176                    opMT[0] = '+'.join(opMT[0:2])
1177            except NameError:   #normal cif format
1178                ip = op.index('/')
1179                T.append(eval(op[:ip+2]))
1180                opMT = [op[ip+2:],'']
1181        else:
1182            opMT = [op,'']
1183            T.append(0.)
1184        M.append(XYZ[opMT[0].lower()])
1185    return np.array(M),np.array(T)
1186           
1187def MagText2MTS(mcifOpr,CIF=True):
1188    "From magnetic space group cif text returns matrix/translation + spin flip"
1189    XYZ = {'x':[1,0,0],'+x':[1,0,0],'-x':[-1,0,0],'y':[0,1,0],'+y':[0,1,0],'-y':[0,-1,0],
1190           'z':[0,0,1],'+z':[0,0,1],'-z':[0,0,-1],'x-y':[1,-1,0],'-x+y':[-1,1,0],'y-x':[-1,1,0],
1191           '+x-y':[1,-1,0],'+y-x':[-1,1,0]}
1192    ops = mcifOpr.split(",")
1193    M = []
1194    T = []
1195    for op in ops[:3]:
1196        ip = len(op)
1197        if '/' in op:
1198            try:    #mcif format
1199                nP = op.count('+')
1200                opMT = op.split('+')
1201                T.append(eval(opMT[nP]))
1202                if nP == 2:
1203                    opMT[0] = '+'.join(opMT[0:2])
1204            except NameError:   #normal cif format
1205                ip = op.index('/')
1206                T.append(eval(op[:ip+2]))
1207                opMT = [op[ip+2:],'']
1208        else:
1209            opMT = [op,'']
1210            T.append(0.)
1211        M.append(XYZ[opMT[0].lower()])
1212    spnflp = 1
1213    if '-1' in ops[3]:
1214        spnflp = -1
1215    return np.array(M),np.array(T),spnflp
1216           
1217def MagSSText2MTS(Opr,G2=False):
1218    "From magnetic super space group cif text returns matrix/translation + spin flip"
1219    XYZ = {'x1':[1,0,0,0],'-x1':[-1,0,0,0],
1220           'x2':[0,1,0,0],'-x2':[0,-1,0,0],
1221           'x3':[0,0,1,0],'-x3':[0,0,-1,0],
1222           'x4':[0,0,0,1],'-x4':[0,0,0,-1],
1223           'x1-x2':[1,-1,0,0],'-x1+x2':[-1,1,0,0],
1224           'x1-x4':[1,0,0,-1],'-x1+x4':[-1,0,0,1],
1225           'x2-x4':[0,1,0,-1],'-x2+x4':[0,-1,0,1],
1226           '-x1-x2+x4':[-1,-1,0,1],'x1+x2-x4':[1,1,0,-1]}
1227    if G2:
1228        XYZ = {'x':[1,0,0,0],'+x':[1,0,0,0],'-x':[-1,0,0,0],
1229               'y':[0,1,0,0],'+y':[0,1,0,0],'-y':[0,-1,0,0],
1230               'z':[0,0,1,0],'+z':[0,0,1,0],'-z':[0,0,-1,0],
1231               't':[0,0,0,1],'+t':[0,0,0,1],'-t':[0,0,0,-1],
1232               'x-y':[1,-1,0,0],'+x-y':[1,-1,0,0],'-x+y':[-1,1,0,0],
1233               'x-t':[1,0,0,-1],'+x-t':[1,0,0,-1],'-x+t':[-1,0,0,1],
1234               'y-t':[0,1,0,-1],'+y-t':[0,1,0,-1],'-y+t':[0,-1,0,1],
1235               'x+y-t':[1,1,0,-1],'+x+y-t':[1,1,0,-1],'-x-y+t':[-1,-1,0,1]}
1236       
1237    ops = Opr.split(",")
1238    M = []
1239    T = []
1240    for op in ops[:4]:
1241        ip = len(op)
1242        if '/' in op:
1243            ip = op.index('/')
1244            if G2:
1245                T.append(eval(op[:ip+2]))               
1246                M.append(XYZ[op[ip+2:]])
1247            else:
1248                T.append(eval(op[ip-2:]))
1249                M.append(XYZ[op[:ip-2]])
1250        else:
1251            T.append(0.)
1252            M.append(XYZ[op])
1253    spnflp = 1
1254    if len(ops) == 5:
1255        if '-1' in ops[4]:
1256            spnflp = -1
1257    return np.array(M),np.array(T),spnflp
1258
1259def GetSGSpin(SGData,MSgSym):
1260    'get spin generators from magnetic space group symbol'
1261    SpGrp = SGData['SpGrp']
1262    mSgSym = MSgSym+' '
1263    Flds = SpGrp.split()
1264    iB = 0
1265    Spn = [1,]          #for identity generator
1266    if len(Flds) == 2:  #-1,  2/m, 4/m & 6/m; 1 or 2 generators
1267        fld = Flds[1]
1268        iF = mSgSym[iB:].index(fld[0])+iB
1269        jF = mSgSym[iF:].index(fld[-1])+iF
1270        if '/' in mSgSym[iF:jF]:
1271            if "'" in mSgSym[iF:jF]:
1272                Spn.append(-1)
1273            else:
1274                Spn.append(1)
1275        if "'" == mSgSym[jF+1]:
1276            Spn.append(-1)
1277        else:
1278            Spn.append(1)
1279    elif len(Flds) == 3:    # 3m & m3; 1 or 2 generator
1280        if SGData['SGPtGrp'] == '-3m':
1281            if not mSgSym.count("'"):
1282                Spn += [1,1,]
1283            elif mSgSym.count("'") == 2:
1284                Spn += [-1,1,]
1285            elif "3'" in mSgSym:
1286                Spn += [1,-1,]
1287            else:
1288                Spn += [-1,-1,]
1289        else:
1290            if "'" in mSgSym:   #could be 1 or 2 '; doesn't matter.
1291                Spn.append(-1)
1292            else:
1293                Spn.append(1)
1294    else:                   #the rest; 3 generators. NB:  any ' before / in 1st field ignored
1295        for fld in Flds[1:]:
1296            iF = mSgSym[iB:].index(fld[0])+iB
1297            jF = mSgSym[iF:].index(fld[-1])+iF
1298            if "'" == mSgSym[jF+1]:
1299                Spn.append(-1)
1300                iB = jF+2
1301            else:
1302                Spn.append(1)
1303                iB = jF+1
1304    Spn.append(1)
1305    return Spn
1306           
1307def GenMagOps(SGData):
1308    FlpSpn = SGData['SGSpin']
1309    Nsym = len(SGData['SGOps'])
1310    Ncv = len(SGData['SGCen'])
1311    sgOp = [M for M,T in SGData['SGOps']]
1312    detM = [nl.det(M) for M in sgOp]
1313    oprName = [GetOprPtrName(str(irtx)) for irtx in PackRot(SGData['SGOps'])]
1314    if SGData['SGInv'] and not SGData['SGFixed']:
1315        Nsym *= 2
1316        detM += [nl.det(-M) for M in sgOp]
1317        sgOp += [-M for M,T in SGData['SGOps']]
1318        oprName += [GetOprPtrName(str(-irtx)) for irtx in PackRot(SGData['SGOps'])]
1319    Nsyms = 0
1320    sgOps = []
1321    OprNames = []
1322    detMs = []
1323    for incv in range(Ncv):
1324        Nsyms += Nsym
1325        sgOps += sgOp
1326        detMs += detM
1327        OprNames += oprName
1328    if SGData['SGFixed']:
1329        SpnFlp = SGData['SpnFlp']
1330    else:
1331        SpnFlp = np.ones(Nsym,dtype=np.int)
1332        GenFlg = SGData.get('GenFlg',[0])
1333        Ngen = len(SGData['SGGen'])
1334        Nfl = len(GenFlg)
1335        for ieqv in range(Nsym):
1336            for iunq in range(Nfl):
1337                if SGData['SGGen'][ieqv%Ngen] & GenFlg[iunq]:
1338                    SpnFlp[ieqv] *= FlpSpn[iunq]
1339        for incv in range(Ncv):
1340            if incv:
1341                try:
1342                    SpnFlp = np.concatenate((SpnFlp,SpnFlp[:Nsym]*FlpSpn[Nfl+incv-1]))
1343                except IndexError:
1344                    FlpSpn = [1,]+FlpSpn
1345                    SpnFlp = np.concatenate((SpnFlp,SpnFlp[:Nsym]*FlpSpn[Nfl+incv-1]))
1346        if SGData['SGGray']:
1347           SpnFlp = np.concatenate((SpnFlp,-SpnFlp))
1348           detMs =2*detMs                   
1349    MagMom = SpnFlp*np.array(detMs)      #duplicate for no. centerings
1350    SGData['MagMom'] = MagMom
1351    return OprNames,SpnFlp
1352   
1353def GetOpNum(Opr,SGData):
1354    Nops = len(SGData['SGOps'])
1355    opNum = abs(Opr)%100
1356    cent = abs(Opr)//100
1357    if Opr < 0 and not SGData['SGFixed']:
1358        opNum += Nops
1359    if SGData['SGInv'] and not SGData['SGFixed']:
1360        Nops *= 2
1361    opNum += cent*Nops
1362    return opNum
1363       
1364################################################################################
1365#### Superspace group codes
1366################################################################################
1367       
1368def SSpcGroup(SGData,SSymbol):
1369    """
1370    Determines supersymmetry information from superspace group name; currently only for (3+1) superlattices
1371
1372    :param SGData: space group data structure as defined in SpcGroup above (see :ref:`SGData<SGData_table>`).
1373    :param SSymbol: superspace group symbol extension (string) defining modulation direction & generator info.
1374    :returns: (SSGError,SSGData)
1375   
1376       * SGError = 0 for no errors; >0 for errors (see SGErrors below for details)
1377       * SSGData - is a dict (see :ref:`Superspace Group object<SSGData_table>`) with entries:
1378       
1379             * 'SSpGrp': full superspace group symbol, accidental spaces removed; for display only
1380             * 'SSGCen': 4D cell centering vectors [0,0,0,0] at least
1381             * 'SSGOps': 4D symmetry operations as [M,T] so that M*x+T = x'
1382
1383    """
1384           
1385    def fixMonoOrtho():
1386        mod = ''.join(modsym).replace('1/2','0').replace('1','0')
1387        if SGData['SGPtGrp'] in ['2','m']:  #OK
1388            if mod in ['a00','0b0','00g']:
1389                result = [i*-1 for i in SGData['SSGKl']]
1390            else:
1391                result = SGData['SSGKl'][:]
1392            if '/' in mod:
1393                return [i*-1 for i in result]
1394            else:
1395                return result
1396        elif SGData['SGPtGrp'] == '2/m':    #OK
1397            if mod in ['a00','0b0','00g']:
1398                result =  SGData['SSGKl'][:]
1399            else:
1400                result = [i*-1 for i in SGData['SSGKl']]
1401            if '/' in mod:
1402                return [i*-1 for i in result]
1403            else:
1404                return result
1405        else:   #orthorhombic
1406            if mod:
1407                return [-SSGKl[i] if mod[i] in ['a','b','g'] else SSGKl[i] for i in range(3)]
1408            else:
1409                return [SSGKl[i] for i in range(3)]
1410       
1411    def extendSSGOps(SSGOps):
1412        for OpA in SSGOps:
1413            OpAtxt = SSMT2text(OpA)
1414            if 't' not in OpAtxt:
1415                continue
1416            for OpB in SSGOps:
1417                OpBtxt = SSMT2text(OpB)
1418                if 't' not in OpBtxt:
1419                    continue
1420                OpC = list(SGProd(OpB,OpA))
1421                OpC[1] %= 1.
1422                OpCtxt = SSMT2text(OpC)
1423#                print OpAtxt.replace(' ','')+' * '+OpBtxt.replace(' ','')+' = '+OpCtxt.replace(' ','')
1424                for k,OpD in enumerate(SSGOps):
1425                    OpDtxt = SSMT2text(OpD)
1426                    OpDtxt2 = ''
1427                    if SGData['SGGray']:                       
1428                        OpDtxt2 = SSMT2text([OpD[0],OpD[1]+np.array([0.,0.,0.,.5])])
1429#                    print '    ('+OpCtxt.replace(' ','')+' = ? '+OpDtxt.replace(' ','')+')'
1430                    if OpCtxt == OpDtxt:
1431                        continue
1432                    elif OpCtxt == OpDtxt2:
1433                        continue
1434                    elif OpCtxt.split(',')[:3] == OpDtxt.split(',')[:3]:
1435                        if 't' not in OpDtxt:
1436                            SSGOps[k] = OpC
1437#                            print k,'   new:',OpCtxt.replace(' ','')
1438                            break
1439                        else:
1440                            OpCtxt = OpCtxt.replace(' ','')
1441                            OpDtxt = OpDtxt.replace(' ','')
1442                            Txt = OpCtxt+' conflicts with '+OpDtxt
1443#                            print (Txt)
1444                            return False,Txt
1445        return True,SSGOps
1446       
1447    def findMod(modSym):
1448        for a in ['a','b','g']:
1449            if a in modSym:
1450                return a
1451               
1452    def genSSGOps():
1453        SSGOps = SSGData['SSGOps'][:]
1454        iFrac = {}
1455        for i,frac in enumerate(SSGData['modSymb']):
1456            if frac in ['1/2','1/3','1/4','1/6','1']:
1457                iFrac[i] = frac+'.'
1458#        print SGData['SpGrp']+SSymbol
1459#        print 'SSGKl',SSGKl,'genQ',genQ,'iFrac',iFrac,'modSymb',SSGData['modSymb']
1460# set identity & 1,-1; triclinic
1461        SSGOps[0][0][3,3] = 1.
1462## expand if centrosymmetric
1463#        if SGData['SGInv']:
1464#            SSGOps += [[-1*M,V] for M,V in SSGOps[:]]
1465# monoclinic - all done & all checked
1466        if SGData['SGPtGrp'] in ['2','m']:  #OK
1467            SSGOps[1][0][3,3] = SSGKl[0]
1468            SSGOps[1][1][3] = genQ[0]
1469            for i in iFrac:
1470                SSGOps[1][0][3,i] = -SSGKl[0]
1471        elif SGData['SGPtGrp'] == '2/m':    #OK
1472            SSGOps[1][0][3,3] = SSGKl[1]
1473            if 's' in gensym:
1474                SSGOps[1][1][3] = 0.5
1475            for i in iFrac:
1476                SSGOps[1][0][3,i] = SSGKl[0]
1477           
1478# orthorhombic - all OK not fully checked
1479        elif SGData['SGPtGrp'] in ['222','mm2','m2m','2mm']:    #OK
1480            if SGData['SGPtGrp'] == '222':
1481                OrOps = {'g':{0:[1,3],1:[2,3]},'a':{1:[1,2],2:[1,3]},'b':{2:[3,2],0:[1,2]}} #OK
1482            elif SGData['SGPtGrp'] == 'mm2':
1483                OrOps = {'g':{0:[1,3],1:[2,3]},'a':{1:[2,1],2:[3,1]},'b':{0:[1,2],2:[3,2]}} #OK
1484            elif SGData['SGPtGrp'] == 'm2m':
1485                OrOps = {'b':{0:[1,2],2:[3,2]},'g':{0:[1,3],1:[2,3]},'a':{1:[2,1],2:[3,1]}} #OK
1486            elif SGData['SGPtGrp'] == '2mm':
1487                OrOps = {'a':{1:[2,1],2:[3,1]},'b':{0:[1,2],2:[3,2]},'g':{0:[1,3],1:[2,3]}} #OK
1488            a = findMod(SSGData['modSymb'])
1489            OrFrac = OrOps[a]
1490            for j in iFrac:
1491                for i in OrFrac[j]:
1492                    SSGOps[i][0][3,j] = -2.*eval(iFrac[j])*SSGKl[i-1]
1493            for i in [0,1,2]:
1494                SSGOps[i+1][0][3,3] = SSGKl[i]
1495                SSGOps[i+1][1][3] = genQ[i]
1496                E,SSGOps = extendSSGOps(SSGOps)
1497                if not E:
1498                    return E,SSGOps
1499        elif SGData['SGPtGrp'] == 'mmm':    #OK
1500            OrOps = {'g':{0:[1,3],1:[2,3]},'a':{1:[2,1],2:[3,1]},'b':{0:[1,2],2:[3,2]}} 
1501            a = findMod(SSGData['modSymb'])
1502            if a == 'g':
1503                SSkl = [1,1,1]
1504            elif a == 'a':
1505                SSkl = [-1,1,-1]
1506            else:
1507                SSkl = [1,-1,-1]
1508            OrFrac = OrOps[a]
1509            for j in iFrac:
1510                for i in OrFrac[j]:
1511                    SSGOps[i][0][3,j] = -2.*eval(iFrac[j])*SSkl[i-1]
1512            for i in [0,1,2]:
1513                SSGOps[i+1][0][3,3] = SSkl[i]
1514                SSGOps[i+1][1][3] = genQ[i]
1515                E,SSGOps = extendSSGOps(SSGOps)
1516                if not E:
1517                    return E,SSGOps               
1518# tetragonal - all done & checked
1519        elif SGData['SGPtGrp'] == '4':  #OK
1520            SSGOps[1][0][3,3] = SSGKl[0]
1521            SSGOps[1][1][3] = genQ[0]
1522            if '1/2' in SSGData['modSymb']:
1523                SSGOps[1][0][3,1] = -1
1524        elif SGData['SGPtGrp'] == '-4': #OK
1525            SSGOps[1][0][3,3] = SSGKl[0]
1526            if '1/2' in SSGData['modSymb']:
1527                SSGOps[1][0][3,1] = 1
1528        elif SGData['SGPtGrp'] in ['4/m',]: #OK
1529            if '1/2' in SSGData['modSymb']:
1530                SSGOps[1][0][3,1] = -SSGKl[0]
1531            for i,j in enumerate([1,3]):
1532                SSGOps[j][0][3,3] = 1
1533                if genQ[i]:
1534                    SSGOps[j][1][3] = genQ[i]
1535                E,SSGOps = extendSSGOps(SSGOps)
1536                if not E:
1537                    return E,SSGOps
1538        elif SGData['SGPtGrp'] in ['422','4mm','-42m','-4m2',]: #OK
1539            iGens = [1,4,5]
1540            if SGData['SGPtGrp'] in ['4mm','-4m2',]:
1541                iGens = [1,6,7]
1542            for i,j in enumerate(iGens):
1543                if '1/2' in SSGData['modSymb'] and i < 2:
1544                    SSGOps[j][0][3,1] = SSGKl[i]
1545                SSGOps[j][0][3,3] = SSGKl[i]
1546                if genQ[i]:
1547                    if 's' in gensym and j == 6:
1548                        SSGOps[j][1][3] = -genQ[i]
1549                    else:
1550                        SSGOps[j][1][3] = genQ[i]
1551                E,SSGOps = extendSSGOps(SSGOps)
1552                if not E:
1553                    return E,SSGOps
1554        elif SGData['SGPtGrp'] in ['4/mmm',]:#OK
1555            if '1/2' in SSGData['modSymb']:
1556                SSGOps[1][0][3,1] = -SSGKl[0]
1557                SSGOps[6][0][3,1] = SSGKl[1]
1558                if modsym:
1559                   SSGOps[1][1][3]  = -genQ[3]
1560            for i,j in enumerate([1,2,6,7]):
1561                SSGOps[j][0][3,3] = 1
1562                SSGOps[j][1][3] = genQ[i]
1563                E,Result = extendSSGOps(SSGOps)
1564                if not E:
1565                    return E,Result
1566                else:
1567                    SSGOps = Result
1568               
1569# trigonal - all done & checked
1570        elif SGData['SGPtGrp'] == '3':  #OK
1571            SSGOps[1][0][3,3] = SSGKl[0]
1572            if '1/3' in SSGData['modSymb']:
1573                SSGOps[1][0][3,1] = -1
1574            SSGOps[1][1][3] = genQ[0]
1575        elif SGData['SGPtGrp'] == '-3': #OK
1576            SSGOps[1][0][3,3] = -SSGKl[0]
1577            if '1/3' in SSGData['modSymb']:
1578                SSGOps[1][0][3,1] = -1
1579            SSGOps[1][1][3] = genQ[0]
1580        elif SGData['SGPtGrp'] in ['312','3m','-3m','-3m1','3m1']:   #OK
1581            if '1/3' in SSGData['modSymb']:
1582                SSGOps[1][0][3,1] = -1
1583            for i,j in enumerate([1,5]):
1584                if SGData['SGPtGrp'] in ['3m','-3m']:
1585                    SSGOps[j][0][3,3] = 1
1586                else:                   
1587                    SSGOps[j][0][3,3] = SSGKl[i+1]
1588                if genQ[i]:
1589                    SSGOps[j][1][3] = genQ[i]
1590        elif SGData['SGPtGrp'] in ['321','32']:   #OK
1591            for i,j in enumerate([1,4]):
1592                SSGOps[j][0][3,3] = SSGKl[i]
1593                if genQ[i]:
1594                    SSGOps[j][1][3] = genQ[i]
1595        elif SGData['SGPtGrp'] in ['31m','-31m']:   #OK
1596            ids = [1,3]
1597            if SGData['SGPtGrp'] == '-31m':
1598                ids = [1,3]
1599            if '1/3' in SSGData['modSymb']:
1600                SSGOps[ids[0]][0][3,1] = -SSGKl[0]
1601            for i,j in enumerate(ids):
1602                SSGOps[j][0][3,3] = 1
1603                if genQ[i+1]:
1604                    SSGOps[j][1][3] = genQ[i+1]
1605                     
1606# hexagonal all done & checked
1607        elif SGData['SGPtGrp'] == '6':  #OK
1608            SSGOps[1][0][3,3] = SSGKl[0]
1609            SSGOps[1][1][3] = genQ[0]
1610        elif SGData['SGPtGrp'] == '-6': #OK
1611            SSGOps[1][0][3,3] = SSGKl[0]
1612        elif SGData['SGPtGrp'] in ['6/m',]: #OK
1613            SSGOps[1][0][3,3] = -SSGKl[1]
1614            SSGOps[1][1][3] = genQ[0]
1615            SSGOps[2][1][3] = genQ[1]
1616        elif SGData['SGPtGrp'] in ['622',]: #OK
1617            for i,j in enumerate([1,9,8]):
1618                SSGOps[j][0][3,3] = SSGKl[i]
1619                if genQ[i]:
1620                    SSGOps[j][1][3] = -genQ[i]
1621                E,SSGOps = extendSSGOps(SSGOps)
1622           
1623        elif SGData['SGPtGrp'] in ['6mm','-62m','-6m2',]: #OK
1624            for i,j in enumerate([1,6,7]):
1625                SSGOps[j][0][3,3] = SSGKl[i]
1626                if genQ[i]:
1627                    SSGOps[j][1][3] = genQ[i]
1628                E,SSGOps = extendSSGOps(SSGOps)
1629        elif SGData['SGPtGrp'] in ['6/mmm',]: # OK
1630            for i,j in enumerate([1,2,10,11]):
1631                SSGOps[j][0][3,3] = 1
1632                if genQ[i]:
1633                    SSGOps[j][1][3] = genQ[i]
1634                E,SSGOps = extendSSGOps(SSGOps)
1635        elif SGData['SGPtGrp'] in ['1','-1']: #triclinic - done
1636            return True,SSGOps
1637        E,SSGOps = extendSSGOps(SSGOps)
1638        return E,SSGOps
1639       
1640    def specialGen(gensym,modsym):
1641        sym = ''.join(gensym)
1642        if SGData['SGPtGrp'] in ['2/m',] and 'n' in SGData['SpGrp']:
1643            if 's' in sym:
1644                gensym = 'ss'
1645        if SGData['SGPtGrp'] in ['-62m',] and sym == '00s':
1646            gensym = '0ss'
1647        elif SGData['SGPtGrp'] in ['222',]:
1648            if sym == '00s':
1649                gensym = '0ss'
1650            elif sym == '0s0':
1651                gensym = 'ss0'
1652            elif sym == 's00':
1653                gensym = 's0s'
1654        elif SGData['SGPtGrp'] in ['mmm',]:
1655            if 'g' in modsym:
1656                if sym == 's00':
1657                    gensym = 's0s'
1658                elif sym == '0s0':
1659                    gensym = '0ss'
1660            elif 'a' in modsym:
1661                if sym == '0s0':
1662                    gensym = 'ss0'
1663                elif sym == '00s':
1664                    gensym = 's0s'
1665            elif 'b' in modsym:
1666                if sym == '00s':
1667                    gensym = '0ss'
1668                elif sym == 's00':
1669                    gensym = 'ss0'
1670        return gensym
1671                           
1672    Fracs = {'1/2':0.5,'1/3':1./3,'1':1.0,'0':0.,'s':.5,'t':1./3,'q':.25,'h':-1./6,'a':0.,'b':0.,'g':0.}
1673    if SGData['SGLaue'] in ['m3','m3m']:
1674        return '(3+1) superlattices not defined for cubic space groups',None
1675    elif SGData['SGLaue'] in ['3R','3mR']:
1676        return '(3+1) superlattices not defined for rhombohedral settings - use hexagonal setting',None
1677    try:
1678        modsym,gensym = splitSSsym(SSymbol)
1679    except ValueError:
1680        return 'Error in superspace symbol '+SSymbol,None
1681    modQ = [Fracs[mod] for mod in modsym]
1682    SSGKl = SGData['SSGKl'][:]
1683    if SGData['SGLaue'] in ['2/m','mmm']:
1684        SSGKl = fixMonoOrtho()
1685    Ngen = len(gensym)
1686    if SGData.get('SGGray',False):
1687        Ngen -= 1
1688    if len(gensym) and Ngen != len(SSGKl):
1689        return 'Wrong number of items in generator symbol '+''.join(gensym),None
1690    gensym = specialGen(gensym[:Ngen],modsym)
1691    genQ = [Fracs[mod] for mod in gensym[:Ngen]]
1692    if not genQ:
1693        genQ = [0,0,0,0]
1694    SSgSpc = SGData['SpGrp']+SSymbol
1695    if SGData['SGGray']:
1696        SSgSpc = SSgSpc.replace('('," 1'(")
1697    SSGData = {'SSpGrp':SSgSpc,'modQ':modQ,'modSymb':modsym,'SSGKl':SSGKl}
1698    SSCen = np.zeros((len(SGData['SGCen']),4))
1699    for icen,cen in enumerate(SGData['SGCen']):
1700        SSCen[icen,0:3] = cen
1701    if 'BNSlattsym' in SGData and '_' in SGData['BNSlattsym'][0]:
1702        Ncen = len(SGData['SGCen'])
1703        for icen in range(Ncen//2,Ncen):
1704            SSCen[icen,3] = 0.5
1705    SSGData['SSGCen'] = SSCen%1.
1706    SSGData['SSGOps'] = []
1707    for iop,op in enumerate(SGData['SGOps']):
1708        T = np.zeros(4)
1709        ssop = np.zeros((4,4))
1710        ssop[:3,:3] = op[0]
1711        T[:3] = op[1]
1712        SSGData['SSGOps'].append([ssop,T])
1713    E,Result = genSSGOps()
1714    if E:
1715        SSGData['SSGOps'] = Result
1716        if DEBUG:
1717            print ('Super spacegroup operators for '+SSGData['SSpGrp'])
1718            for Op in Result:
1719                print (SSMT2text(Op).replace(' ',''))
1720            if SGData['SGInv']:                                 
1721                for Op in Result:
1722                    Op = [-Op[0],-Op[1]%1.]
1723                    print (SSMT2text(Op).replace(' ',''))                                 
1724        return None,SSGData
1725    else:
1726        return Result+'\nOperator conflict - incorrect superspace symbol',None
1727   
1728def SSChoice(SGData):
1729    '''
1730    Gets the unique set of possible super space groups for a given space group
1731    '''
1732    ptgpSS = {'1':['(abg)',],'-1':['(abg)',],
1733                   
1734        '2':['(a0g)','(a1/2g)','(0b0)','(1/2b0)','(0b1/2)','(1/2b1/2)'],
1735        'm':['(a0g)','(a1/2g)','(0b0)','(1/2b0)','(0b1/2)','(1/2b1/2)'],
1736        '2/m':['(a0g)','(a1/2g)','(0b0)','(1/2b0)','(0b1/2)','(1/2b1/2)'],
1737       
1738        '222':['(00g)','(1/20g)','(01/2g)','(1/21/2g)','(10g)','(01g)',
1739               '(a00)','(a1/20)','(a01/2)','(a1/21/2)','(a10)','(a01)',
1740               '(0b0)','(1/2b0)','(0b1/2)','(1/2b1/2)','(1b0)','(0b1)',],
1741        'mm2':['(00g)','(1/20g)','(01/2g)','(1/21/2g)','(10g)','(01g)',
1742               '(a00)','(a1/20)','(a01/2)','(a1/21/2)','(a10)','(a01)',
1743               '(0b0)','(1/2b0)','(0b1/2)','(1/2b1/2)','(1b0)','(0b1)',],
1744        'm2m':['(00g)','(1/20g)','(01/2g)','(1/21/2g)','(10g)','(01g)',
1745               '(a00)','(a1/20)','(a01/2)','(a1/21/2)','(a10)','(a01)',
1746               '(0b0)','(1/2b0)','(0b1/2)','(1/2b1/2)','(1b0)','(0b1)',],
1747        '2mm':['(00g)','(1/20g)','(01/2g)','(1/21/2g)','(10g)','(01g)',
1748               '(a00)','(a1/20)','(a01/2)','(a1/21/2)','(a10)','(a01)',
1749               '(0b0)','(1/2b0)','(0b1/2)','(1/2b1/2)','(1b0)','(0b1)',],
1750        'mmm':['(00g)','(1/20g)','(01/2g)','(1/21/2g)','(10g)','(01g)',
1751               '(a00)','(a1/20)','(a01/2)','(a1/21/2)','(a10)','(a01)',
1752               '(0b0)','(1/2b0)','(0b1/2)','(1/2b1/2)','(1b0)','(0b1)',],
1753               
1754        '4':['(00g)','(1/21/2g)'],'4mm':['(00g)','(1/21/2g)'],
1755        '4/m':['(00g)','(1/21/2g)'],
1756        '422':['(00g)','(1/21/2g)'],'-4m2':['(00g)','(1/21/2g)'],'-42m':['(00g)','(1/21/2g)'],
1757        '4/mmm':['(00g)','(1/21/2g)'],
1758       
1759        '3':['(00g)','(1/31/3g)'],'-3':['(00g)','(1/31/3g)'],
1760        '32':['(00g)'],'3m':['(00g)'],'-3m':['(00g)'],
1761        '321':['(00g)'],'3m1':['(00g)'],'-3m1':['(00g)'],
1762        '312':['(00g)','(1/31/3g)'],'31m':['(00g)','(1/31/3g)'],'-31m':['(00g)','(1/31/3g)'],
1763       
1764        '6':['(00g)',],'6/m':['(00g)',],'-62m':['(00g)',],'-6m2':['(00g)',],
1765        '622':['(00g)',],'6/mmm':['(00g)',],'6mm':['(00g)',],
1766       
1767        '23':['',],'m3':['',],'432':['',],'-43m':['',],'m3m':['',]}
1768           
1769    ptgpTS = {'1':['0',],'-1':['0',],
1770             
1771        '2':['0','s'],'m':['0','s'],
1772        '2/m':['00','0s','ss','s0'],
1773       
1774        '222':['000','s00','0s0','00s',],
1775        'mm2':['000','s00','0s0','00s','ss0','s0s','0ss','q00','0q0','00q','0qq','q0q','qq0'],
1776        'm2m':['000','s00','0s0','00s','ss0','s0s','0ss','q00','0q0','00q','0qq','q0q','qq0'],
1777        '2mm':['000','s00','0s0','00s','ss0','s0s','0ss','q00','0q0','00q','0qq','q0q','qq0'],
1778        'mmm':['000','s00','0s0','00s','ss0','s0s','0ss','q00','0q0','00q','0qq','q0q','qq0'],
1779       
1780        '4':['0','q','s'],'4mm':['000','q00','s00','s0s','ss0','0ss','qq0','qqs'],
1781        '4/m':['00','s0'],'-4m2':['000','0s0','0q0'],'-42m':['000','00s'],
1782        '422':['000','q00','s00','s0s','ss0','0ss','qq0','qqs','0q0'],
1783        '4/mmm':['0000','s0s0','00ss','s00s','ss00','0ss0','0s0s'],
1784       
1785        '3':['0','t'],'-3':['0','t'],
1786        '32':['00','t0'],'3m':['00','0s'],'-3m':['00','0s'],
1787        '321':['000','t00'],'3m1':['000','0s0'],'-3m1':['000','0s0'],
1788        '312':['000','t00'],'31m':['000','00s'],'-31m':['000','00s'],
1789       
1790        '6':['0','h','t','s'],
1791        '6/m':['00','s0'],'-62m':['000','00s'],'-6m2':['000','0s0'],
1792        '622':['000','h00','t00','s00',],'6mm':['000','ss0','s0s','0ss',],
1793        '6/mmm':['0000','s0s0','00ss','s00s','ss00','0ss0','0s0s'],
1794       
1795        '23':['',],'m3':['',],'432':['',],'-43m':['',],'m3m':['',]}
1796   
1797    ptgp = SGData['SGPtGrp']
1798    SSChoice = []
1799    for ax in ptgpSS[ptgp]:
1800        for sx in ptgpTS[ptgp]:
1801            SSChoice.append(ax+sx)
1802            if SGData['SGGray']: SSChoice[-1] += 's'
1803    ssChoice = []
1804    ssHash = []
1805    for item in SSChoice:
1806        E,SSG = SSpcGroup(SGData,item)
1807        if SSG:
1808            sshash = hash(str(SSGPrint(SGData,SSG)[1]))
1809            if sshash not in ssHash:
1810                ssHash.append(sshash)
1811                ssChoice.append(item)
1812    return ssChoice
1813           
1814def splitSSsym(SSymbol):
1815    '''
1816    Splits supersymmetry symbol into two lists of strings
1817    '''
1818    mssym = SSymbol.replace(' ','').split(')')
1819    if len(mssym) > 1:
1820        modsym,gensym = mssym
1821    else:
1822        modsym = mssym[0]
1823        gensym = ''
1824    modsym = modsym.replace(',','')
1825    if "1'" in modsym:
1826        gensym = gensym[:-1]
1827    modsym = modsym.replace("1'",'')
1828    if gensym in ['0','00','000','0000']:       #get rid of extraneous symbols
1829        gensym = ''
1830    nfrac = modsym.count('/')
1831    modsym = modsym.lstrip('(')
1832    if nfrac == 0:
1833        modsym = list(modsym)
1834    elif nfrac == 1:
1835        pos = modsym.find('/')
1836        if pos == 1:
1837            modsym = [modsym[:3],modsym[3],modsym[4]]
1838        elif pos == 2:
1839            modsym = [modsym[0],modsym[1:4],modsym[4]]
1840        else:
1841            modsym = [modsym[0],modsym[1],modsym[2:]]
1842    else:
1843        lpos = modsym.find('/')
1844        rpos = modsym.rfind('/')
1845        if lpos == 1 and rpos == 4:
1846            modsym = [modsym[:3],modsym[3:6],modsym[6]]
1847        elif lpos == 1 and rpos == 5:
1848            modsym = [modsym[:3],modsym[3],modsym[4:]]
1849        else:
1850            modsym = [modsym[0],modsym[1:4],modsym[4:]]
1851    gensym = list(gensym)
1852    return modsym,gensym
1853       
1854def SSGPrint(SGData,SSGData,AddInv=False):
1855    '''
1856    Print the output of SSpcGroup in a nicely formatted way. Used in SSpaceGroup
1857
1858    :param SGData: space group data structure as defined in SpcGroup above.
1859    :param SSGData: from :func:`SSpcGroup`
1860    :returns:
1861        SSGText - list of strings with the superspace group details
1862        SGTable - list of strings for each of the operations
1863    '''
1864    nCen = len(SSGData['SSGCen'])
1865    Mult = nCen*len(SSGData['SSGOps'])*(int(SGData['SGInv'])+1)
1866    if SGData.get('SGFixed',False):
1867        Mult = len(SSGData['SSGCen'])*len(SSGData['SSGOps'])
1868    SSsymb = SSGData['SSpGrp']
1869    if 'BNSlattsym' in SGData and '_' in SGData['BNSlattsym'][0]:
1870        SSsymb = SGData['BNSlattsym'][0]+SSsymb[1:]
1871    SSGCen = list(SSGData['SSGCen'])
1872    if SGData.get('SGGray',False):
1873        if SGData.get('SGFixed',False): 
1874            Mult //= 2
1875        else:
1876            SSGCen += list(SSGData['SSGCen']+[0,0,0,0.5])
1877            SSGCen =  np.array(SSGCen)%1.
1878    else:
1879        if "1'" in SSsymb:  #leftover in nonmag phase in mcif file
1880            nCen //= 2
1881            Mult //= 2
1882            SSsymb = SSsymb.replace("1'",'')[:-1]
1883    SSGText = []
1884    SSGText.append(' Superspace Group: '+SSsymb)
1885    CentStr = 'centrosymmetric'
1886    if not SGData['SGInv']:
1887        CentStr = 'non'+CentStr
1888    if SGData['SGLatt'] in 'ABCIFR':
1889        SSGText.append(' The lattice is '+CentStr+' '+SGData['SGLatt']+'-centered '+SGData['SGSys'].lower())
1890    else:
1891        SSGText.append(' The superlattice is '+CentStr+' '+'primitive '+SGData['SGSys'].lower())
1892    SSGText.append(' The Laue symmetry is '+SGData['SGLaue'])
1893    SGptGp = SGData['SGPtGrp']
1894    if SGData['SGGray']:
1895        SGptGp += "1'"
1896    SSGText.append(' The superlattice point group is '+SGptGp+', '+''.join([str(i) for i in SSGData['SSGKl']]))
1897    SSGText.append(' The number of superspace group generators is '+str(len(SGData['SSGKl'])))
1898    SSGText.append(' Multiplicity of a general site is '+str(Mult))
1899    if SGData['SGUniq'] in ['a','b','c']:
1900        SSGText.append(' The unique monoclinic axis is '+SGData['SGUniq'])
1901    if SGData['SGInv']:
1902        SSGText.append(' The inversion center is located at 0,0,0')
1903    if SGData['SGPolax']:
1904        SSGText.append(' The location of the origin is arbitrary in '+SGData['SGPolax'])
1905    SSGText.append(' ')
1906    if len(SSGCen) > 1:
1907        SSGText.append(' The equivalent positions are:')
1908        SSGText.append(' ('+SSLatt2text(SSGCen)+')+\n')
1909    else:
1910        SSGText.append(' The equivalent positions are:\n')
1911    SSGTable = []
1912    for i,Opr in enumerate(SSGData['SSGOps']):
1913        SSGTable.append('(%2d) %s'%(i+1,SSMT2text(Opr)))
1914    if AddInv and SGData['SGInv']:
1915        for i,Opr in enumerate(SSGData['SSGOps']):
1916            IOpr = [-Opr[0],-Opr[1]]
1917            SSGTable.append('(%2d) %s'%(i+1+len(SSGData['SSGOps']),SSMT2text(IOpr)))       
1918    return SSGText,SSGTable
1919   
1920def SSGModCheck(Vec,modSymb,newMod=True):
1921    ''' Checks modulation vector compatibility with supersymmetry space group symbol.
1922    if newMod: Superspace group symbol takes precidence & the vector will be modified accordingly
1923    '''
1924    Fracs = {'1/2':0.5,'1/3':1./3,'1':1.0,'0':0.,'a':0.,'b':0.,'g':0.}
1925    modQ = [Fracs[mod] for mod in modSymb]
1926    if newMod:
1927        newVec = Vec
1928        if not np.any(Vec):
1929            newVec = [0.1 if (vec == 0.0 and mod in ['a','b','g']) else vec for [vec,mod] in zip(Vec,modSymb)]
1930        return [Q if mod not in ['a','b','g'] and vec != Q else vec for [vec,mod,Q] in zip(newVec,modSymb,modQ)],  \
1931            [True if mod in ['a','b','g'] else False for mod in modSymb]
1932    else:
1933        return Vec,[True if mod in ['a','b','g'] else False for mod in modSymb]
1934
1935def SSMT2text(Opr):
1936    "From superspace group matrix/translation operator returns text version"
1937    XYZS = ('x','y','z','t')    #Stokes, Campbell & van Smaalen notation
1938    TRA = ('   ','ERR','1/6','1/4','1/3','ERR','1/2','ERR','2/3','3/4','5/6','ERR')
1939    Fld = ''
1940    M,T = Opr
1941    for j in range(4):
1942        IJ = ''
1943        for k in range(4):
1944            txt = str(int(round(M[j][k])))
1945            txt = txt.replace('1',XYZS[k]).replace('0','')
1946            if '2' in txt:
1947                txt += XYZS[k]
1948            if IJ and M[j][k] > 0:
1949                IJ += '+'+txt
1950            else:
1951                IJ += txt
1952        IK = int(round(T[j]*12))%12
1953        if IK:
1954            if not IJ:
1955                break
1956            if IJ[0] == '-':
1957                Fld += (TRA[IK]+IJ).rjust(8)
1958            else:
1959                Fld += (TRA[IK]+'+'+IJ).rjust(8)
1960        else:
1961            Fld += IJ.rjust(8)
1962        if j != 3: Fld += ', '
1963    return Fld
1964   
1965def SSLatt2text(SSGCen):
1966    "Lattice centering vectors to text"
1967    lattTxt = ''
1968    lattDir = {4:'1/3',6:'1/2',8:'2/3',0:'0'}
1969    for vec in SSGCen:
1970        lattTxt += ' '
1971        for item in vec:
1972            lattTxt += '%s,'%(lattDir[int(item*12)])
1973        lattTxt = lattTxt.rstrip(',')
1974        lattTxt += ';'
1975    lattTxt = lattTxt.rstrip(';').lstrip(' ')
1976    return lattTxt
1977       
1978def SSpaceGroup(SGSymbol,SSymbol):
1979    '''
1980    Print the output of SSpcGroup in a nicely formatted way.
1981
1982    :param SGSymbol: space group symbol with spaces between axial fields.
1983    :param SSymbol: superspace group symbol extension (string).
1984    :returns: nothing
1985    '''
1986
1987    E,A = SpcGroup(SGSymbol)
1988    if E > 0:
1989        print (SGErrors(E))
1990        return
1991    E,B = SSpcGroup(A,SSymbol)   
1992    if E > 0:
1993        print (E)
1994        return
1995    for l in SSGPrint(B):
1996        print (l)
1997       
1998def SGProd(OpA,OpB):
1999    '''
2000    Form space group operator product. OpA & OpB are [M,V] pairs;
2001        both must be of same dimension (3 or 4). Returns [M,V] pair
2002    '''
2003    A,U = OpA
2004    B,V = OpB
2005    M = np.inner(B,A.T)
2006    W = np.inner(B,U)+V
2007    return M,W
2008       
2009def GetLittleGrpOps(SGData,vec):
2010    ''' Find rotation part of operators that leave vec unchanged
2011   
2012    :param SGData: space group data structure as defined in SpcGroup above.
2013    :param vec: a numpy array of fractional vector coordinates
2014    :returns: Little - list of operators [M,T] that form the little gropu
2015    '''
2016    Little = []
2017    Ops = SGData['SGOps'][:]
2018    if SGData['SGInv']:
2019        Ops += [[-M,-T] for [M,T] in Ops]
2020    for [M,T] in Ops:
2021        tvec = np.inner(M,vec)%1.
2022        if np.allclose(tvec,vec%1.):
2023            Little.append([M,T])
2024    return Little
2025       
2026def MoveToUnitCell(xyz):
2027    '''
2028    Translates a set of coordinates so that all values are >=0 and < 1
2029
2030    :param xyz: a list or numpy array of fractional coordinates
2031    :returns: XYZ - numpy array of new coordinates now 0 or greater and less than 1
2032    '''
2033    XYZ = np.array(xyz)%1.
2034    cell = np.asarray(np.rint(XYZ-xyz),dtype=np.int32)
2035    return XYZ,cell
2036       
2037def Opposite(XYZ,toler=0.0002):
2038    '''
2039    Gives opposite corner, edge or face of unit cell for position within tolerance.
2040        Result may be just outside the cell within tolerance
2041
2042    :param XYZ: 0 >= np.array[x,y,z] > 1 as by MoveToUnitCell
2043    :param toler: unit cell fraction tolerance making opposite
2044    :returns:
2045        XYZ: dict of opposite positions; key=unit cell & always contains XYZ
2046    '''
2047    perm3 = [[1,1,1],[0,1,1],[1,0,1],[1,1,0],[1,0,0],[0,1,0],[0,0,1],[0,0,0]]
2048    TB = np.where(abs(XYZ-1)<toler,-1,0)+np.where(abs(XYZ)<toler,1,0)
2049    perm = TB*perm3
2050    cperm = ['%d,%d,%d'%(i,j,k) for i,j,k in perm]
2051    D = dict(zip(cperm,perm))
2052    new = {}
2053    for key in D:
2054        new[key] = np.array(D[key])+np.array(XYZ)
2055    return new
2056       
2057def GenAtom(XYZ,SGData,All=False,Uij=[],Move=True):
2058    '''
2059    Generates the equivalent positions for a specified coordinate and space group
2060
2061    :param XYZ: an array, tuple or list containing 3 elements: x, y & z
2062    :param SGData: from :func:`SpcGroup`
2063    :param All: True return all equivalent positions including duplicates;
2064      False return only unique positions
2065    :param Uij: [U11,U22,U33,U12,U13,U23] or [] if no Uij
2066    :param Move: True move generated atom positions to be inside cell
2067      False do not move atoms       
2068    :return: [[XYZEquiv],Idup,[UijEquiv],spnflp]
2069
2070      *  [XYZEquiv] is list of equivalent positions (XYZ is first entry)
2071      *  Idup = [-][C]SS where SS is the symmetry operator number (1-24), C (if not 0,0,0)
2072      * is centering operator number (1-4) and - is for inversion
2073        Cell = unit cell translations needed to put new positions inside cell
2074        [UijEquiv] - equivalent Uij; absent if no Uij given
2075      * +1/-1 for spin inversion of operator - empty if not magnetic
2076       
2077    '''
2078    XYZEquiv = []
2079    UijEquiv = []
2080    Idup = []
2081    Cell = []
2082    inv = int(SGData['SGInv']+1)
2083    icen = SGData['SGCen']
2084    if SGData.get('SGFixed',False):
2085        inv = 1
2086    SpnFlp = SGData.get('SpnFlp',[])
2087    spnflp = []
2088    X = np.array(XYZ)
2089    mj = 0
2090    for ic,cen in enumerate(icen):
2091        C = np.array(cen)
2092        for invers in range(inv):
2093            for io,[M,T] in enumerate(SGData['SGOps']):
2094                idup = ((io+1)+100*ic)*(1-2*invers)
2095                XT = np.inner(M,X)+T
2096                if len(Uij):
2097                    U = Uij2U(Uij)
2098                    U = np.inner(M,np.inner(U,M).T)
2099                    newUij = U2Uij(U)
2100                if invers:
2101                    XT = -XT
2102                XT += C
2103                cell = np.zeros(3,dtype=np.int32)
2104                if Move:
2105                    newX,cell = MoveToUnitCell(XT)
2106                else:
2107                    newX = XT
2108                if All:
2109                    if np.allclose(newX,X,atol=0.0002):     #do we want %1. here?
2110                        idup = False
2111                else:
2112                    if True in [np.allclose(newX%1.,oldX%1.,atol=0.0002) for oldX in XYZEquiv]:
2113                        idup = False
2114                if All or idup:
2115                    XYZEquiv.append(newX)
2116                    Idup.append(idup)
2117                    Cell.append(cell)
2118                    if len(Uij):
2119                        UijEquiv.append(newUij)
2120                    if len(SpnFlp):
2121                        spnflp.append(SpnFlp[mj])
2122                    else:
2123                        spnflp.append(1)
2124                mj += 1
2125    if len(Uij):
2126        return zip(XYZEquiv,UijEquiv,Idup,Cell,spnflp)
2127    else:
2128        return zip(XYZEquiv,Idup,Cell,spnflp)
2129       
2130def GenHKL(HKL,SGData):
2131    ''' Generates all equivlent reflections including Friedel pairs
2132    :param HKL:  [h,k,l] must be integral values
2133    :param SGData: space group data obtained from SpcGroup
2134    :returns: array Uniq: equivalent reflections
2135    '''
2136   
2137    Ops = SGData['SGOps']
2138    OpM = np.array([op[0] for op in Ops])
2139    Uniq = np.inner(OpM,HKL)
2140    Uniq = list(Uniq)+list(-1*Uniq)
2141    return np.array(Uniq)
2142
2143def GenHKLf(HKL,SGData):
2144    '''
2145    Uses old GSAS Fortran routine genhkl.for
2146
2147    :param HKL:  [h,k,l] must be integral values for genhkl.for to work
2148    :param SGData: space group data obtained from SpcGroup
2149    :returns: iabsnt,mulp,Uniq,phi
2150
2151     *   iabsnt = True if reflection is forbidden by symmetry
2152     *   mulp = reflection multiplicity including Friedel pairs
2153     *   Uniq = numpy array of equivalent hkl in descending order of h,k,l
2154     *   phi = phase offset for each equivalent h,k,l
2155
2156    '''
2157    hklf = list(HKL)+[0,]       #could be numpy array!
2158    Ops = SGData['SGOps']
2159    OpM = np.array([op[0] for op in Ops],order='F')
2160    OpT = np.array([op[1] for op in Ops])
2161    Cen = np.array([cen for cen in SGData['SGCen']],order='F')
2162   
2163    import pyspg
2164    Nuniq,Uniq,iabsnt,mulp = pyspg.genhklpy(hklf,len(Ops),OpM,OpT,SGData['SGInv'],len(Cen),Cen)
2165    h,k,l,f = Uniq
2166    Uniq=np.array(list(zip(h[:Nuniq],k[:Nuniq],l[:Nuniq])))
2167    phi = f[:Nuniq]
2168    return iabsnt,mulp,Uniq,phi
2169   
2170def checkSSLaue(HKL,SGData,SSGData):
2171    #Laue check here - Toss HKL if outside unique Laue part
2172    h,k,l,m = HKL
2173    if SGData['SGLaue'] == '2/m':
2174        if SGData['SGUniq'] == 'a':
2175            if 'a' in SSGData['modSymb'] and h == 0 and m < 0:
2176                return False
2177            elif 'b' in SSGData['modSymb'] and k == 0 and l ==0 and m < 0:
2178                return False
2179            else:
2180                return True
2181        elif SGData['SGUniq'] == 'b':
2182            if 'b' in SSGData['modSymb'] and k == 0 and m < 0:
2183                return False
2184            elif 'a' in SSGData['modSymb'] and h == 0 and l ==0 and m < 0:
2185                return False
2186            else:
2187                return True
2188        elif SGData['SGUniq'] == 'c':
2189            if 'g' in SSGData['modSymb'] and l == 0 and m < 0:
2190                return False
2191            elif 'a' in SSGData['modSymb'] and h == 0 and k ==0 and m < 0:
2192                return False
2193            else:
2194                return True
2195    elif SGData['SGLaue'] == 'mmm':
2196        if 'a' in SSGData['modSymb']:
2197            if h == 0 and m < 0:
2198                return False
2199            else:
2200                return True
2201        elif 'b' in SSGData['modSymb']:
2202            if k == 0 and m < 0:
2203                return False
2204            else:
2205                return True
2206        elif 'g' in SSGData['modSymb']:
2207            if l == 0 and m < 0:
2208                return False
2209            else:
2210                return True
2211    else:   #tetragonal, trigonal, hexagonal (& triclinic?)
2212        if l == 0 and m < 0:
2213            return False
2214        else:
2215            return True
2216       
2217def checkHKLextc(HKL,SGData):
2218    '''
2219    Checks if reflection extinct - does not check centering
2220
2221    :param HKL:  [h,k,l]
2222    :param SGData: space group data obtained from SpcGroup
2223    :returns: True if extinct; False if allowed
2224
2225    '''
2226    Ops = SGData['SGOps']
2227    OpM = np.array([op[0] for op in Ops])
2228    OpT = np.array([op[1] for op in Ops])
2229    HKLS = np.array([HKL,-HKL])     #Freidel's Law
2230    DHKL = np.reshape(np.inner(HKLS,OpM)-HKL,(-1,3))
2231    PHKL = np.reshape(np.inner(HKLS,OpT),(-1,))
2232    for dhkl,phkl in zip(DHKL,PHKL)[1:]:    #skip identity
2233        if dhkl.any():
2234            continue
2235        else:
2236            if phkl%1.:
2237                return True
2238    return False
2239
2240def checkMagextc(HKL,SGData):
2241    '''
2242    Checks if reflection magnetically extinct; does fullcheck (centering, too)
2243    uses algorthm from Gallego, et al., J. Appl. Cryst. 45, 1236-1247 (2012)
2244
2245    :param HKL:  [h,k,l]
2246    :param SGData: space group data obtained from SpcGroup; must have magnetic symmetry SpnFlp data
2247    :returns: True if magnetically extinct; False if allowed (to match GenHKLf)
2248
2249    '''
2250    Ops = SGData['SGOps']
2251    Ncen = len(SGData['SGCen'])
2252    OpM = np.array([op[0] for op in Ops])
2253    OpT = np.array([op[1] for op in Ops])
2254    if SGData['SGInv'] and not SGData['SGFixed']:
2255        OpM = np.vstack((OpM,-OpM))
2256        OpT = np.vstack((OpT,-OpT))%1.
2257    OpM = np.reshape(np.array(list(OpM)*Ncen),(-1,3,3))
2258    OpT = np.reshape(np.array([OpT+cen for cen in SGData['SGCen']]),(-1,3))
2259    Spn = SGData['SpnFlp'][:len(OpM)]
2260    Mag = np.array([nl.det(opm) for opm in OpM])*Spn
2261    DHKL = np.reshape(np.inner(HKL,OpM),(-1,3))
2262    PHKL = np.reshape(np.cos(2.0*np.pi*np.inner(HKL,OpT))*Mag,(-1,))[:,nxs,nxs]*OpM     #compute T(R,theta) eq(7)
2263    Ftest = np.random.rand(3)       #random magnetic moment
2264    Psum = np.zeros(3)
2265    nsum = 0.
2266    nA = 0
2267    for dhkl,phkl in zip(DHKL,PHKL):
2268        if not np.allclose(dhkl,HKL):           #test for eq(5)
2269            continue
2270        else:
2271            nA += 1
2272            nsum += np.trace(phkl)          #eq(8)
2273            pterm = np.inner(Ftest,phkl)    #eq(9)
2274            Psum += pterm
2275    if nsum/nA > 1.:        #only need to look at nA=1 frok eq(8)
2276        return False
2277    if np.allclose(Psum,np.zeros(3)):
2278        return True
2279    else:
2280        if np.inner(HKL,Psum):
2281            return True
2282        return False
2283   
2284def checkSSextc(HKL,SSGData):
2285    Ops = SSGData['SSGOps']
2286    OpM = np.array([op[0] for op in Ops])
2287    OpT = np.array([op[1] for op in Ops])
2288    HKLS = np.array([HKL,-HKL])     #Freidel's Law
2289    DHKL = np.reshape(np.inner(HKLS,OpM)-HKL,(-1,4))
2290    PHKL = np.reshape(np.inner(HKLS,OpT),(-1,))
2291    for dhkl,phkl in list(zip(DHKL,PHKL))[1:]:    #skip identity
2292        if dhkl.any():
2293            continue
2294        else:
2295            if phkl%1.:
2296                return False
2297    return True
2298   
2299################################################################################
2300#### Site symmetry tables
2301################################################################################
2302     
2303OprName = {
2304    '-6643':       ['-1',1],'6479' :    ['2(z)',2],'-6479':     ['m(z)',3],
2305    '6481' :     ['m(y)',4],'-6481':    ['2(y)',5],'6641' :     ['m(x)',6],
2306    '-6641':     ['2(x)',7],'6591' :  ['m(+-0)',8],'-6591':   ['2(+-0)',9],
2307    '6531' :  ['m(110)',10],'-6531': ['2(110)',11],'6537' :    ['4(z)',12],
2308    '-6537':   ['-4(z)',13],'975'  : ['3(111)',14],'6456' :       ['3',15],
2309    '-489' :  ['3(+--)',16],'483'  : ['3(-+-)',17],'-969' :  ['3(--+)',18],
2310    '819'  :  ['m(+0-)',19],'-819' : ['2(+0-)',20],'2431' :  ['m(0+-)',21],
2311    '-2431':  ['2(0+-)',22],'-657' :  ['m(xz)',23],'657'  :   ['2(xz)',24],
2312    '1943' :   ['-4(x)',25],'-1943':   ['4(x)',26],'-2429':   ['m(yz)',27],
2313    '2429' :   ['2(yz)',28],'639'  :  ['-4(y)',29],'-639' :    ['4(y)',30],
2314    '-6484':   ['2(010)',4],'6484' :  ['m(010)',5],'-6668':   ['2(100)',6],
2315    '6668' :   ['m(100)',7],'-6454': ['2(120)',18],'6454' :  ['m(120)',19],
2316    '-6638':  ['2(210)',20],'6638' : ['m(210)',21],   #search in SytSym ends at m(210)
2317    '2223' : ['3(+++)2',39],
2318    '6538' :   ['6(z)1',40],'-2169':['3(--+)2',41],'2151' : ['3(+--)2',42],
2319    '2205' :['-3(-+-)2',43],'-2205':[' (-+-)2',44],'489'  :['-3(+--)1',45],
2320    '801'  :   ['4(y)1',46],'1945' :  ['4(x)3',47],'-6585': ['-4(z)3 ',48],
2321    '6585' :   ['4(z)3',49],'6584' :  ['3(z)2',50],'6666' :  ['6(z)5 ',51],
2322    '6643' :       ['1',52],'-801' : ['-4(y)1',53],'-1945': ['-4(x)3 ',54],
2323    '-6666':  ['-6(z)5',55],'-6538': ['-6(z)1',56],'-2223':['-3(+++)2',57],
2324    '-975' :['-3(+++)1',58],'-6456': ['-3(z)1',59],'-483' :['-3(-+-)1',60],
2325    '969'  :['-3(--+)1',61],'-6584': ['-3(z)2',62],'2169' :['-3(--+)2',63],
2326    '-2151':['-3(+--)2',64],   }                               
2327
2328KNsym = {
2329    '0'         :'    1   ','1'         :'   -1   ','64'        :'    2(x)','32'        :'    m(x)',
2330    '97'        :'  2/m(x)','16'        :'    2(y)','8'         :'    m(y)','25'        :'  2/m(y)',
2331    '2'         :'    2(z)','4'         :'    m(z)','7'         :'  2/m(z)','134217728' :'   2(yz)',
2332    '67108864'  :'   m(yz)','201326593' :' 2/m(yz)','2097152'   :'  2(0+-)','1048576'   :'  m(0+-)',
2333    '3145729'   :'2/m(0+-)','8388608'   :'   2(xz)','4194304'   :'   m(xz)','12582913'  :' 2/m(xz)',
2334    '524288'    :'  2(+0-)','262144'    :'  m(+0-)','796433'    :'2/m(+0-)','1024'      :'   2(xy)',
2335    '512'       :'   m(xy)','1537'      :' 2/m(xy)','256'       :'  2(+-0)','128'       :'  m(+-0)',
2336    '385'       :'2/m(+-0)','76'        :'  mm2(x)','52'        :'  mm2(y)','42'        :'  mm2(z)',
2337    '135266336' :' mm2(yz)','69206048'  :'mm2(0+-)','8650760'   :' mm2(xz)','4718600'   :'mm2(+0-)',
2338    '1156'      :' mm2(xy)','772'       :'mm2(+-0)','82'        :'  222   ','136314944' :'  222(x)',
2339    '8912912'   :'  222(y)','1282'      :'  222(z)','127'       :'  mmm   ','204472417' :'  mmm(x)',
2340    '13369369'  :'  mmm(y)','1927'      :'  mmm(z)','33554496'  :'  4(x)','16777280'  :' -4(x)',
2341    '50331745'  :'4/m(x)'  ,'169869394' :'422(x)','84934738'  :'-42m(x)','101711948' :'4mm(x)',
2342    '254804095' :'4/mmm(x)','536870928 ':'  4(y)','268435472' :' -4(y)','805306393' :'4/m(y)',
2343    '545783890' :'422(y)','272891986' :'-42m(y)','541327412' :'4mm(y)','818675839' :'4/mmm(y)',
2344    '2050'      :'  4(z)','4098'      :' -4(z)','6151'      :'4/m(z)','3410'      :'422(z)',
2345    '4818'      :'-42m(z)','2730'      :'4mm(z)','8191'      :'4/mmm(z)','8192'      :'  3(111)',
2346    '8193'      :' -3(111)','2629888'   :' 32(111)','1319040'   :' 3m(111)','3940737'   :'-3m(111)',
2347    '32768'     :'  3(+--)','32769'     :' -3(+--)','10519552'  :' 32(+--)','5276160'   :' 3m(+--)',
2348    '15762945'  :'-3m(+--)','65536'     :'  3(-+-)','65537'     :' -3(-+-)','134808576' :' 32(-+-)',
2349    '67437056'  :' 3m(-+-)','202180097' :'-3m(-+-)','131072'    :'  3(--+)','131073'    :' -3(--+)',
2350    '142737664' :' 32(--+)','71434368'  :' 3m(--+)','214040961' :'-3m(--+)','237650'    :'   23   ',
2351    '237695'    :'   m3   ','715894098' :'   432  ','358068946' :'  -43m  ','1073725439':'   m3m  ',
2352    '68157504'  :' mm2(d100)','4456464'   :' mm2(d010)','642'       :' mm2(d001)','153092172' :'-4m2(x)',
2353    '277348404' :'-4m2(y)','5418'      :'-4m2(z)','1075726335':'  6/mmm ','1074414420':'-6m2(100)',
2354    '1075070124':'-6m2(120)','1075069650':'   6mm  ','1074414890':'   622  ','1073758215':'   6/m  ',
2355    '1073758212':'   -6   ','1073758210':'    6   ','1073759865':'-3m(100)','1075724673':'-3m(120)',
2356    '1073758800':' 3m(100)','1075069056':' 3m(120)','1073759272':' 32(100)','1074413824':' 32(120)',
2357    '1073758209':'   -3   ','1073758208':'    3   ','1074135143':'mmm(100)','1075314719':'mmm(010)',
2358    '1073743751':'mmm(110)','1074004034':' mm2(z100)','1074790418':' mm2(z010)','1073742466':' mm2(z110)',
2359    '1074004004':'mm2(100)','1074790412':'mm2(010)','1073742980':'mm2(110)','1073872964':'mm2(120)',
2360    '1074266132':'mm2(210)','1073742596':'mm2(+-0)','1073872930':'222(100)','1074266122':'222(010)',
2361    '1073743106':'222(110)','1073741831':'2/m(001)','1073741921':'2/m(100)','1073741849':'2/m(010)',
2362    '1073743361':'2/m(110)','1074135041':'2/m(120)','1075314689':'2/m(210)','1073742209':'2/m(+-0)',
2363    '1073741828':' m(001) ','1073741888':' m(100) ','1073741840':' m(010) ','1073742336':' m(110) ',
2364    '1074003968':' m(120) ','1074790400':' m(210) ','1073741952':' m(+-0) ','1073741826':' 2(001) ',
2365    '1073741856':' 2(100) ','1073741832':' 2(010) ','1073742848':' 2(110) ','1073872896':' 2(120) ',
2366    '1074266112':' 2(210) ','1073742080':' 2(+-0) ','1073741825':'   -1   ',
2367    }
2368
2369NXUPQsym = {
2370    '1'        :(28,29,28,28),'-1'       :( 1,29,28, 0),'2(x)'     :(12,18,12,25),'m(x)'     :(25,18,12,25),
2371    '2/m(x)'   :( 1,18, 0,-1),'2(y)'     :(13,17,13,24),'m(y)'     :(24,17,13,24),'2/m(y)'   :( 1,17, 0,-1),
2372    '2(z)'     :(14,16,14,23),'m(z)'     :(23,16,14,23),'2/m(z)'   :( 1,16, 0,-1),'2(yz)'    :(10,23,10,22),
2373    'm(yz)'    :(22,23,10,22),' 2/m(yz)' :( 1,23, 0,-1),'2(0+-)'   :(11,24,11,21),'m(0+-)'   :(21,24,11,21),
2374    '2/m(0+-)' :( 1,24, 0,-1),'2(xz)'    :( 8,21, 8,20),'m(xz)'    :(20,21, 8,20),'2/m(xz)'  :( 1,21, 0,-1),
2375    '2(+0-)'   :( 9,22, 9,19),'m(+0-)'   :(19,22, 9,19),'2/m(+0-)' :( 1,22, 0,-1),'2(xy)'    :( 6,19, 6,18),
2376    'm(xy)'    :(18,19, 6,18),' 2/m(xy)' :( 1,19, 0,-1),'2(+-0)'   :( 7,20, 7,17),'m(+-0)'   :(17,20, 7,17),
2377    'mm2(x)'  :(12,10, 0,-1),'mm2(y)'   :(13,10, 0,-1),'mm2(z)'   :(14,10, 0,-1),
2378    'mm2(yz)'  :(10,13, 0,-1),'mm2(0+-)' :(11,13, 0,-1),'mm2(xz)'  :( 8,12, 0,-1),'mm2(+0-)' :( 9,12, 0,-1),
2379    'mm2(xy)'  :( 6,11, 0,-1),'222'      :( 1,10, 0,-1),'222(x)'   :( 1,13, 0,-1),
2380    '222(y)'   :( 1,12, 0,-1),'222(z)'   :( 1,11, 0,-1),'mmm'      :( 1,10, 0,-1),'mmm(x)'   :( 1,13, 0,-1),
2381    'mmm(y)'   :( 1,12, 0,-1),'mmm(z)'   :( 1,11, 0,-1),'4(x)'     :(12, 4,12, 0),'-4(x)'    :( 1, 4,12, 0),
2382    '4/m(x)'   :( 1, 4,12,-1),'422(x)'   :( 1, 4, 0,-1),'-42m(x)'  :( 1, 4, 0,-1),'4mm(x)'   :(12, 4, 0,-1),
2383    '4/mmm(x)' :( 1, 4, 0,-1),'4(y)'     :(13, 3,13, 0),'-4(y)'    :( 1, 3,13, 0),'4/m(y)'   :( 1, 3,13,-1),
2384    '422(y)'   :( 1, 3, 0,-1),'-42m(y)'  :( 1, 3, 0,-1),'4mm(y)'   :(13, 3, 0,-1),'4/mmm(y)' :(1, 3, 0,-1,),
2385    '4(z)'     :(14, 2,14, 0),'-4(z)'    :( 1, 2,14, 0),'4/m(z)'   :( 1, 2,14,-1),'422(z)'   :( 1, 2, 0,-1),
2386    '-42m(z)'  :( 1, 2, 0,-1),'4mm(z)'   :(14, 2, 0,-1),'4/mmm(z)' :( 1, 2, 0,-1),'3(111)'   :( 2, 5, 2, 0),
2387    '-3(111)'  :( 1, 5, 2, 0),'32(111)'  :( 1, 5, 0, 2),'3m(111)'  :( 2, 5, 0, 2),'-3m(111)' :( 1, 5, 0,-1),
2388    '3(+--)'   :( 5, 8, 5, 0),'-3(+--)'  :( 1, 8, 5, 0),'32(+--)'  :( 1, 8, 0, 5),'3m(+--)'  :( 5, 8, 0, 5),
2389    '-3m(+--)' :( 1, 8, 0,-1),'3(-+-)'   :( 4, 7, 4, 0),'-3(-+-)'  :( 1, 7, 4, 0),'32(-+-)'  :( 1, 7, 0, 4),
2390    '3m(-+-)'  :( 4, 7, 0, 4),'-3m(-+-)' :( 1, 7, 0,-1),'3(--+)'   :( 3, 6, 3, 0),'-3(--+)'  :( 1, 6, 3, 0),
2391    '32(--+)'  :( 1, 6, 0, 3),'3m(--+)'  :( 3, 6, 0, 3),'-3m(--+)' :( 1, 6, 0,-1),'23'       :( 1, 1, 0, 0),
2392    'm3'       :( 1, 1, 0, 0),'432'      :( 1, 1, 0, 0),'-43m'     :( 1, 1, 0, 0),'m3m'      :( 1, 1, 0, 0),
2393    'mm2(d100)':(12,13, 0,-1),'mm2(d010)':(13,12, 0,-1),'mm2(d001)':(14,11, 0,-1),'-4m2(x)'  :( 1, 4, 0,-1),
2394    '-4m2(y)'  :( 1, 3, 0,-1),'-4m2(z)'  :( 1, 2, 0,-1),'6/mmm'    :( 1, 9, 0,-1),'-6m2(100)':( 1, 9, 0,-1),
2395    '-6m2(120)':( 1, 9, 0,-1),'6mm'      :(14, 9, 0,-1),'622'      :( 1, 9, 0,-1),'6/m'      :( 1, 9,14,-1),
2396    '-6'       :( 1, 9,14, 0),'6'        :(14, 9,14, 0),'-3m(100)' :( 1, 9, 0,-1),'-3m(120)' :( 1, 9, 0,-1),
2397    '3m(100)'  :(14, 9, 0,14),'3m(120)'  :(14, 9, 0,14),'32(100)'  :( 1, 9, 0,14),'32(120)'  :( 1, 9, 0,14),
2398    '-3'       :( 1, 9,14, 0),'3'        :(14, 9,14, 0),'mmm(100)' :( 1,14, 0,-1),'mmm(010)' :( 1,15, 0,-1),
2399    'mmm(110)' :( 1,11, 0,-1),'mm2(z100)':(14,14, 0,-1),'mm2(z010)':(14,15, 0,-1),'mm2(z110)':(14,11, 0,-1),
2400    'mm2(100)' :(12,14, 0,-1),'mm2(010)' :(13,15, 0,-1),'mm2(110)' :( 6,11, 0,-1),'mm2(120)' :(15,14, 0,-1),
2401    'mm2(210)' :(16,15, 0,-1),'mm2(+-0)' :( 7,11, 0,-1),'222(100)' :( 1,14, 0,-1),'222(010)' :( 1,15, 0,-1),
2402    '222(110)' :( 1,11, 0,-1),'2/m(001)' :( 1,16,14,-1),'2/m(100)' :( 1,25,12,-1),'2/m(010)' :( 1,28,13,-1),
2403    '2/m(110)' :( 1,19, 6,-1),'2/m(120)' :( 1,27,15,-1),'2/m(210)' :( 1,26,16,-1),'2/m(+-0)' :( 1,20,17,-1),
2404    'm(001)'   :(23,16,14,23),'m(100)'   :(26,25,12,26),'m(010)'   :(27,28,13,27),'m(110)'   :(18,19, 6,18),
2405    'm(120)'   :(24,27,15,24),'m(210)'   :(25,26,16,25),'m(+-0)'   :(17,20, 7,17),'2(001)'   :(14,16,14,23),
2406    '2(100)'   :(12,25,12,26),'2(010)'   :(13,28,13,27),'2(110)'   :( 6,19, 6,18),'2(120)'   :(15,27,15,24),
2407    '2(210)'   :(16,26,16,25),'2(+-0)'   :( 7,20, 7,17),'-1'       :( 1,29,28, 0)
2408    }
2409       
2410CSxinel = [[],      # 0th empty - indices are Fortran style
2411    [[0,0,0],[ 0.0, 0.0, 0.0]],      #1  0  0  0
2412    [[1,1,1],[ 1.0, 1.0, 1.0]],      #2  X  X  X
2413    [[1,1,1],[ 1.0, 1.0,-1.0]],      #3  X  X -X
2414    [[1,1,1],[ 1.0,-1.0, 1.0]],      #4  X -X  X
2415    [[1,1,1],[ 1.0,-1.0,-1.0]],      #5 -X  X  X
2416    [[1,1,0],[ 1.0, 1.0, 0.0]],      #6  X  X  0
2417    [[1,1,0],[ 1.0,-1.0, 0.0]],      #7  X -X  0
2418    [[1,0,1],[ 1.0, 0.0, 1.0]],      #8  X  0  X
2419    [[1,0,1],[ 1.0, 0.0,-1.0]],      #9  X  0 -X
2420    [[0,1,1],[ 0.0, 1.0, 1.0]],      #10  0  Y  Y
2421    [[0,1,1],[ 0.0, 1.0,-1.0]],      #11 0  Y -Y
2422    [[1,0,0],[ 1.0, 0.0, 0.0]],      #12  X  0  0
2423    [[0,1,0],[ 0.0, 1.0, 0.0]],      #13  0  Y  0
2424    [[0,0,1],[ 0.0, 0.0, 1.0]],      #14  0  0  Z
2425    [[1,1,0],[ 1.0, 2.0, 0.0]],      #15  X 2X  0
2426    [[1,1,0],[ 2.0, 1.0, 0.0]],      #16 2X  X  0
2427    [[1,1,2],[ 1.0, 1.0, 1.0]],      #17  X  X  Z
2428    [[1,1,2],[ 1.0,-1.0, 1.0]],      #18  X -X  Z
2429    [[1,2,1],[ 1.0, 1.0, 1.0]],      #19  X  Y  X
2430    [[1,2,1],[ 1.0, 1.0,-1.0]],      #20  X  Y -X
2431    [[1,2,2],[ 1.0, 1.0, 1.0]],      #21  X  Y  Y
2432    [[1,2,2],[ 1.0, 1.0,-1.0]],      #22  X  Y -Y
2433    [[1,2,0],[ 1.0, 1.0, 0.0]],      #23  X  Y  0
2434    [[1,0,2],[ 1.0, 0.0, 1.0]],      #24  X  0  Z
2435    [[0,1,2],[ 0.0, 1.0, 1.0]],      #25  0  Y  Z
2436    [[1,1,2],[ 1.0, 2.0, 1.0]],      #26  X 2X  Z
2437    [[1,1,2],[ 2.0, 1.0, 1.0]],      #27 2X  X  Z
2438    [[1,2,3],[ 1.0, 1.0, 1.0]],      #28  X  Y  Z
2439    ]
2440
2441CSuinel = [[],      # 0th empty - indices are Fortran style
2442    [[1,1,1,0,0,0],[ 1.0, 1.0, 1.0, 0.0, 0.0, 0.0],[1,0,0,0,0,0],[1.0,1.0,1.0,0.0,0.0,0.0]],    #1  A  A  A  0  0  0
2443    [[1,1,2,0,0,0],[ 1.0, 1.0, 1.0, 0.0, 0.0, 0.0],[1,0,1,0,0,0],[1.0,1.0,1.0,0.0,0.0,0.0]],    #2  A  A  C  0  0  0
2444    [[1,2,1,0,0,0],[ 1.0, 1.0, 1.0, 0.0, 0.0, 0.0],[1,1,0,0,0,0],[1.0,1.0,1.0,0.0,0.0,0.0]],    #3  A  B  A  0  0  0
2445    [[1,2,2,0,0,0],[ 1.0, 1.0, 1.0, 0.0, 0.0, 0.0],[1,1,0,0,0,0],[1.0,1.0,1.0,0.0,0.0,0.0]],    #4  A  B  B  0  0  0
2446    [[1,1,1,2,2,2],[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0],[1,0,0,1,0,0],[1.0,1.0,1.0,0.0,0.0,0.0]],    #5  A  A  A  D  D  D
2447    [[1,1,1,2,2,2],[ 1.0, 1.0, 1.0, 1.0,-1.0,-1.0],[1,0,0,1,0,0],[1.0,1.0,1.0,0.0,0.0,0.0]],    #6  A  A  A  D -D -D
2448    [[1,1,1,2,2,2],[ 1.0, 1.0, 1.0, 1.0,-1.0, 1.0],[1,0,0,1,0,0],[1.0,1.0,1.0,0.0,0.0,0.0]],    #7  A  A  A  D -D  D
2449    [[1,1,1,2,2,2],[ 1.0, 1.0, 1.0, 1.0, 1.0,-1.0],[1,0,0,1,0,0],[1.0,1.0,1.0,0.0,0.0,0.0]],    #8  A  A  A  D  D -D
2450    [[1,1,2,1,0,0],[ 1.0, 1.0, 1.0, 0.5, 0.0, 0.0],[1,0,1,0,0,0],[1.0,1.0,1.0,0.5,0.0,0.0]],    #9  A  A  C A/2 0  0
2451    [[1,2,3,0,0,0],[ 1.0, 1.0, 1.0, 0.0, 0.0, 0.0],[1,1,1,0,0,0],[1.0,1.0,1.0,0.0,0.0,0.0]],    #10  A  B  C  0  0  0
2452    [[1,1,2,3,0,0],[ 1.0, 1.0, 1.0, 1.0, 0.0, 0.0],[1,0,1,1,0,0],[1.0,1.0,1.0,0.0,0.0,0.0]],    #11  A  A  C  D  0  0
2453    [[1,2,1,0,3,0],[ 1.0, 1.0, 1.0, 0.0, 1.0, 0.0],[1,1,0,0,1,0],[1.0,1.0,1.0,0.0,0.0,0.0]],    #12  A  B  A  0  E  0
2454    [[1,2,2,0,0,3],[ 1.0, 1.0, 1.0, 0.0, 0.0, 1.0],[1,1,0,0,0,1],[1.0,1.0,1.0,0.0,0.0,0.0]],    #13  A  B  B  0  0  F
2455    [[1,2,3,2,0,0],[ 1.0, 1.0, 1.0, 0.5, 0.0, 0.0],[1,1,1,0,0,0],[1.0,1.0,1.0,0.0,0.5,0.0]],    #14  A  B  C B/2 0  0
2456    [[1,2,3,1,0,0],[ 1.0, 1.0, 1.0, 0.5, 0.0, 0.0],[1,1,1,0,0,0],[1.0,1.0,1.0,0.0,0.5,0.0]],    #15  A  B  C A/2 0  0
2457    [[1,2,3,4,0,0],[ 1.0, 1.0, 1.0, 1.0, 0.0, 0.0],[1,1,1,1,0,0],[1.0,1.0,1.0,0.0,0.0,0.0]],    #16  A  B  C  D  0  0
2458    [[1,2,3,0,4,0],[ 1.0, 1.0, 1.0, 0.0, 1.0, 0.0],[1,1,1,0,1,0],[1.0,1.0,1.0,0.0,0.0,0.0]],    #17  A  B  C  0  E  0
2459    [[1,2,3,0,0,4],[ 1.0, 1.0, 1.0, 0.0, 0.0, 1.0],[1,1,1,0,0,1],[1.0,1.0,1.0,0.0,0.0,0.0]],    #18  A  B  C  0  0  F
2460    [[1,1,2,3,4,4],[ 1.0, 1.0, 1.0, 1.0, 1.0,-1.0],[1,0,1,1,1,0],[1.0,1.0,1.0,0.0,0.0,0.0]],    #19  A  A  C  D  E -E
2461    [[1,1,2,3,4,4],[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0],[1,0,1,1,1,0],[1.0,1.0,1.0,0.0,0.0,0.0]],    #20  A  A  C  D  E  E
2462    [[1,2,1,3,4,3],[ 1.0, 1.0, 1.0, 1.0, 1.0,-1.0],[1,1,0,1,1,0],[1.0,1.0,1.0,0.0,0.0,0.0]],    #21  A  B  A  D  E -D
2463    [[1,2,1,3,4,3],[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0],[1,1,0,1,1,0],[1.0,1.0,1.0,0.0,0.0,0.0]],    #22  A  B  A  D  E  D
2464    [[1,2,2,3,3,4],[ 1.0, 1.0, 1.0, 1.0,-1.0, 1.0],[1,1,0,1,0,1],[1.0,1.0,1.0,0.0,0.0,0.0]],    #23  A  B  B  D -D  F
2465    [[1,2,2,3,3,4],[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0],[1,1,0,1,0,1],[1.0,1.0,1.0,0.0,0.0,0.0]],    #24  A  B  B  D  D  F
2466    [[1,2,3,2,4,4],[ 1.0, 1.0, 1.0, 0.5, 1.0, 2.0],[1,1,1,0,0,1],[1.0,1.0,1.0,0.5,0.0,0.0]],    #25  A  B  C B/2 F/2 F
2467    [[1,2,3,1,0,4],[ 1.0, 1.0, 1.0, 0.5, 0.0, 1.0],[1,1,1,0,0,1],[1.0,1.0,1.0,0.5,0.0,0.0]],    #26  A  B  C A/2  0  F
2468    [[1,2,3,2,4,0],[ 1.0, 1.0, 1.0, 0.5, 1.0, 0.0],[1,1,1,0,1,0],[1.0,1.0,1.0,0.5,0.0,0.0]],    #27  A  B  C B/2  E  0
2469    [[1,2,3,1,4,4],[ 1.0, 1.0, 1.0, 0.5, 1.0, 0.5],[1,1,1,0,1,0],[1.0,1.0,1.0,0.5,0.0,0.0]],    #28  A  B  C A/2  E E/2
2470    [[1,2,3,4,5,6],[ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0],[1,1,1,1,1,1],[1.0,1.0,1.0,0.0,0.0,0.0]],    #29  A  B  C  D  E   F
2471    ]
2472   
2473################################################################################
2474#### Site symmetry routines
2475################################################################################
2476   
2477def GetOprPtrName(key):
2478    'Needs a doc string'
2479    try:
2480        oprName = OprName[key][0]
2481    except KeyError:
2482        return key
2483    return oprName.replace('(','').replace(')','')
2484
2485def GetOprPtrNumber(key):
2486    'Needs a doc string'
2487    try:
2488        return OprName[key][1]
2489    except KeyError:
2490        return key
2491
2492def GetOprName(key):
2493    'Needs a doc string'
2494    return OprName[key][0]
2495
2496def GetKNsym(key):
2497    'Needs a doc string'
2498    try:
2499        return KNsym[key].strip()
2500    except KeyError:
2501        return 'sp'
2502
2503def GetNXUPQsym(siteSym):
2504    '''       
2505    The codes XUPQ are for lookup of symmetry constraints for position(X), thermal parm(U) & magnetic moments (P & Q)
2506    '''
2507    return NXUPQsym[siteSym]
2508
2509def GetCSxinel(siteSym): 
2510    "returns Xyz terms, multipliers, GUI flags"
2511    indx = GetNXUPQsym(siteSym.strip())
2512    return CSxinel[indx[0]]
2513   
2514def GetCSuinel(siteSym):
2515    "returns Uij terms, multipliers, GUI flags & Uiso2Uij multipliers"
2516    indx = GetNXUPQsym(siteSym.strip())
2517    return CSuinel[indx[1]]
2518   
2519def GetCSpqinel(SpnFlp,dupDir): 
2520    "returns Mxyz terms, multipliers, GUI flags"
2521    CSI = [[1,2,3],[1.0,1.0,1.0]]
2522    for sopr in dupDir:
2523#        print (sopr,dupDir[sopr])
2524        opr = sopr.replace("'",'')
2525        indx = GetNXUPQsym(opr)
2526        if SpnFlp[dupDir[sopr]] > 0:
2527            csi = CSxinel[indx[2]]  #P
2528        else:
2529            csi = CSxinel[indx[3]]  #Q
2530#        print(opr,indx,csi,CSI)
2531        if not len(csi):
2532            return [[0,0,0],[0.,0.,0.]]
2533        for kcs in [0,1,2]:
2534            if csi[0][kcs] == 0 and CSI[0][kcs] != 0:
2535                jcs = CSI[0][kcs]
2536                for ics in [0,1,2]:
2537                    if CSI[0][ics] == jcs:
2538                        CSI[0][ics] = 0
2539                        CSI[1][ics] = 0.
2540                    elif CSI[0][ics] > jcs:
2541                        CSI[0][ics] = CSI[0][ics]-1
2542            elif (CSI[0][kcs] == csi[0][kcs]) and (CSI[1][kcs] != csi[1][kcs]):
2543                CSI[1][kcs] = csi[1][kcs]
2544            elif CSI[0][kcs] >= csi[0][kcs]:
2545                CSI[0][kcs] = min(CSI[0][kcs],csi[0][kcs])
2546                if CSI[1][kcs] != csi[1][kcs]:
2547                    if CSI[1][kcs] == 1.:
2548                        CSI[1][kcs] = csi[1][kcs]
2549#        print(CSI)
2550    return CSI
2551   
2552def getTauT(tau,sop,ssop,XYZ,wave=np.zeros(3)):
2553    phase = np.sum(XYZ*wave)
2554    ssopinv = nl.inv(ssop[0])
2555    mst = ssopinv[3][:3]
2556    epsinv = ssopinv[3][3]
2557    sdet = nl.det(sop[0])
2558    ssdet = nl.det(ssop[0])
2559    dtau = mst*(XYZ-sop[1])-epsinv*ssop[1][3]
2560    dT = 1.0
2561    if np.any(dtau%.5):
2562        sumdtau = np.sum(dtau%.5)
2563        dT = 0.
2564        if np.abs(sumdtau-.5) > 1.e-4:
2565            dT = np.tan(np.pi*sumdtau)
2566    tauT = np.inner(mst,XYZ-sop[1])+epsinv*(tau-ssop[1][3]+phase)
2567    return sdet,ssdet,dtau,dT,tauT
2568   
2569def OpsfromStringOps(A,SGData,SSGData):
2570    SGOps = SGData['SGOps']
2571    SSGOps = SSGData['SSGOps']
2572    Ax = A.split('+')
2573    Ax[0] = int(Ax[0])
2574    iC = 1
2575    if Ax[0] < 0:
2576        iC = -1
2577    iAx = abs(Ax[0])
2578    nA = iAx%100-1
2579    nC = iAx//100
2580    unit = [0,0,0]
2581    if len(Ax) > 1:
2582        unit = eval('['+Ax[1]+']')
2583    return SGOps[nA],SSGOps[nA],iC,SGData['SGCen'][nC],unit
2584   
2585def GetSSfxuinel(waveType,Stype,nH,XYZ,SGData,SSGData,debug=False):
2586   
2587    def orderParms(CSI):
2588        parms = [0,]
2589        for csi in CSI:
2590            for i in [0,1,2]:
2591                if csi[i] not in parms:
2592                    parms.append(csi[i])
2593        for csi in CSI:
2594            for i in [0,1,2]:
2595                csi[i] = parms.index(csi[i])
2596        return CSI
2597       
2598    def fracCrenel(tau,Toff,Twid):
2599        Tau = (tau-Toff[:,nxs])%1.
2600        A = np.where(Tau<Twid[:,nxs],1.,0.)
2601        return A
2602       
2603    def fracFourier(tau,nH,fsin,fcos):
2604        SA = np.sin(2.*nH*np.pi*tau)
2605        CB = np.cos(2.*nH*np.pi*tau)
2606        A = SA[nxs,nxs,:]*fsin[:,:,nxs]
2607        B = CB[nxs,nxs,:]*fcos[:,:,nxs]
2608        return A+B
2609       
2610    def posFourier(tau,nH,psin,pcos):
2611        SA = np.sin(2*nH*np.pi*tau)
2612        CB = np.cos(2*nH*np.pi*tau)
2613        A = SA[nxs,nxs,:]*psin[:,:,nxs]
2614        B = CB[nxs,nxs,:]*pcos[:,:,nxs]
2615        return A+B   
2616
2617    def posZigZag(tau,Tmm,XYZmax):
2618        DT = Tmm[1]-Tmm[0]
2619        slopeUp = 2.*XYZmax/DT
2620        slopeDn = 2.*XYZmax/(1.-DT)
2621        A = np.array([np.where(0. < t-(Tmm[0])%1. <= DT,-XYZmax+slopeUp*((t-Tmm[0])%1.),XYZmax-slopeDn*((t-Tmm[1])%1.)) for t in tau])
2622        return A
2623
2624    def posBlock(tau,Tmm,XYZmax):
2625        A = np.array([np.where(Tmm[0] < t <= Tmm[1],XYZmax,-XYZmax) for t in tau])
2626        return A
2627       
2628    def DoFrac():
2629        delt2 = np.eye(2)*0.001
2630        dF = fracFourier(tau,nH,delt2[:1],delt2[1:]).squeeze()
2631        dFTP = []
2632        if siteSym == '1':
2633            CSI = [[1,0],[2,0]],2*[[1.,0.],]
2634        elif siteSym == '-1':
2635            CSI = [[1,0],[0,0]],2*[[1.,0.],]
2636        else:
2637            FSC = np.ones(2,dtype='i')
2638            CSI = [np.zeros((2),dtype='i'),np.zeros(2)]
2639            if 'Crenel' in waveType:
2640                dF = np.zeros_like(tau)
2641            else:
2642                dF = fracFourier(tau,nH,delt2[:1],delt2[1:]).squeeze()
2643            dFT = np.zeros_like(dF)
2644            dFTP = []
2645            for i in SdIndx:
2646                sop = Sop[i]
2647                ssop = SSop[i]           
2648                sdet,ssdet,dtau,dT,tauT = getTauT(tau,sop,ssop,XYZ)
2649                fsc = np.ones(2,dtype='i')
2650                if 'Crenel' in waveType:
2651                    dFT = np.zeros_like(tau)
2652                    fsc = [1,1]
2653                else:   #Fourier
2654                    dFT = fracFourier(tauT,nH,delt2[:1],delt2[1:]).squeeze()
2655                    dFT = nl.det(sop[0])*dFT
2656                    dFT = dFT[:,np.argsort(tauT)]
2657                    dFT[0] *= ssdet
2658                    dFT[1] *= sdet
2659                    dFTP.append(dFT)
2660               
2661                    if np.any(dtau%.5) and ('1/2' in SSGData['modSymb'] or '1' in SSGData['modSymb']):
2662                        fsc = [1,1]
2663                        if dT:
2664                            CSI = [[[1,0],[1,0]],[[1.,0.],[1/dT,0.]]]
2665                        else:
2666                            CSI = [[[1,0],[0,0]],[[1.,0.],[0.,0.]]]
2667                        FSC = np.zeros(2,dtype='i')
2668                        return CSI,dF,dFTP
2669                    else:
2670                        for i in range(2):
2671                            if np.allclose(dF[i,:],dFT[i,:],atol=1.e-6):
2672                                fsc[i] = 1
2673                            else:
2674                                fsc[i] = 0
2675                        FSC &= fsc
2676                        if debug: print (SSMT2text(ssop).replace(' ',''),sdet,ssdet,epsinv,fsc)
2677            n = -1
2678            for i,F in enumerate(FSC):
2679                if F:
2680                    n += 1
2681                    CSI[0][i] = n+1
2682                    CSI[1][i] = 1.0
2683           
2684        return CSI,dF,dFTP
2685       
2686    def DoXYZ():
2687        delt5 = np.ones(5)*0.001
2688        delt6 = np.eye(6)*0.001
2689        if 'Fourier' in waveType:
2690            dX = posFourier(tau,nH,delt6[:3],delt6[3:]) #+np.array(XYZ)[:,nxs,nxs]
2691              #3x6x12 modulated position array (X,Spos,tau)& force positive
2692        elif waveType in ['ZigZag','Block']:
2693            if waveType == 'ZigZag':
2694                dX = posZigZag(tau,delt5[:2],delt5[2:])
2695            else:
2696                dX = posBlock(tau,delt5[:2],delt5[2:])
2697        dXTP = []
2698        if siteSym == '1':
2699            CSI = [[1,0,0],[2,0,0],[3,0,0], [4,0,0],[5,0,0],[6,0,0]],6*[[1.,0.,0.],]
2700        elif siteSym == '-1':
2701            CSI = [[1,0,0],[2,0,0],[3,0,0], [0,0,0],[0,0,0],[0,0,0]],3*[[1.,0.,0.],]+3*[[0.,0.,0.],]
2702        else:
2703            if 'Fourier' in waveType:
2704                CSI = [np.zeros((6,3),dtype='i'),np.zeros((6,3))]
2705            elif waveType in ['ZigZag','Block']:
2706                CSI = [np.array([[1,0,0],[2,0,0],[3,0,0],[4,0,0],[5,0,0]]),
2707                    np.array([[1.0,.0,.0],[1.0,.0,.0],[1.0,.0,.0],[1.0,.0,.0],[1.0,.0,.0]])]
2708            XSC = np.ones(6,dtype='i')
2709            dXTP = []
2710            for i in SdIndx:
2711                sop = Sop[i]
2712                ssop = SSop[i]
2713                sdet,ssdet,dtau,dT,tauT = getTauT(tau,sop,ssop,XYZ)
2714                xsc = np.ones(6,dtype='i')
2715                if 'Fourier' in waveType:
2716                    dXT = posFourier(np.sort(tauT),nH,delt6[:3],delt6[3:])   #+np.array(XYZ)[:,nxs,nxs]
2717                elif waveType == 'ZigZag':
2718                    dXT = posZigZag(tauT,delt5[:2],delt5[2:])+np.array(XYZ)[:,nxs,nxs]
2719                elif waveType == 'Block':
2720                    dXT = posBlock(tauT,delt5[:2],delt5[2:])+np.array(XYZ)[:,nxs,nxs]
2721                dXT = np.inner(sop[0],dXT.T)    # X modulations array(3x6x49) -> array(3x49x6)
2722                dXT = np.swapaxes(dXT,1,2)      # back to array(3x6x49)
2723                dXT[:,:3,:] *= (ssdet*sdet)            # modify the sin component
2724                dXTP.append(dXT)
2725                if waveType == 'Fourier':
2726                    for i in range(3):
2727                        if not np.allclose(dX[i,i,:],dXT[i,i,:]):
2728                            xsc[i] = 0
2729                        if not np.allclose(dX[i,i+3,:],dXT[i,i+3,:]):
2730                            xsc[i+3] = 0
2731                    if np.any(dtau%.5) and ('1/2' in SSGData['modSymb'] or '1' in SSGData['modSymb']):
2732                        xsc[3:6] = 0
2733                        CSI = [[[1,0,0],[2,0,0],[3,0,0], [1,0,0],[2,0,0],[3,0,0]],
2734                            [[1.,0.,0.],[1.,0.,0.],[1.,0.,0.], [1.,0.,0.],[1.,0.,0.],[1.,0.,0.]]]
2735                        if dT:
2736                            if '(x)' in siteSym:
2737                                CSI[1][3:] = [1./dT,0.,0.],[-dT,0.,0.],[-dT,0.,0.]
2738                                if 'm' in siteSym and len(SdIndx) == 1:
2739                                    CSI[1][3:] = [-dT,0.,0.],[1./dT,0.,0.],[1./dT,0.,0.]
2740                            elif '(y)' in siteSym:
2741                                CSI[1][3:] = [-dT,0.,0.],[1./dT,0.,0.],[-dT,0.,0.]
2742                                if 'm' in siteSym and len(SdIndx) == 1:
2743                                    CSI[1][3:] = [1./dT,0.,0.],[-dT,0.,0.],[1./dT,0.,0.]
2744                            elif '(z)' in siteSym:
2745                                CSI[1][3:] = [-dT,0.,0.],[-dT,0.,0.],[1./dT,0.,0.]
2746                                if 'm' in siteSym and len(SdIndx) == 1:
2747                                    CSI[1][3:] = [1./dT,0.,0.],[1./dT,0.,0.],[-dT,0.,0.]
2748                        else:
2749                            CSI[1][3:] = [0.,0.,0.],[0.,0.,0.],[0.,0.,0.]
2750                    if '4/mmm' in laue:
2751                        if np.any(dtau%.5) and '1/2' in SSGData['modSymb']:
2752                            if '(xy)' in siteSym:
2753                                CSI[0] = [[1,0,0],[1,0,0],[2,0,0], [1,0,0],[1,0,0],[2,0,0]]
2754                                if dT:
2755                                    CSI[1][3:] = [[1./dT,0.,0.],[1./dT,0.,0.],[-dT,0.,0.]]
2756                                else:
2757                                    CSI[1][3:] = [0.,0.,0.],[0.,0.,0.],[0.,0.,0.]
2758                        if '(xy)' in siteSym or '(+-0)' in siteSym:
2759                            mul = 1
2760                            if '(+-0)' in siteSym:
2761                                mul = -1
2762                            if np.allclose(dX[0,0,:],dXT[1,0,:]):
2763                                CSI[0][3:5] = [[11,0,0],[11,0,0]]
2764                                CSI[1][3:5] = [[1.,0,0],[mul,0,0]]
2765                                xsc[3:5] = 0
2766                            if np.allclose(dX[0,3,:],dXT[0,4,:]):
2767                                CSI[0][:2] = [[12,0,0],[12,0,0]]
2768                                CSI[1][:2] = [[1.,0,0],[mul,0,0]]
2769                                xsc[:2] = 0
2770                else:
2771                    for i in range(3):
2772                        if not np.allclose(dX[:,i],dXT[i,:,i]):
2773                            xsc[i] = 0
2774                XSC &= xsc
2775                if debug: print (SSMT2text(ssop).replace(' ',''),sdet,ssdet,epsinv,xsc)
2776            if waveType == 'Fourier':
2777                n = -1
2778                if debug: print (XSC)
2779                for i,X in enumerate(XSC):
2780                    if X:
2781                        n += 1
2782                        CSI[0][i][0] = n+1
2783                        CSI[1][i][0] = 1.0
2784           
2785        return list(CSI),dX,dXTP
2786       
2787    def DoUij():
2788        delt12 = np.eye(12)*0.0001
2789        dU = posFourier(tau,nH,delt12[:6],delt12[6:])                  #Uij modulations - 6x12x12 array
2790        dUTP = []
2791        if siteSym == '1':
2792            CSI = [[1,0,0],[2,0,0],[3,0,0],[4,0,0],[5,0,0],[6,0,0], 
2793                [7,0,0],[8,0,0],[9,0,0],[10,0,0],[11,0,0],[12,0,0]],12*[[1.,0.,0.],]
2794        elif siteSym == '-1':
2795            CSI = 6*[[0,0,0],]+[[1,0,0],[2,0,0],[3,0,0],[4,0,0],[5,0,0],[6,0,0]],   \
2796                6*[[0.,0.,0.],]+[[1.,0.,0.],[1.,0.,0.],[1.,0.,0.],[1.,0.,0.],[1.,0.,0.],[1.,0.,0.]]
2797        else:
2798            CSI = [np.zeros((12,3),dtype='i'),np.zeros((12,3))]
2799            USC = np.ones(12,dtype='i')
2800            dUTP = []
2801            dtau = 0.
2802            for i in SdIndx:
2803                sop = Sop[i]
2804                ssop = SSop[i]
2805                sdet,ssdet,dtau,dT,tauT = getTauT(tau,sop,ssop,XYZ)
2806                usc = np.ones(12,dtype='i')
2807                dUT = posFourier(tauT,nH,delt12[:6],delt12[6:])                  #Uij modulations - 6x12x49 array
2808                dUijT = np.rollaxis(np.rollaxis(np.array(Uij2U(dUT)),3),3)    #convert dUT to 12x49x3x3
2809                dUijT = np.rollaxis(np.inner(np.inner(sop[0],dUijT),sop[0].T),3) #transform by sop - 3x3x12x49
2810                dUT = np.array(U2Uij(dUijT))    #convert to 6x12x49
2811                dUT = dUT[:,:,np.argsort(tauT)]
2812                dUT[:,:6,:] *=(ssdet*sdet)
2813                dUTP.append(dUT)
2814                if np.any(dtau%.5) and ('1/2' in SSGData['modSymb'] or '1' in SSGData['modSymb']):
2815                    if dT:
2816                        CSI = [[[1,0,0],[2,0,0],[3,0,0],[4,0,0],[5,0,0],[6,0,0], 
2817                        [1,0,0],[2,0,0],[3,0,0],[4,0,0],[5,0,0],[6,0,0]],
2818                        [[1.,0.,0.],[1.,0.,0.],[1.,0.,0.], [1.,0.,0.],[1.,0.,0.],[1.,0.,0.],
2819                        [1./dT,0.,0.],[1./dT,0.,0.],[1./dT,0.,0.], [1.,0.,0.],[1.,0.,0.],[1.,0.,0.]]]
2820                    else:
2821                        CSI = [[[1,0,0],[2,0,0],[3,0,0],[4,0,0],[5,0,0],[6,0,0], 
2822                        [1,0,0],[2,0,0],[3,0,0],[4,0,0],[5,0,0],[6,0,0]],
2823                        [[1.,0.,0.],[1.,0.,0.],[1.,0.,0.], [1.,0.,0.],[1.,0.,0.],[1.,0.,0.],
2824                        [0.,0.,0.],[0.,0.,0.],[0.,0.,0.], [1.,0.,0.],[1.,0.,0.],[1.,0.,0.]]]
2825                    if 'mm2(x)' in siteSym and dT:
2826                        CSI[1][9:] = [0.,0.,0.],[-dT,0.,0.],[0.,0.,0.]
2827                        USC = [1,1,1,0,1,0,1,1,1,0,1,0]
2828                    elif '(xy)' in siteSym and dT:
2829                        CSI[0] = [[1,0,0],[1,0,0],[2,0,0],[3,0,0],[4,0,0],[4,0,0],
2830                            [1,0,0],[1,0,0],[2,0,0],[3,0,0],[4,0,0],[4,0,0]]
2831                        CSI[1][9:] = [[1./dT,0.,0.],[-dT,0.,0.],[-dT,0.,0.]]
2832                        USC = [1,1,1,1,1,1,1,1,1,1,1,1]                             
2833                    elif '(x)' in siteSym and dT:
2834                        CSI[1][9:] = [-dT,0.,0.],[-dT,0.,0.],[1./dT,0.,0.]
2835                    elif '(y)' in siteSym and dT:
2836                        CSI[1][9:] = [-dT,0.,0.],[1./dT,0.,0.],[-dT,0.,0.]
2837                    elif '(z)' in siteSym and dT:
2838                        CSI[1][9:] = [1./dT,0.,0.],[-dT,0.,0.],[-dT,0.,0.]
2839                    for i in range(6):
2840                        if not USC[i]:
2841                            CSI[0][i] = [0,0,0]
2842                            CSI[1][i] = [0.,0.,0.]
2843                            CSI[0][i+6] = [0,0,0]
2844                            CSI[1][i+6] = [0.,0.,0.]
2845                else:                       
2846                    for i in range(6):
2847                        if not np.allclose(dU[i,i,:],dUT[i,i,:]):  #sin part
2848                            usc[i] = 0
2849                        if not np.allclose(dU[i,i+6,:],dUT[i,i+6,:]):   #cos part
2850                            usc[i+6] = 0
2851                    if np.any(dUT[1,0,:]):
2852                        if '4/m' in siteSym:
2853                            CSI[0][6:8] = [[12,0,0],[12,0,0]]
2854                            if ssop[1][3]:
2855                                CSI[1][6:8] = [[1.,0.,0.],[-1.,0.,0.]]
2856                                usc[9] = 1
2857                            else:
2858                                CSI[1][6:8] = [[1.,0.,0.],[1.,0.,0.]]
2859                                usc[9] = 0
2860                        elif '4' in siteSym:
2861                            CSI[0][6:8] = [[12,0,0],[12,0,0]]
2862                            CSI[0][:2] = [[11,0,0],[11,0,0]]
2863                            if ssop[1][3]:
2864                                CSI[1][:2] = [[1.,0.,0.],[-1.,0.,0.]]
2865                                CSI[1][6:8] = [[1.,0.,0.],[-1.,0.,0.]]
2866                                usc[2] = 0
2867                                usc[8] = 0
2868                                usc[3] = 1
2869                                usc[9] = 1
2870                            else:
2871                                CSI[1][:2] = [[1.,0.,0.],[1.,0.,0.]]
2872                                CSI[1][6:8] = [[1.,0.,0.],[1.,0.,0.]]
2873                                usc[2] = 1
2874                                usc[8] = 1
2875                                usc[3] = 0               
2876                                usc[9] = 0
2877                        elif 'xy' in siteSym or '+-0' in siteSym:
2878                            if np.allclose(dU[0,0,:],dUT[0,1,:]*sdet):
2879                                CSI[0][4:6] = [[12,0,0],[12,0,0]]
2880                                CSI[0][6:8] = [[11,0,0],[11,0,0]]
2881                                CSI[1][4:6] = [[1.,0.,0.],[sdet,0.,0.]]
2882                                CSI[1][6:8] = [[1.,0.,0.],[sdet,0.,0.]]
2883                                usc[4:6] = 0
2884                                usc[6:8] = 0
2885                           
2886                    if debug: print (SSMT2text(ssop).replace(' ',''),sdet,ssdet,epsinv,usc)
2887                USC &= usc
2888            if debug: print (USC)
2889            if not np.any(dtau%.5):
2890                n = -1
2891                for i,U in enumerate(USC):
2892                    if U:
2893                        n += 1
2894                        CSI[0][i][0] = n+1
2895                        CSI[1][i][0] = 1.0
2896   
2897        return list(CSI),dU,dUTP
2898   
2899    def DoMag():
2900        delt6 = np.eye(6)*0.001
2901        dM = posFourier(tau,nH,delt6[:3],delt6[3:]) #+np.array(Mxyz)[:,nxs,nxs]
2902        dMTP = []
2903        CSI = [np.zeros((6,3),dtype='i'),np.zeros((6,3))]
2904        if siteSym == '1':
2905            CSI = [[1,0,0],[2,0,0],[3,0,0],[4,0,0],[5,0,0],[6,0,0]],6*[[1.,0.,0.],]
2906        elif siteSym in ['-1','mmm',]:
2907            CSI = 3*[[0,0,0],]+[[1,0,0],[2,0,0],[3,0,0]],3*[[0.,0.,0.],]+3*[[1.,0.,0.],]
2908        elif siteSym in ['4(z)','422(z)']:
2909            CSI[0][0][0] = CSI[0][4][1] = 1
2910            CSI[1][0][0] = 1.0
2911            CSI[1][4][1] = -1.0
2912        elif siteSym in ['-4m2(z)','422(z)',]:
2913            CSI[0][5][0] = 1
2914            CSI[1][5][0] = 1.0
2915        elif siteSym in ['-32(100)','-3',]:
2916            CSI[0][2][0] = 1
2917            CSI[1][2][0] = 1.0
2918        elif siteSym in ['3',]:
2919            CSI[0][0][0] = CSI[0][3][0] = CSI[0][4][0] = 1
2920            CSI[1][0][0] = -np.sqrt(3.0)
2921            CSI[1][3][0] = 2.0
2922            CSI[1][4][0] = 1.0
2923        elif siteSym in ['622','2(100)','32(100)',]:
2924            CSI[0][0][0] = CSI[0][1][0] = CSI[0][3][0] = 1
2925            CSI[1][0][0] = 1.0
2926            CSI[1][1][0] = 2.0
2927            CSI[1][3][0] = np.sqrt(3.0)
2928        else:
2929              #3x6x12 modulated moment array (M,Spos,tau)& force positive
2930            CSI = [np.zeros((6,3),dtype='i'),np.zeros((6,3))]
2931            MSC = np.ones(6,dtype='i')
2932            dMTP = []
2933            for i in SdIndx:
2934                sop = Sop[i]
2935                ssop = SSop[i]
2936                sdet,ssdet,dtau,dT,tauT = getTauT(tau,sop,ssop,XYZ)
2937                msc = np.ones(6,dtype='i')
2938                dMT = posFourier(np.sort(tauT),nH,delt6[:3],delt6[3:])   #+np.array(XYZ)[:,nxs,nxs]
2939                dMT = np.inner(sop[0],dMT.T)    # X modulations array(3x6x49) -> array(3x49x6)
2940                dMT = np.swapaxes(dMT,1,2)      # back to array(3x6x49)
2941                dMT[:,:3,:] *= (ssdet*sdet)            # modify the sin component
2942                dMTP.append(dMT)
2943                for i in range(3):
2944                    if not np.allclose(dM[i,i,:],sdet*dMT[i,i,:]):
2945                        msc[i] = 0
2946                    if not np.allclose(dM[i,i+3,:],sdet*dMT[i,i+3,:]):
2947                        msc[i+3] = 0
2948                if np.any(dtau%.5) and ('1/2' in SSGData['modSymb'] or '1' in SSGData['modSymb']):
2949                    msc[3:6] = 0
2950                    CSI = [[[1,0,0],[2,0,0],[3,0,0], [1,0,0],[2,0,0],[3,0,0]],
2951                        [[1.,0.,0.],[1.,0.,0.],[1.,0.,0.], [1.,0.,0.],[1.,0.,0.],[1.,0.,0.]]]
2952                    if dT:
2953                        if '(x)' in siteSym:
2954                            CSI[1][3:] = [1./dT,0.,0.],[-dT,0.,0.],[-dT,0.,0.]
2955                            if 'm' in siteSym and len(SdIndx) == 1:
2956                                CSI[1][3:] = [1./dT,0.,0.],[-dT,0.,0.],[-dT,0.,0.]
2957                        elif '(y)' in siteSym:
2958                            CSI[1][3:] = [-dT,0.,0.],[1./dT,0.,0.],[-dT,0.,0.]
2959                            if 'm' in siteSym and len(SdIndx) == 1:
2960                                CSI[1][3:] = [-dT,0.,0.],[1./dT,0.,0.],[-dT,0.,0.]
2961                        elif '(z)' in siteSym:
2962                            CSI[1][3:] = [-dT,0.,0.],[-dT,0.,0.],[1./dT,0.,0.]
2963                            if 'm' in siteSym and len(SdIndx) == 1:
2964                                CSI[1][3:] = [-dT,0.,0.],[-dT,0.,0.],[1./dT,0.,0.]
2965                    else:
2966                        CSI[1][3:] = [0.,0.,0.],[0.,0.,0.],[0.,0.,0.]
2967                if '4/mmm' in laue:
2968                    if siteSym in ['4/mmm(z)',]:
2969                        CSI = 3*[[0,0,0],]+[[0,0,0],[0,0,0],[1,0,0]],3*[[0.,0.,0.],]+3*[[1.,0.,0.],]
2970                    if np.any(dtau%.5) and '1/2' in SSGData['modSymb']:
2971                        if '(xy)' in siteSym:
2972                            CSI[0] = [[1,0,0],[1,0,0],[2,0,0], [1,0,0],[1,0,0],[2,0,0]]
2973                            if dT:
2974                                CSI[1][3:] = [[1./dT,0.,0.],[1./dT,0.,0.],[-dT,0.,0.]]
2975                            else:
2976                                CSI[1][3:] = [0.,0.,0.],[0.,0.,0.],[0.,0.,0.]
2977                    if '(xy)' in siteSym or '(+-0)' in siteSym:
2978                        mul = 1
2979                        if '(+-0)' in siteSym:
2980                            mul = -1
2981                        if np.allclose(dM[0,0,:],dMT[1,0,:]):
2982                            CSI[0][3:5] = [[11,0,0],[11,0,0]]
2983                            CSI[1][3:5] = [[1.,0,0],[mul,0,0]]
2984                            msc[3:5] = 0
2985                        if np.allclose(dM[0,3,:],dMT[0,4,:]):
2986                            CSI[0][:2] = [[12,0,0],[12,0,0]]
2987                            CSI[1][:2] = [[1.,0,0],[mul,0,0]]
2988                            msc[:2] = 0
2989                MSC &= msc
2990                if debug: print (SSMT2text(ssop).replace(' ',''),sdet,ssdet,epsinv,msc)
2991            n = -1
2992            if debug: print (MSC)
2993            for i,M in enumerate(MSC):
2994                if M:
2995                    n += 1
2996                    CSI[0][i][0] = n+1
2997                    CSI[1][i][0] = 1.0
2998
2999        return list(CSI),dM,dMTP
3000       
3001    if debug: print ('super space group: '+SSGData['SSpGrp'])
3002    xyz = np.array(XYZ)%1.
3003    SGOps = copy.deepcopy(SGData['SGOps'])
3004    laue = SGData['SGLaue']
3005    siteSym = SytSym(XYZ,SGData)[0].strip()
3006    if debug: print ('siteSym: '+siteSym)
3007    SSGOps = copy.deepcopy(SSGData['SSGOps'])
3008    #expand ops to include inversions if any
3009    if SGData['SGInv'] and not SGData['SGFixed']:
3010        for op,sop in zip(SGData['SGOps'],SSGData['SSGOps']):
3011            SGOps.append([-op[0],-op[1]%1.])
3012            SSGOps.append([-sop[0],-sop[1]%1.])
3013    #build set of sym ops around special position       
3014    SSop = []
3015    Sop = []
3016    Sdtau = []
3017    for iop,Op in enumerate(SGOps):         
3018        nxyz = (np.inner(Op[0],xyz)+Op[1])%1.
3019        if np.allclose(xyz,nxyz,1.e-4) and iop and MT2text(Op).replace(' ','') != '-X,-Y,-Z':
3020            SSop.append(SSGOps[iop])
3021            Sop.append(SGOps[iop])
3022            ssopinv = nl.inv(SSGOps[iop][0])
3023            mst = ssopinv[3][:3]
3024            epsinv = ssopinv[3][3]
3025            Sdtau.append(np.sum(mst*(XYZ-SGOps[iop][1])-epsinv*SSGOps[iop][1][3]))
3026    SdIndx = np.argsort(np.array(Sdtau))     # just to do in sensible order
3027    if debug: print ('special pos super operators: ',[SSMT2text(ss).replace(' ','') for ss in SSop])
3028    #setup displacement arrays
3029    tau = np.linspace(-1,1,49,True)
3030    #make modulation arrays - one parameter at a time
3031    if Stype == 'Sfrac':
3032        CSI,dF,dFTP = DoFrac()
3033    elif Stype == 'Spos':
3034        CSI,dF,dFTP = DoXYZ()
3035        CSI[0] = orderParms(CSI[0])
3036    elif Stype == 'Sadp':
3037        CSI,dF,dFTP = DoUij()
3038        CSI[0] = orderParms(CSI[0]) 
3039    elif Stype == 'Smag':
3040        CSI,dF,dFTP = DoMag()
3041
3042    if debug:
3043        return CSI,dF,dFTP
3044    else:
3045        return CSI,[],[]
3046   
3047def MustrainNames(SGData):
3048    'Needs a doc string'
3049    laue = SGData['SGLaue']
3050    uniq = SGData['SGUniq']
3051    if laue in ['m3','m3m']:
3052        return ['S400','S220']
3053    elif laue in ['6/m','6/mmm','3m1','3']:
3054        return ['S400','S004','S202']
3055    elif laue in ['31m',]:
3056        return ['S400','S004','S202','S301']
3057    elif laue in ['3R','3mR']:
3058        return ['S400','S220','S310','S211']
3059    elif laue in ['4/m','4/mmm']:
3060        return ['S400','S004','S220','S022']
3061    elif laue in ['mmm']:
3062        return ['S400','S040','S004','S220','S202','S022']
3063    elif laue in ['2/m']:
3064        SHKL = ['S400','S040','S004','S220','S202','S022']
3065        if uniq == 'a':
3066            SHKL += ['S013','S031','S211']
3067        elif uniq == 'b':
3068            SHKL += ['S301','S103','S121']
3069        elif uniq == 'c':
3070            SHKL += ['S130','S310','S112']
3071        return SHKL
3072    else:
3073        SHKL = ['S400','S040','S004','S220','S202','S022']
3074        SHKL += ['S310','S103','S031','S130','S301','S013']
3075        SHKL += ['S211','S121','S112']
3076        return SHKL
3077       
3078def HStrainVals(HSvals,SGData):
3079    laue = SGData['SGLaue']
3080    uniq = SGData['SGUniq']
3081    DIJ = np.zeros(6)
3082    if laue in ['m3','m3m']:
3083        DIJ[:3] = [HSvals[0],HSvals[0],HSvals[0]]
3084    elif laue in ['6/m','6/mmm','3m1','31m','3']:
3085        DIJ[:4] = [HSvals[0],HSvals[0],HSvals[1],HSvals[0]]
3086    elif laue in ['3R','3mR']:
3087        DIJ = [HSvals[0],HSvals[0],HSvals[0],HSvals[1],HSvals[1],HSvals[1]]
3088    elif laue in ['4/m','4/mmm']:
3089        DIJ[:3] = [HSvals[0],HSvals[0],HSvals[1]]
3090    elif laue in ['mmm']:
3091        DIJ[:3] = [HSvals[0],HSvals[1],HSvals[2]]
3092    elif laue in ['2/m']:
3093        DIJ[:3] = [HSvals[0],HSvals[1],HSvals[2]]
3094        if uniq == 'a':
3095            DIJ[5] = HSvals[3]
3096        elif uniq == 'b':
3097            DIJ[4] = HSvals[3]
3098        elif uniq == 'c':
3099            DIJ[3] = HSvals[3]
3100    else:
3101        DIJ = [HSvals[0],HSvals[1],HSvals[2],HSvals[3],HSvals[4],HSvals[5]]
3102    return DIJ
3103
3104def HStrainNames(SGData):
3105    'Needs a doc string'
3106    laue = SGData['SGLaue']
3107    uniq = SGData['SGUniq']
3108    if laue in ['m3','m3m']:
3109        return ['D11','eA']         #add cubic strain term
3110    elif laue in ['6/m','6/mmm','3m1','31m','3']:
3111        return ['D11','D33']
3112    elif laue in ['3R','3mR']:
3113        return ['D11','D12']
3114    elif laue in ['4/m','4/mmm']:
3115        return ['D11','D33']
3116    elif laue in ['mmm']:
3117        return ['D11','D22','D33']
3118    elif laue in ['2/m']:
3119        Dij = ['D11','D22','D33']
3120        if uniq == 'a':
3121            Dij += ['D23']
3122        elif uniq == 'b':
3123            Dij += ['D13']
3124        elif uniq == 'c':
3125            Dij += ['D12']
3126        return Dij
3127    else:
3128        Dij = ['D11','D22','D33','D12','D13','D23']
3129        return Dij
3130   
3131def MustrainCoeff(HKL,SGData):
3132    'Needs a doc string'
3133    #NB: order of terms is the same as returned by MustrainNames
3134    laue = SGData['SGLaue']
3135    uniq = SGData['SGUniq']
3136    h,k,l = HKL
3137    Strm = []
3138    if laue in ['m3','m3m']:
3139        Strm.append(h**4+k**4+l**4)
3140        Strm.append(3.0*((h*k)**2+(h*l)**2+(k*l)**2))
3141    elif laue in ['6/m','6/mmm','3m1','3']:
3142        Strm.append(h**4+k**4+2.0*k*h**3+2.0*h*k**3+3.0*(h*k)**2)
3143        Strm.append(l**4)
3144        Strm.append(3.0*((h*l)**2+(k*l)**2+h*k*l**2))
3145    elif laue in ['31m',]:
3146        Strm.append(h**4+k**4+2.0*k*h**3+2.0*h*k**3+3.0*(h*k)**2)
3147        Strm.append(l**4)
3148        Strm.append(3.0*((h*l)**2+(k*l)**2+h*k*l**2))
3149        Strm.append(4.0*l*h**3)
3150    elif laue in ['3R','3mR']:
3151        Strm.append(h**4+k**4+l**4)
3152        Strm.append(3.0*((h*k)**2+(h*l)**2+(k*l)**2))
3153        Strm.append(2.0*(h*l**3+l*k**3+k*h**3)+2.0*(l*h**3+k*l**3+l*k**3))
3154        Strm.append(4.0*(k*l*h**2+h*l*k**2+h*k*l**2))
3155    elif laue in ['4/m','4/mmm']:
3156        Strm.append(h**4+k**4)
3157        Strm.append(l**4)
3158        Strm.append(3.0*(h*k)**2)
3159        Strm.append(3.0*((h*l)**2+(k*l)**2))
3160    elif laue in ['mmm']:
3161        Strm.append(h**4)
3162        Strm.append(k**4)
3163        Strm.append(l**4)
3164        Strm.append(3.0*(h*k)**2)
3165        Strm.append(3.0*(h*l)**2)
3166        Strm.append(3.0*(k*l)**2)
3167    elif laue in ['2/m']:
3168        Strm.append(h**4)
3169        Strm.append(k**4)
3170        Strm.append(l**4)
3171        Strm.append(3.0*(h*k)**2)
3172        Strm.append(3.0*(h*l)**2)
3173        Strm.append(3.0*(k*l)**2)
3174        if uniq == 'a':
3175            Strm.append(2.0*k*l**3)
3176            Strm.append(2.0*l*k**3)
3177            Strm.append(4.0*k*l*h**2)
3178        elif uniq == 'b':
3179            Strm.append(2.0*l*h**3)
3180            Strm.append(2.0*h*l**3)
3181            Strm.append(4.0*h*l*k**2)
3182        elif uniq == 'c':
3183            Strm.append(2.0*h*k**3)
3184            Strm.append(2.0*k*h**3)
3185            Strm.append(4.0*h*k*l**2)
3186    else:
3187        Strm.append(h**4)
3188        Strm.append(k**4)
3189        Strm.append(l**4)
3190        Strm.append(3.0*(h*k)**2)
3191        Strm.append(3.0*(h*l)**2)
3192        Strm.append(3.0*(k*l)**2)
3193        Strm.append(2.0*k*h**3)
3194        Strm.append(2.0*h*l**3)
3195        Strm.append(2.0*l*k**3)
3196        Strm.append(2.0*h*k**3)
3197        Strm.append(2.0*l*h**3)
3198        Strm.append(2.0*k*l**3)
3199        Strm.append(4.0*k*l*h**2)
3200        Strm.append(4.0*h*l*k**2)
3201        Strm.append(4.0*k*h*l**2)
3202    return Strm
3203
3204def MuShklMean(SGData,Amat,Shkl):
3205   
3206    def genMustrain(xyz,Shkl):
3207        uvw = np.inner(Amat.T,xyz)
3208        Strm = np.array(MustrainCoeff(uvw,SGData))
3209        Sum = np.sum(np.multiply(Shkl,Strm))
3210        Sum = np.where(Sum > 0.01,Sum,0.01)
3211        Sum = np.sqrt(Sum)
3212        return Sum*xyz
3213       
3214    PHI = np.linspace(0.,360.,30,True)
3215    PSI = np.linspace(0.,180.,30,True)
3216    X = np.outer(npcosd(PHI),npsind(PSI))
3217    Y = np.outer(npsind(PHI),npsind(PSI))
3218    Z = np.outer(np.ones(np.size(PHI)),npcosd(PSI))
3219    XYZ = np.dstack((X,Y,Z))
3220    XYZ = np.nan_to_num(np.apply_along_axis(genMustrain,2,XYZ,Shkl))
3221    return np.sqrt(np.sum(XYZ**2)/900.)
3222   
3223def Muiso2Shkl(muiso,SGData,cell):
3224    "this is to convert isotropic mustrain to generalized Shkls"
3225    import GSASIIlattice as G2lat
3226    A = G2lat.cell2AB(cell)[0]
3227   
3228    def minMus(Shkl,muiso,H,SGData,A):
3229        U = np.inner(A.T,H)
3230        S = np.array(MustrainCoeff(U,SGData))
3231        nS = S.shape[0]
3232        Sum = np.sqrt(np.sum(np.multiply(S,Shkl[:nS,nxs]),axis=0))
3233        rad = np.sqrt(np.sum((Sum[:,nxs]*H)**2,axis=1))
3234        return (muiso-rad)**2
3235       
3236    laue = SGData['SGLaue']
3237    PHI = np.linspace(0.,360.,60,True)
3238    PSI = np.linspace(0.,180.,60,True)
3239    X = np.outer(npsind(PHI),npsind(PSI))
3240    Y = np.outer(npcosd(PHI),npsind(PSI))
3241    Z = np.outer(np.ones(np.size(PHI)),npcosd(PSI))
3242    HKL = np.dstack((X,Y,Z))
3243    if laue in ['m3','m3m']:
3244        S0 = [1000.,1000.]
3245    elif laue in ['6/m','6/mmm']:
3246        S0 = [1000.,1000.,1000.]
3247    elif laue in ['31m','3','3m1']:
3248        S0 = [1000.,1000.,1000.]
3249    elif laue in ['3R','3mR']:
3250        S0 = [1000.,1000.,1000.,1000.]
3251    elif laue in ['4/m','4/mmm']:
3252        S0 = [1000.,1000.,1000.,1000.]
3253    elif laue in ['mmm']:
3254        S0 = [1000.,1000.,1000.,1000.,1000.,1000.]
3255    elif laue in ['2/m']:
3256        S0 = [1000.,1000.,1000.,0.,0.,0.,0.,0.,0.]
3257    else:
3258        S0 = [1000.,1000.,1000.,1000.,1000., 1000.,1000.,1000.,1000.,1000., 
3259            1000.,1000.,0.,0.,0.]
3260    S0 = np.array(S0)
3261    HKL = np.reshape(HKL,(-1,3))
3262    result = so.leastsq(minMus,S0,(np.ones(HKL.shape[0])*muiso,HKL,SGData,A))
3263    return result[0]
3264       
3265def PackRot(SGOps):
3266    IRT = []
3267    for ops in SGOps:
3268        M = ops[0]
3269        irt = 0
3270        for j in range(2,-1,-1):
3271            for k in range(2,-1,-1):
3272                irt *= 3
3273                irt += M[k][j]
3274        IRT.append(int(irt))
3275    return IRT
3276       
3277def SytSym(XYZ,SGData):
3278    '''
3279    Generates the number of equivalent positions and a site symmetry code for a specified coordinate and space group
3280
3281    :param XYZ: an array, tuple or list containing 3 elements: x, y & z
3282    :param SGData: from SpcGroup
3283    :Returns: a four element tuple:
3284
3285     * The 1st element is a code for the site symmetry (see GetKNsym)
3286     * The 2nd element is the site multiplicity
3287     * Ndup number of overlapping operators
3288     * dupDir Dict - dictionary of overlapping operators
3289
3290    '''
3291    if SGData['SpGrp'] == 'P 1':
3292        return '1',1,1,{}
3293    Mult = 1
3294    Isym = 0
3295    if SGData['SGLaue'] in ['3','3m1','31m','6/m','6/mmm']:
3296        Isym = 1073741824
3297    Jdup = 0
3298    Ndup = 0
3299    dupDir = {}
3300    inv = SGData['SGInv']+1
3301    icen = SGData['SGCen']
3302    Ncen = len(icen)
3303    if SGData['SGFixed']:       #already in list of operators
3304        inv = 1
3305    if SGData['SGGray'] and Ncen > 1: Ncen //= 2
3306    Xeqv = list(GenAtom(np.array(XYZ)%1.,SGData,True))
3307#    for xeqv in Xeqv:   print(xeqv)
3308    IRT = PackRot(SGData['SGOps'])
3309    L = -1
3310    for ic,cen in enumerate(icen[:Ncen]):
3311        for invers in range(int(inv)):
3312            for io,ops in enumerate(SGData['SGOps']):
3313                irtx = (1-2*invers)*IRT[io]
3314                L += 1
3315                if not Xeqv[L][1]:
3316                    Ndup = io
3317                    Jdup += 1
3318                    jx = GetOprPtrNumber(str(irtx))   #[KN table no,op name,KNsym ptr]
3319                    if jx < 39:
3320                        px = GetOprName(str(irtx))
3321                        if Xeqv[L][-1] < 0:
3322                            if '(' in px:
3323                                px = px.split('(')
3324                                px[0] += "'"
3325                                px = '('.join(px)
3326                            else:   
3327                                px += "'"
3328                        dupDir[px] = L
3329                        Isym += 2**(jx-1)
3330    if Isym == 1073741824: Isym = 0
3331    try:
3332        Mult = len(SGData['SGOps'])*Ncen*inv//Jdup
3333    except: # patch because Jdup is not getting incremented for most atoms!
3334        Mult = 0
3335       
3336    return GetKNsym(str(Isym)),Mult,Ndup,dupDir
3337   
3338def MagSytSym(SytSym,dupDir,SGData):
3339    '''
3340    site sym operations: 1,-1,2,3,-3,4,-4,6,-6,m need to be marked if spin inversion
3341    '''
3342    SGData['GenSym'],SGData['GenFlg'] = GetGenSym(SGData)[:2]
3343#    print('SGPtGrp',SGData['SGPtGrp'],'SytSym',SytSym,'MagSpGrp',SGData['MagSpGrp'])
3344#    print('dupDir',dupDir)
3345    SplitSytSym = SytSym.split('(')
3346    if SGData['SGGray']:
3347        return SytSym+"1'"
3348    if SytSym in ['1','-1','2','3','6','m']:       #axial position
3349        return SytSym
3350    if SplitSytSym[0] == SGData['SGPtGrp']:     #simple cases
3351        try:
3352            MagSytSym = SGData['MagSpGrp'].split()[1]
3353        except IndexError:
3354            MagSytSym = SGData['MagSpGrp'][1:].strip("1'")
3355        if len(SplitSytSym) > 1:
3356            MagSytSym += '('+SplitSytSym[1]
3357        return MagSytSym
3358    if len(dupDir) == 1:
3359        return list(dupDir.keys())[0]
3360   
3361   
3362    if '2/m' in SytSym:         #done I think; last 2wo might be not needed
3363        ops = {'(x)':['2(x)','m(x)'],'(y)':['2(y)','m(y)'],'(z)':['2(z)','m(z)'],
3364               '(100)':['2(100)','m(100)'],'(010)':['2(010)','m(010)'],'(001)':['2(001)','m(001)'],
3365               '(120)':['2(120)','m(120)'],'(210)':['2(210)','m(210)'],'(+-0)':['2(+-0)','m(+-0)'],
3366               '(110)':['2(110)','m(110)']}
3367   
3368    elif '4/mmm' in SytSym:
3369        ops = {'(x)':['4(x)','m(x)','m(y)','m(0+-)'],   #m(0+-) for cubic m3m?
3370               '(y)':['4(y)','m(y)','m(z)','m(+0-)'],   #m(+0-)
3371               '(z)':['4(z)','m(z)','m(x)','m(+-0)']}   #m(+-0)
3372    elif '4mm' in SytSym:
3373        ops = {'(x)':['4(x)','m(y)','m(yz)'],'(y)':['4(y)','m(z)','m(xz)'],'(z)':['4(z)','m(x)','m(110)']}
3374    elif '422' in SytSym:
3375        ops = {'(x)':['4(x)','2(y)','2(yz)'],'(y)':['4(y)','2(z)','2(xz)'],'(z)':['4(z)','2(x)','2(110)']}
3376    elif '-4m2' in SytSym:
3377        ops = {'(x)':['-4(x)','m(x)','2(yz)'],'(y)':['-4(y)','m(y)','2(xz)'],'(z)':['-4(z)','m(z)','2(110)']}
3378    elif '-42m' in SytSym:
3379        ops = {'(x)':['-4(x)','2(y)','m(yz)'],'(y)':['-4(y)','2(z)','m(xz)'],'(z)':['-4(z)','2(x)','m(110)']}
3380    elif '-4' in SytSym:
3381        ops = {'(x)':['-4(x)',],'(y)':['-4(y)',],'(z)':['-4(z)',],}
3382    elif '4' in SytSym:
3383        ops = {'(x)':['4(x)',],'(y)':['4(y)',],'(z)':['4(z)',],}
3384
3385    elif '222' in SytSym:
3386        ops = {'':['2(x)','2(y)','2(z)'],
3387                   '(x)':['2(y)','2(z)','2(x)'],'(y)':['2(x)','2(z)','2(y)'],'(z)':['2(x)','2(y)','2(z)'],
3388                   '(100)':['2(z)','2(100)','2(120)',],'(010)':['2(z)','2(010)','2(210)',],
3389                   '(110)':['2(z)','2(110)','2(+-0)',],}
3390    elif 'mm2' in SytSym:
3391        ops = {'(x)':['m(y)','m(z)','2(x)'],'(y)':['m(x)','m(z)','2(y)'],'(z)':['m(x)','m(y)','2(z)'],
3392               '(xy)':['m(+-0)','m(z)','2(110)'],'(yz)':['m(0+-)','m(xz)','2(yz)'],     #not 2(xy)!
3393               '(xz)':['m(+0-)','m(y)','2(xz)'],'(z100)':['m(100)','m(120)','2(z)'],
3394               '(z010)':['m(010)','m(210)','2(z)'],'(z110)':['m(110)','m(+-0)','2(z)'],
3395               '(+-0)':[ 'm(110)','m(z)','2(+-0)'],'(d100)':['m(yz)','m(0+-)','2(xz)'],
3396               '(d010)':['m(xz)','m(+0-)','2(y)'],'(d001)':['m(110)','m(+-0)','2(z)'],
3397               '(210)':['m(z)','m(010)','2(210)'],'(120)':['m(z)','m(100)','2(120)'],
3398               '(100)':['m(z)','m(120)','2(100)',],'(010)':['m(z)','m(210)','2(010)',],
3399               '(110)':['m(z)','m(+-0)','2(110)',],}
3400    elif 'mmm' in SytSym:
3401        ops = {'':['m(x)','m(y)','m(z)'],
3402                   '(100)':['m(z)','m(100)','m(120)',],'(010)':['m(z)','m(010)','m(210)',],
3403                   '(110)':['m(z)','m(110)','m(+-0)',],
3404                   '(x)':['m(x)','m(y)','m(z)'],'(y)':['m(x)','m(y)','m(z)'],'(z)':['m(x)','m(y)','m(z)'],}
3405       
3406    elif '32' in SytSym:
3407        ops = {'(120)':['3','2(120)',],'(100)':['3','2(100)'],'(111)':['3(111)','2(x)']}
3408    elif '23' in SytSym:
3409        ops = {'':['2(x)','3(111)']}
3410    elif 'm3' in SytSym:
3411        ops = {'(100)':['(+-0)',],'(+--)':[],'(-+-)':[],'(--+)':[]}
3412    elif '3m' in SytSym:
3413        ops = {'(111)':['3(111)','m(+-0)',],'(+--)':['3(+--)','m(0+-)',],
3414               '(-+-)':['3(-+-)','m(+0-)',],'(--+)':['3(--+)','m(+-0)',],
3415               '(100)':['3','m(100)'],'(120)':['3','m(210)',]}
3416   
3417    if SytSym.split('(')[0] in ['6/m','6mm','-6m2','622','-6','-3','-3m','-43m',]:     #not simple cases
3418        MagSytSym = SytSym
3419        if "-1'" in dupDir:
3420            if '-6' in SytSym:
3421                MagSytSym = MagSytSym.replace('-6',"-6'")
3422            elif '-3m' in SytSym:
3423                MagSytSym = MagSytSym.replace('-3m',"-3'm'")
3424            elif '-3' in SytSym:
3425                MagSytSym = MagSytSym.replace('-3',"-3'")
3426        elif '-6m2' in SytSym:
3427            if "m'(110)" in dupDir:
3428                MagSytSym = "-6m'2'("+SytSym.split('(')[1]
3429        elif '6/m' in SytSym:
3430            if "m'(z)" in dupDir:
3431                MagSytSym = "6'/m'"
3432        elif '6mm' in SytSym:
3433            if "m'(110)" in dupDir:
3434                MagSytSym = "6'm'm"
3435        elif '-43m' in SytSym:
3436            if "m'(110)" in dupDir:
3437                MagSytSym = "-43m'"
3438        return MagSytSym
3439    try:
3440        axis = '('+SytSym.split('(')[1]
3441    except IndexError:
3442        axis = ''
3443    MagSytSym = ''
3444    for m in ops[axis]:
3445        if m in dupDir:
3446            MagSytSym += m.split('(')[0]
3447        else:
3448            MagSytSym += m.split('(')[0]+"'"
3449        if '2/m' in SytSym and '2' in m:
3450            MagSytSym += '/'
3451        if '-3/m' in SytSym:
3452            MagSytSym = '-'+MagSytSym
3453       
3454    MagSytSym += axis
3455# some exceptions & special rules         
3456    if MagSytSym == "4'/m'm'm'": MagSytSym = "4/m'm'm'"
3457    return MagSytSym
3458   
3459#    if len(GenSym) == 3:
3460#        if SGSpin[1] < 0:
3461#            if 'mm2' in SytSym:
3462#                MagSytSym = "m'm'2"+'('+SplitSytSym[1]
3463#            else:   #bad rule for I41/a
3464#                MagSytSym = SplitSytSym[0]+"'"
3465#                if len(SplitSytSym) > 1:
3466#                    MagSytSym += '('+SplitSytSym[1]
3467#        else:
3468#            MagSytSym = SytSym
3469#        if len(SplitSytSym) >1:
3470#            if "-4'"+'('+SplitSytSym[1] in dupDir:
3471#                MagSytSym = MagSytSym.replace('-4',"-4'")
3472#            if "-6'"+'('+SplitSytSym[1] in dupDir:
3473#                MagSytSym = MagSytSym.replace('-6',"-6'")
3474#        return MagSytSym
3475#           
3476    return SytSym
3477
3478def UpdateSytSym(Phase):
3479    ''' Update site symmetry/site multiplicity after space group/BNS lattice change
3480    '''
3481    generalData = Phase['General']
3482    SGData = generalData['SGData']
3483    Atoms = Phase['Atoms']
3484    cx,ct,cs,cia = generalData['AtomPtrs']
3485    for atom in Atoms:
3486        XYZ = atom[cx:cx+3]
3487        sytsym,Mult = SytSym(XYZ,SGData)[:2]
3488        sytSym,Mul,Nop,dupDir = SytSym(XYZ,SGData)
3489        atom[cs] = sytsym
3490        if generalData['Type'] == 'magnetic':
3491            magSytSym = MagSytSym(sytSym,dupDir,SGData)
3492            atom[cs] = magSytSym
3493        atom[cs+1] = Mult
3494    return
3495   
3496def ElemPosition(SGData):
3497    ''' Under development.
3498    Object here is to return a list of symmetry element types and locations suitable
3499    for say drawing them.
3500    So far I have the element type... getting all possible locations without lookup may be impossible!
3501    '''
3502    Inv = SGData['SGInv']
3503    eleSym = {-3:['','-1'],-2:['',-6],-1:['2','-4'],0:['3','-3'],1:['4','m'],2:['6',''],3:['1','']}
3504    # get operators & expand if centrosymmetric
3505    SymElements = []
3506    Ops = SGData['SGOps']
3507    opM = np.array([op[0].T for op in Ops])
3508    opT = np.array([op[1] for op in Ops])
3509    if Inv:
3510        opM = np.concatenate((opM,-opM))
3511        opT = np.concatenate((opT,-opT))
3512    opMT = list(zip(opM,opT))
3513    for M,T in opMT[1:]:        #skip I
3514        Dt = int(nl.det(M))
3515        Tr = int(np.trace(M))
3516        Dt = -(Dt-1)//2
3517        Es = eleSym[Tr][Dt]
3518        if Dt:              #rotation-inversion
3519            I = np.eye(3)
3520            if Tr == 1:     #mirrors/glides
3521                if np.any(T):       #glide
3522                    M2 = np.inner(M,M)
3523                    MT = np.inner(M,T)+T
3524                    print ('glide',Es,MT)
3525                    print (M2)
3526                else:               #mirror
3527                    print ('mirror',Es,T)
3528                    print (I-M)
3529                X = [-1,-1,-1]
3530            elif Tr == -3:  # pure inversion
3531                X = np.inner(nl.inv(I-M),T)
3532                print ('inversion',Es,X)
3533            else:           #other rotation-inversion
3534                M2 = np.inner(M,M)
3535                MT = np.inner(M,T)+T
3536                print ('rot-inv',Es,MT)
3537                print (M2)
3538                X = [-1,-1,-1]
3539        else:               #rotations
3540            print ('rotation',Es)
3541            X = [-1,-1,-1]
3542        SymElements.append([Es,X])
3543       
3544    return SymElements
3545   
3546def ApplyStringOps(A,SGData,X,Uij=[]):
3547    'Needs a doc string'
3548    SGOps = SGData['SGOps']
3549    SGCen = SGData['SGCen']
3550    Ax = A.split('+')
3551    Ax[0] = int(Ax[0])
3552    iC = 1
3553    if Ax[0] < 0:
3554        iC = -1
3555    Ax[0] = abs(Ax[0])
3556    nA = Ax[0]%100-1
3557    cA = Ax[0]//100
3558    Cen = SGCen[cA]
3559    M,T = SGOps[nA]
3560    if len(Ax)>1:
3561        cellA = Ax[1].split(',')
3562        cellA = np.array([int(a) for a in cellA])
3563    else:
3564        cellA = np.zeros(3)
3565    newX = Cen+iC*(np.inner(M,X).T+T)+cellA
3566    if len(Uij):
3567        U = Uij2U(Uij)
3568        U = np.inner(M,np.inner(U,M).T)
3569        newUij = U2Uij(U)
3570        return [newX,newUij]
3571    else:
3572        return newX
3573       
3574def ApplyStringOpsMom(A,SGData,SSGData,Mom):
3575    '''Applies string operations to modulated magnetic moment components used in drawing
3576    Drawing matches Bilbao MVISUALIZE
3577    '''
3578    SGOps = SGData['SGOps']
3579    Ax = A.split('+')
3580    Ax[0] = int(Ax[0])
3581    iAx = abs(Ax[0])
3582    nA = iAx%100-1
3583    if SGData['SGInv'] and not SGData['SGFixed']:
3584        nC = 2*len(SGOps)*(iAx//100)
3585    else:
3586        nC = len(SGOps)*(iAx//100)
3587    NA = nA
3588    if Ax[0] < 0:
3589        NA += len(SGOps)
3590    M,T = SGOps[nA]
3591    newMom = np.inner(Mom,M).T*SGData['SpnFlp'][NA+nC]
3592    if SSGData is not None:
3593        if SSGData['SSGCen'][iAx//100][3]:     #flip spin for BNS centered atoms
3594            newMom *= -1.
3595    return newMom
3596       
3597def StringOpsProd(A,B,SGData):
3598    """
3599    Find A*B where A & B are in strings '-' + '100*c+n' + '+ijk'
3600    where '-' indicates inversion, c(>0) is the cell centering operator,
3601    n is operator number from SgOps and ijk are unit cell translations (each may be <0).
3602    Should return resultant string - C. SGData - dictionary using entries:
3603
3604       *  'SGCen': cell centering vectors [0,0,0] at least
3605