source: trunk/exports/G2cif.py @ 1038

Last change on this file since 1038 was 1038, checked in by vondreele, 8 years ago

more work on residuals & cif files

  • Property svn:eol-style set to native
File size: 66.5 KB
Line 
1#!/usr/bin/env python
2# -*- coding: utf-8 -*-
3#G2cif
4########### SVN repository information ###################
5# $Date: 2013-07-22 20:57:37 -0500 (Mon, 22 Jul 2013) $
6# $Author: toby $
7# $Revision: 1006 $
8# $URL: https://subversion.xray.aps.anl.gov/pyGSAS/trunk/exports/G2cif.py $
9# $Id: G2cif.py 1006 2013-07-23 01:57:37Z toby $
10########### SVN repository information ###################
11'''Code to export a GSAS-II project as a CIF
12The heavy lifting is done in method export
13'''
14
15# TODO: need a mechanism for editing of instrument names, bond pub flags, templates,...
16
17import datetime as dt
18import os.path
19import sys
20import numpy as np
21import wx
22import GSASIIpath
23GSASIIpath.SetVersionNumber("$Revision: 1006 $")
24import GSASIIIO as G2IO
25#reload(G2IO)
26import GSASIIgrid as G2gd
27import GSASIIstrIO as G2stIO
28#reload(G2stIO)
29#import GSASIImapvars as G2mv
30import GSASIImath as G2mth
31#reload(G2mth)
32import GSASIIlattice as G2lat
33import GSASIIspc as G2spc
34#reload(G2spc)
35import GSASIIphsGUI as G2pg
36#reload(G2pg)
37import GSASIIstrMain as G2stMn
38reload(G2stMn)
39
40DEBUG = False    #True to skip printing of reflection/powder profile lists
41
42def getCallerDocString(): # for development
43    "Return the calling function's doc string"
44    import inspect as ins
45    for item in ins.stack()[1][0].f_code.co_consts:
46        if type(item) is str:
47            return item
48    else:
49        return '?'
50
51class ExportCIF(G2IO.ExportBaseclass):
52    def __init__(self,G2frame):
53        super(self.__class__,self).__init__( # fancy way to say <parentclass>.__init__
54            G2frame=G2frame,
55            formatName = 'full CIF',
56            extension='.cif',
57            longFormatName = 'Export project as CIF'
58            )
59        self.author = ''
60
61    def export(self,mode='full'):
62        '''Export a CIF
63
64        :param str mode: "full" (default) to create a complete CIF of project,
65          "simple" for a simple CIF with only coordinates
66        '''
67   
68        def openCIF(filnam):
69            if DEBUG:
70                self.fp = sys.stdout
71            else:
72                self.fp = open(filnam,'w')
73
74        def closeCIF():
75            if not DEBUG:
76                self.fp.close()
77           
78        def WriteCIFitem(name,value=''):
79            if value:
80                if "\n" in value or len(value)> 70:
81                    if name.strip(): self.fp.write(name+'\n')
82                    self.fp.write('; '+value+'\n')
83                    self.fp.write('; '+'\n')
84                elif " " in value:
85                    if len(name)+len(value) > 65:
86                        self.fp.write(name + '\n   ' + '"' + str(value) + '"'+'\n')
87                    else:
88                        self.fp.write(name + '  ' + '"' + str(value) + '"'+'\n')
89                else:
90                    if len(name)+len(value) > 65:
91                        self.fp.write(name+'\n   ' + value+'\n')
92                    else:
93                        self.fp.write(name+'  ' + value+'\n')
94            else:
95                self.fp.write(name+'\n')
96
97        def WriteAudit():
98            WriteCIFitem('_audit_creation_method',
99                         'created in GSAS-II')
100            WriteCIFitem('_audit_creation_date',self.CIFdate)
101            if self.author:
102                WriteCIFitem('_audit_author_name',self.author)
103            WriteCIFitem('_audit_update_record',
104                         self.CIFdate+'  Initial software-generated CIF')
105
106        def WriteOverall():
107            '''Write out overall refinement information.
108
109            More could be done here, but this is a good start.
110            '''
111            WriteCIFitem('_pd_proc_info_datetime', self.CIFdate)
112            WriteCIFitem('_pd_calc_method', 'Rietveld Refinement')
113            #WriteCIFitem('_refine_ls_shift/su_max',DAT1)
114            #WriteCIFitem('_refine_ls_shift/su_mean',DAT2)
115            WriteCIFitem('_computing_structure_refinement','GSAS-II (Toby & Von Dreele, 2013)')
116            try:
117                vars = str(len(self.OverallParms['Covariance']['varyList']))
118            except:
119                vars = '?'
120            WriteCIFitem('_refine_ls_number_parameters',vars)
121            try:
122                GOF = G2mth.ValEsd(self.OverallParms['Covariance']['Rvals']['GOF'],-0.009)
123            except:
124                GOF = '?'
125            WriteCIFitem('_refine_ls_goodness_of_fit_all',GOF)
126
127            # get restraint info
128            # restraintDict = self.OverallParms.get('Restraints',{})
129            # for i in  self.OverallParms['Constraints']:
130            #     print i
131            #     for j in self.OverallParms['Constraints'][i]:
132            #         print j
133            #WriteCIFitem('_refine_ls_number_restraints',TEXT)
134            # other things to consider reporting
135            # _refine_ls_number_reflns
136            # _refine_ls_goodness_of_fit_obs
137            # _refine_ls_wR_factor_obs
138            # _refine_ls_restrained_S_all
139            # _refine_ls_restrained_S_obs
140
141            # include an overall profile r-factor, if there is more than one powder histogram
142            R = '%.5f'%(self.OverallParms['Covariance']['Rvals']['Rwp']/100.)
143            WriteCIFitem('\n# OVERALL WEIGHTED R-FACTOR')
144            WriteCIFitem('_refine_ls_wR_factor_obs',R)
145                # _refine_ls_R_factor_all
146                # _refine_ls_R_factor_obs               
147            WriteCIFitem('_refine_ls_matrix_type','full')
148            #WriteCIFitem('_refine_ls_matrix_type','userblocks')
149
150        def WritePubTemplate():
151            '''TODO: insert the publication template ``template_publ.cif`` or some modified
152            version for this project. Store this in the GPX file?
153            '''
154            print getCallerDocString()
155
156        def WritePhaseTemplate():
157            '''TODO: insert the phase template ``template_phase.cif`` or some modified
158            version for this project
159            '''
160            print getCallerDocString()
161
162        def WritePowderTemplate():
163            '''TODO: insert the phase template ``template_instrument.cif`` or some modified
164            version for this project
165            '''
166            print getCallerDocString()
167
168        def WriteSnglXtalTemplate():
169            '''TODO: insert the single-crystal histogram template
170            for this project
171            '''
172            print getCallerDocString()
173
174        def FormatSH(phasenam):
175            'Format a full spherical harmonics texture description as a string'
176            phasedict = self.Phases[phasenam] # pointer to current phase info           
177            pfx = str(phasedict['pId'])+'::'
178            s = ""
179            textureData = phasedict['General']['SH Texture']   
180            if textureData.get('Order'):
181                s += "Spherical Harmonics correction. Order = "+str(textureData['Order'])
182                s += " Model: " + str(textureData['Model']) + "\n    Orientation angles: "
183                for name in ['omega','chi','phi']:
184                    aname = pfx+'SH '+name
185                    s += name + " = "
186                    sig = self.sigDict.get(aname,-0.09)
187                    s += G2mth.ValEsd(self.parmDict[aname],sig)
188                    s += "; "
189                s += "\n"
190                s1 = "    Coefficients:  "
191                for name in textureData['SH Coeff'][1]:
192                    aname = pfx+name
193                    if len(s1) > 60:
194                        s += s1 + "\n"
195                        s1 = "    "
196                    s1 += aname + ' = '
197                    sig = self.sigDict.get(aname,-0.0009)
198                    s1 += G2mth.ValEsd(self.parmDict[aname],sig)
199                    s1 += "; "
200                s += s1
201            return s
202
203        def FormatHAPpo(phasenam):
204            '''return the March-Dollase/SH correction for every
205            histogram in the current phase formatted into a
206            character string
207            '''
208            phasedict = self.Phases[phasenam] # pointer to current phase info           
209            s = ''
210            for histogram in sorted(phasedict['Histograms']):
211                if histogram.startswith("HKLF"): continue # powder only
212                Histogram = self.Histograms.get(histogram)
213                if not Histogram: continue
214                hapData = phasedict['Histograms'][histogram]
215                if hapData['Pref.Ori.'][0] == 'MD':
216                    aname = str(phasedict['pId'])+':'+str(Histogram['hId'])+':MD'
217                    if self.parmDict.get(aname,1.0) != 1.0: continue
218                    sig = self.sigDict.get(aname,-0.009)
219                    if s != "": s += '\n'
220                    s += 'March-Dollase correction'
221                    if len(self.powderDict) > 1:
222                        s += ', histogram '+str(Histogram['hId']+1)
223                    s += ' coef. = ' + G2mth.ValEsd(self.parmDict[aname],sig)
224                    s += ' axis = ' + str(hapData['Pref.Ori.'][3])
225                else: # must be SH
226                    if s != "": s += '\n'
227                    s += 'Simple spherical harmonic correction'
228                    if len(self.powderDict) > 1:
229                        s += ', histogram '+str(Histogram['hId']+1)
230                    s += ' Order = '+str(hapData['Pref.Ori.'][4])+'\n'
231                    s1 = "    Coefficients:  "
232                    for item in hapData['Pref.Ori.'][5]:
233                        print item
234                        aname = str(phasedict['pId'])+':'+str(Histogram['hId'])+':'+item
235                        print aname
236                        if len(s1) > 60:
237                            s += s1 + "\n"
238                            s1 = "    "
239                        s1 += aname + ' = '
240                        sig = self.sigDict.get(aname,-0.0009)
241                        s1 += G2mth.ValEsd(self.parmDict[aname],sig)
242                        s1 += "; "
243                    s += s1
244            return s
245        def FormatBackground(bkg,hId):
246            '''Display the Background information as a descriptive text string.
247           
248            TODO: this needs to be expanded to show the diffuse peak and
249            Debye term information as well. (Bob)
250
251            :returns: the text description (str)
252            '''
253            hfx = ':'+str(hId)+':'
254            fxn, bkgdict = bkg
255            terms = fxn[2]
256            txt = 'Background function: "'+fxn[0]+'" function with '+str(terms)+' terms:\n'
257            l = "    "
258            for i,v in enumerate(fxn[3:]):
259                name = '%sBack:%d'%(hfx,i)
260                sig = self.sigDict.get(name,-0.009)
261                if len(l) > 60:
262                    txt += l + '\n'
263                    l = '    '
264                l += G2mth.ValEsd(v,sig)+', '
265            txt += l
266            if bkgdict['nDebye']:
267                txt += '\n  Background Debye function parameters: A, R, U:'
268                names = ['A:','R:','U:']
269                for i in range(bkgdict['nDebye']):
270                    txt += '\n    '
271                    for j in range(3):
272                        name = hfx+'Debye'+names[j]+str(i)
273                        sig = self.sigDict.get(name,-0.009)
274                        txt += G2mth.ValEsd(bkgdict['debyeTerms'][i][2*j],sig)+', '
275            if bkgdict['nPeaks']:
276                txt += '\n  Background peak parameters: pos, int, sig, gam:'
277                names = ['pos:','int:','sig:','gam:']
278                for i in range(bkgdict['nPeaks']):
279                    txt += '\n    '
280                    for j in range(4):
281                        name = hfx+'BkPk'+names[j]+str(i)
282                        sig = self.sigDict.get(name,-0.009)
283                        txt += G2mth.ValEsd(bkgdict['peaksList'][i][2*j],sig)+', '
284            return txt
285
286        def FormatInstProfile(instparmdict,hId):
287            '''Format the instrumental profile parameters with a
288            string description. Will only be called on PWDR histograms
289            '''
290            s = ''
291            inst = instparmdict[0]
292            hfx = ':'+str(hId)+':'
293            if 'C' in inst['Type'][0]:
294                s = 'Finger-Cox-Jephcoat function parameters U, V, W, X, Y, SH/L:\n'
295                s += '  peak variance(Gauss) = Utan(Th)^2^+Vtan(Th)+W:\n'
296                s += '  peak HW(Lorentz) = X/cos(Th)+Ytan(Th); SH/L = S/L+H/L\n'
297                s += '  U, V, W in (centideg)^2^, X & Y in centideg\n    '
298                for item in ['U','V','W','X','Y','SH/L']:
299                    name = hfx+item
300                    sig = self.sigDict.get(name,-0.009)
301                    s += G2mth.ValEsd(inst[item][1],sig)+', '                   
302            elif 'T' in inst['Type'][0]:    #to be tested after TOF Rietveld done
303                s = 'Von Dreele-Jorgenson-Windsor function parameters\n'+ \
304                    '   alpha, beta-0, beta-1, beta-q, sig-0, sig-1, sig-q, X, Y:\n    '
305                for item in ['alpha','bet-0','bet-1','bet-q','sig-0','sig-1','sig-q','X','Y']:
306                    name = hfx+item
307                    sig = self.sigDict.get(name,-0.009)
308                    s += G2mth.ValEsd(inst[item][1],sig)+', '
309            return s
310
311        def FormatPhaseProfile(phasenam):
312            '''Format the phase-related profile parameters (size/strain)
313            with a string description.
314            return an empty string or None if there are no
315            powder histograms for this phase.
316            '''
317            s = ''
318            phasedict = self.Phases[phasenam] # pointer to current phase info
319            SGData = phasedict['General'] ['SGData']         
320            for histogram in sorted(phasedict['Histograms']):
321                if histogram.startswith("HKLF"): continue # powder only
322                Histogram = self.Histograms.get(histogram)
323                if not Histogram: continue
324                hapData = phasedict['Histograms'][histogram]
325                pId = phasedict['pId']
326                hId = Histogram['hId']
327                phfx = '%d:%d:'%(pId,hId)
328                size = hapData['Size']
329                mustrain = hapData['Mustrain']
330                hstrain = hapData['HStrain']
331                s = '  Crystallite size model "%s" for %s (microns)\n  '%(size[0],phasenam)
332                names = ['Size;i','Size;mx']
333                if 'uniax' in size[0]:
334                    names = ['Size;i','Size;a','Size;mx']
335                    s += 'anisotropic axis is %s\n  '%(str(size[3]))
336                    s += 'parameters: equatorial size, axial size, G/L mix\n    '
337                    for i,item in enumerate(names):
338                        name = phfx+item
339                        sig = self.sigDict.get(name,-0.009)
340                        s += G2mth.ValEsd(size[1][i],sig)+', '
341                elif 'ellip' in size[0]:
342                    s += 'parameters: S11, S22, S33, S12, S13, S23, G/L mix\n    '
343                    for i in range(6):
344                        name = phfx+'Size:'+str(i)
345                        sig = self.sigDict.get(name,-0.009)
346                        s += G2mth.ValEsd(size[4][i],sig)+', '
347                    sig = self.sigDict.get(phfx+'Size;mx',-0.009)
348                    s += G2mth.ValEsd(size[1][2],sig)+', '                                           
349                else:       #isotropic
350                    s += 'parameters: Size, G/L mix\n    '
351                    i = 0
352                    for item in names:
353                        name = phfx+item
354                        sig = self.sigDict.get(name,-0.009)
355                        s += G2mth.ValEsd(size[1][i],sig)+', '
356                        i = 2    #skip the aniso value               
357                s += '\n  Mustrain model "%s" for %s (10^6^)\n  '%(mustrain[0],phasenam)
358                names = ['Mustrain;i','Mustrain;mx']
359                if 'uniax' in mustrain[0]:
360                    names = ['Mustrain;i','Mustrain;a','Mustrain;mx']
361                    s += 'anisotropic axis is %s\n  '%(str(size[3]))
362                    s += 'parameters: equatorial mustrain, axial mustrain, G/L mix\n    '
363                    for i,item in enumerate(names):
364                        name = phfx+item
365                        sig = self.sigDict.get(name,-0.009)
366                        s += G2mth.ValEsd(mustrain[1][i],sig)+', '
367                elif 'general' in mustrain[0]:
368                    names = 'parameters: '
369                    for i,name in enumerate(G2spc.MustrainNames(SGData)):
370                        names += name+', '
371                        if i == 9:
372                            names += '\n  '
373                    names += 'G/L mix\n    '
374                    s += names
375                    txt = ''
376                    for i in range(len(mustrain[4])):
377                        name = phfx+'Mustrain:'+str(i)
378                        sig = self.sigDict.get(name,-0.009)
379                        if len(txt) > 60:
380                            s += txt+'\n    '
381                            txt = ''
382                        txt += G2mth.ValEsd(mustrain[4][i],sig)+', '
383                    s += txt                                           
384                    sig = self.sigDict.get(phfx+'Mustrain;mx',-0.009)
385                    s += G2mth.ValEsd(mustrain[1][2],sig)+', '
386                   
387                else:       #isotropic
388                    s += '  parameters: Mustrain, G/L mix\n    '
389                    i = 0
390                    for item in names:
391                        name = phfx+item
392                        sig = self.sigDict.get(name,-0.009)
393                        s += G2mth.ValEsd(mustrain[1][i],sig)+', '
394                        i = 2    #skip the aniso value               
395                s += '\n  Macrostrain for %s\n'%(phasenam)
396                txt = '  parameters: '
397                names = G2spc.HStrainNames(SGData)
398                for name in names:
399                    txt += name+', '
400                s += txt+'\n    '
401                for i in range(len(names)):
402                    name = phfx+name[i]
403                    sig = self.sigDict.get(name,-0.009)
404                    s += G2mth.ValEsd(hstrain[0][i],sig)+', '
405            return s
406       
407        def FmtAtomType(sym):
408            'Reformat a GSAS-II atom type symbol to match CIF rules'
409            sym = sym.replace('_','') # underscores are not allowed: no isotope designation?
410            # in CIF, oxidation state sign symbols come after, not before
411            if '+' in sym:
412                sym = sym.replace('+','') + '+'
413            elif '-' in sym:
414                sym = sym.replace('-','') + '-'
415            return sym
416           
417        def PutInCol(val,wid):
418            '''Pad a value to >=wid+1 columns by adding spaces at the end. Always
419            adds at least one space
420            '''
421            val = str(val).replace(' ','')
422            if not val: val = '?'
423            fmt = '{:' + str(wid) + '} '
424            return fmt.format(val)
425
426        def MakeUniqueLabel(lbl,labellist):
427            'Make sure that every atom label is unique'
428            lbl = lbl.strip()
429            if not lbl: # deal with a blank label
430                lbl = 'A_1'
431            if lbl not in labellist:
432                labellist.append(lbl)
433                return lbl
434            i = 1
435            prefix = lbl
436            if '_' in lbl:
437                prefix = lbl[:lbl.rfind('_')]
438                suffix = lbl[lbl.rfind('_')+1:]
439                try:
440                    i = int(suffix)+1
441                except:
442                    pass
443            while prefix+'_'+str(i) in labellist:
444                i += 1
445            else:
446                lbl = prefix+'_'+str(i)
447                labellist.append(lbl)
448
449        def WriteAtomsNuclear(phasenam):
450            'Write atom positions to CIF'
451            phasedict = self.Phases[phasenam] # pointer to current phase info
452            General = phasedict['General']
453            cx,ct,cs,cia = General['AtomPtrs']
454            Atoms = phasedict['Atoms']
455            cfrac = cx+3
456            fpfx = str(phasedict['pId'])+'::Afrac:'       
457            for i,at in enumerate(Atoms):
458                fval = self.parmDict.get(fpfx+str(i),at[cfrac])
459                if fval != 0.0:
460                    break
461            else:
462                WriteCIFitem('\n# PHASE HAS NO ATOMS!')
463                return
464               
465            WriteCIFitem('\n# ATOMIC COORDINATES AND DISPLACEMENT PARAMETERS')
466            WriteCIFitem('loop_ '+
467                         '\n\t_atom_site_label'+
468                         '\n\t_atom_site_type_symbol'+
469                         '\n\t_atom_site_fract_x'+
470                         '\n\t_atom_site_fract_y'+
471                         '\n\t_atom_site_fract_z'+
472                         '\n\t_atom_site_occupancy'+
473                         '\n\t_atom_site_adp_type'+
474                         '\n\t_atom_site_U_iso_or_equiv'+
475                         '\n\t_atom_site_symmetry_multiplicity')
476
477            varnames = {cx:'Ax',cx+1:'Ay',cx+2:'Az',cx+3:'Afrac',
478                        cia+1:'AUiso',cia+2:'AU11',cia+3:'AU22',cia+4:'AU33',
479                        cia+5:'AU12',cia+6:'AU13',cia+7:'AU23'}
480            self.labellist = []
481           
482            pfx = str(phasedict['pId'])+'::'
483            # loop over all atoms
484            naniso = 0
485            for i,at in enumerate(Atoms):
486                s = PutInCol(MakeUniqueLabel(at[ct-1],self.labellist),6) # label
487                fval = self.parmDict.get(fpfx+str(i),at[cfrac])
488                if fval == 0.0: continue # ignore any atoms that have a occupancy set to 0 (exact)
489                s += PutInCol(FmtAtomType(at[ct]),4) # type
490                if at[cia] == 'I':
491                    adp = 'Uiso '
492                else:
493                    adp = 'Uani '
494                    naniso += 1
495                    # compute Uequiv crudely
496                    # correct: Defined as "1/3 trace of diagonalized U matrix".
497                    # SEE cell2GS & Uij2Ueqv to GSASIIlattice. Former is needed to make the GS matrix used by the latter.
498                    t = 0.0
499                    for j in (2,3,4):
500                        var = pfx+varnames[cia+j]+":"+str(i)
501                        t += self.parmDict.get(var,at[cia+j])
502                for j in (cx,cx+1,cx+2,cx+3,cia,cia+1):
503                    if j in (cx,cx+1,cx+2):
504                        dig = 11
505                        sigdig = -0.00009
506                    else:
507                        dig = 10
508                        sigdig = -0.009
509                    if j == cia:
510                        s += adp
511                    else:
512                        var = pfx+varnames[j]+":"+str(i)
513                        dvar = pfx+"d"+varnames[j]+":"+str(i)
514                        if dvar not in self.sigDict:
515                            dvar = var
516                        if j == cia+1 and adp == 'Uani ':
517                            val = t/3.
518                            sig = sigdig
519                        else:
520                            #print var,(var in self.parmDict),(var in self.sigDict)
521                            val = self.parmDict.get(var,at[j])
522                            sig = self.sigDict.get(dvar,sigdig)
523                        s += PutInCol(G2mth.ValEsd(val,sig),dig)
524                s += PutInCol(at[cs+1],3)
525                WriteCIFitem(s)
526            if naniso == 0: return
527            # now loop over aniso atoms
528            WriteCIFitem('\nloop_' + '\n\t_atom_site_aniso_label' + 
529                         '\n\t_atom_site_aniso_U_11' + '\n\t_atom_site_aniso_U_12' +
530                         '\n\t_atom_site_aniso_U_13' + '\n\t_atom_site_aniso_U_22' +
531                         '\n\t_atom_site_aniso_U_23' + '\n\t_atom_site_aniso_U_33')
532            for i,at in enumerate(Atoms):
533                fval = self.parmDict.get(fpfx+str(i),at[cfrac])
534                if fval == 0.0: continue # ignore any atoms that have a occupancy set to 0 (exact)
535                if at[cia] == 'I': continue
536                s = PutInCol(self.labellist[i],6) # label
537                for j in (2,3,4,5,6,7):
538                    sigdig = -0.0009
539                    var = pfx+varnames[cia+j]+":"+str(i)
540                    val = self.parmDict.get(var,at[cia+j])
541                    sig = self.sigDict.get(var,sigdig)
542                    s += PutInCol(G2mth.ValEsd(val,sig),11)
543                WriteCIFitem(s)
544
545        def HillSortElements(elmlist):
546            '''Sort elements in "Hill" order: C, H, others, (where others
547            are alphabetical).
548
549            :params list elmlist: a list of element strings
550
551            :returns: a sorted list of element strings
552            '''
553            newlist = []
554            oldlist = elmlist[:]
555            for elm in ('C','H'):
556                if elm in elmlist:
557                    newlist.append(elm)
558                    oldlist.pop(oldlist.index(elm))
559            return newlist+sorted(oldlist)
560
561        def WriteComposition(phasenam):
562            '''determine the composition for the unit cell, crudely determine Z and
563            then compute the composition in formula units
564            '''
565            phasedict = self.Phases[phasenam] # pointer to current phase info
566            General = phasedict['General']
567            Z = General.get('cellZ',0.0)
568            cx,ct,cs,cia = General['AtomPtrs']
569            Atoms = phasedict['Atoms']
570            fpfx = str(phasedict['pId'])+'::Afrac:'       
571            cfrac = cx+3
572            cmult = cs+1
573            compDict = {} # combines H,D & T
574            sitemultlist = []
575            massDict = dict(zip(General['AtomTypes'],General['AtomMass']))
576            cellmass = 0
577            for i,at in enumerate(Atoms):
578                atype = at[ct].strip()
579                if atype.find('-') != -1: atype = atype.split('-')[0]
580                if atype.find('+') != -1: atype = atype.split('+')[0]
581                atype = atype[0].upper()+atype[1:2].lower() # force case conversion
582                if atype == "D" or atype == "D": atype = "H"
583                fvar = fpfx+str(i)
584                fval = self.parmDict.get(fvar,at[cfrac])
585                mult = at[cmult]
586                if not massDict.get(at[ct]):
587                    print 'No mass found for atom type '+at[ct]
588                    print 'Will not compute cell contents for phase '+phasenam
589                    return
590                cellmass += massDict[at[ct]]*mult*fval
591                compDict[atype] = compDict.get(atype,0.0) + mult*fval
592                if fval == 1: sitemultlist.append(mult)
593            if len(compDict.keys()) == 0: return # no elements!
594            if Z < 1: # Z has not been computed or set by user
595                Z = 1
596                for i in range(2,min(sitemultlist)+1):
597                    for m in sitemultlist:
598                        if m % i != 0:
599                            break
600                        else:
601                            Z = i
602                General['cellZ'] = Z # save it
603
604            # when scattering factors are included in the CIF, this needs to be
605            # added to the loop here but only in the one-block case.
606            # For multiblock CIFs, scattering factors go in the histogram
607            # blocks  (for all atoms in all appropriate phases)
608
609            #if oneblock: # add scattering factors for current phase here
610            WriteCIFitem('\nloop_  _atom_type_symbol _atom_type_number_in_cell')
611            formula = ''
612            reload(G2mth)
613            for elem in HillSortElements(compDict.keys()):
614                WriteCIFitem('  ' + PutInCol(elem,4) +
615                             G2mth.ValEsd(compDict[elem],-0.009,True))
616                if formula: formula += " "
617                formula += elem
618                if compDict[elem] == Z: continue
619                formula += G2mth.ValEsd(compDict[elem]/Z,-0.009,True)
620            WriteCIFitem( '\n# Note that Z affects _cell_formula_sum and _weight')
621            WriteCIFitem( '_cell_formula_units_Z',str(Z))
622            WriteCIFitem( '_chemical_formula_sum',formula)
623            WriteCIFitem( '_chemical_formula_weight',
624                          G2mth.ValEsd(cellmass/Z,-0.09,True))
625
626        def WriteDistances(phasenam,SymOpList,offsetList,symOpList,G2oprList):
627            '''Report bond distances and angles for the CIF
628
629            Note that _geom_*_symmetry_* fields are values of form
630            n_klm where n is the symmetry operation in SymOpList (counted
631            starting with 1) and (k-5, l-5, m-5) are translations to add
632            to (x,y,z). See
633            http://www.iucr.org/__data/iucr/cifdic_html/1/cif_core.dic/Igeom_angle_site_symmetry_.html
634
635            TODO: need a method to select publication flags for distances/angles
636            '''
637            phasedict = self.Phases[phasenam] # pointer to current phase info           
638            Atoms = phasedict['Atoms']
639            generalData = phasedict['General']
640            cx,ct,cs,cia = phasedict['General']['AtomPtrs']
641            cn = ct-1
642            fpfx = str(phasedict['pId'])+'::Afrac:'       
643            cfrac = cx+3
644            DisAglData = {}
645            DisAglCtls = {}
646            # create a list of atoms, but skip atoms with zero occupancy
647            xyz = []
648            fpfx = str(phasedict['pId'])+'::Afrac:'       
649            for i,atom in enumerate(Atoms):
650                if self.parmDict.get(fpfx+str(i),atom[cfrac]) == 0.0: continue
651                xyz.append([i,]+atom[cn:cn+2]+atom[cx:cx+3])
652            if 'DisAglCtls' in generalData:
653                DisAglCtls = generalData['DisAglCtls']
654            else:
655                dlg = G2gd.DisAglDialog(self.G2frame,DisAglCtls,generalData)
656                if dlg.ShowModal() == wx.ID_OK:
657                    DisAglCtls = dlg.GetData()
658                    generalData['DisAglCtls'] = DisAglCtls
659                else:
660                    dlg.Destroy()
661                    return
662                dlg.Destroy()
663            DisAglData['OrigAtoms'] = xyz
664            DisAglData['TargAtoms'] = xyz
665            SymOpList,offsetList,symOpList,G2oprList = G2spc.AllOps(
666                generalData['SGData'])
667
668            xpandSGdata = generalData['SGData'].copy()
669            xpandSGdata.update({'SGOps':symOpList,
670                                'SGInv':False,
671                                'SGLatt':'P',
672                                'SGCen':np.array([[0, 0, 0]]),})
673            DisAglData['SGData'] = xpandSGdata
674
675            DisAglData['Cell'] = generalData['Cell'][1:] #+ volume
676            if 'pId' in phasedict:
677                DisAglData['pId'] = phasedict['pId']
678                DisAglData['covData'] = self.OverallParms['Covariance']
679            try:
680                AtomLabels,DistArray,AngArray = G2stMn.RetDistAngle(DisAglCtls,DisAglData)
681            except KeyError:        # inside DistAngle for missing atom types in DisAglCtls
682                print '**** ERROR - try again but do "Reset" to fill in missing atom types ****'
683                   
684            # loop over interatomic distances for this phase
685            WriteCIFitem('\n# MOLECULAR GEOMETRY')
686            WriteCIFitem('loop_' + 
687                         '\n\t_geom_bond_atom_site_label_1' +
688                         '\n\t_geom_bond_atom_site_label_2' + 
689                         '\n\t_geom_bond_distance' + 
690                         '\n\t_geom_bond_site_symmetry_1' + 
691                         '\n\t_geom_bond_site_symmetry_2' + 
692                         '\n\t_geom_bond_publ_flag')
693
694            for i in sorted(AtomLabels.keys()):
695                Dist = DistArray[i]
696                for D in Dist:
697                    line = '  '+PutInCol(AtomLabels[i],6)+PutInCol(AtomLabels[D[0]],6)
698                    sig = D[4]
699                    if sig == 0: sig = -0.00009
700                    line += PutInCol(G2mth.ValEsd(D[3],sig,True),10)
701                    line += "  1_555 "
702                    line += " {:3d}_".format(D[2])
703                    for d in D[1]:
704                        line += "{:1d}".format(d+5)
705                    line += " yes"
706                    WriteCIFitem(line)
707
708            # loop over interatomic angles for this phase
709            WriteCIFitem('\nloop_' + 
710                         '\n\t_geom_angle_atom_site_label_1' + 
711                         '\n\t_geom_angle_atom_site_label_2' + 
712                         '\n\t_geom_angle_atom_site_label_3' + 
713                         '\n\t_geom_angle' + 
714                         '\n\t_geom_angle_site_symmetry_1' +
715                         '\n\t_geom_angle_site_symmetry_2' + 
716                         '\n\t_geom_angle_site_symmetry_3' + 
717                         '\n\t_geom_angle_publ_flag')
718
719            for i in sorted(AtomLabels.keys()):
720                Dist = DistArray[i]
721                for k,j,tup in AngArray[i]:
722                    Dj = Dist[j]
723                    Dk = Dist[k]
724                    line = '  '+PutInCol(AtomLabels[Dj[0]],6)+PutInCol(AtomLabels[i],6)+PutInCol(AtomLabels[Dk[0]],6)
725                    sig = tup[1]
726                    if sig == 0: sig = -0.009
727                    line += PutInCol(G2mth.ValEsd(tup[0],sig,True),10)
728                    line += " {:3d}_".format(Dj[2])
729                    for d in Dj[1]:
730                        line += "{:1d}".format(d+5)
731                    line += "  1_555 "
732                    line += " {:3d}_".format(Dk[2])
733                    for d in Dk[1]:
734                        line += "{:1d}".format(d+5)
735                    line += " yes"
736                    WriteCIFitem(line)
737
738        def WritePhaseInfo(phasenam):
739            WriteCIFitem('\n# phase info for '+str(phasenam) + ' follows')
740            phasedict = self.Phases[phasenam] # pointer to current phase info           
741            WriteCIFitem('_pd_phase_name', phasenam)
742            pfx = str(phasedict['pId'])+'::'
743            A,sigA = G2stIO.cellFill(pfx,phasedict['General']['SGData'],self.parmDict,self.sigDict)
744            cellSig = G2stIO.getCellEsd(pfx,
745                                       phasedict['General']['SGData'],A,
746                                       self.OverallParms['Covariance'])  # returns 7 vals, includes sigVol
747            cellList = G2lat.A2cell(A) + (G2lat.calc_V(A),)
748            defsigL = 3*[-0.00001] + 3*[-0.001] + [-0.01] # significance to use when no sigma
749            names = ['length_a','length_b','length_c',
750                     'angle_alpha','angle_beta ','angle_gamma',
751                     'volume']
752            prevsig = 0
753            for lbl,defsig,val,sig in zip(names,defsigL,cellList,cellSig):
754                if sig:
755                    txt = G2mth.ValEsd(val,sig)
756                    prevsig = -sig # use this as the significance for next value
757                else:
758                    txt = G2mth.ValEsd(val,min(defsig,prevsig),True)
759                WriteCIFitem('_cell_'+lbl,txt)
760                   
761            WriteCIFitem('_symmetry_cell_setting',
762                         phasedict['General']['SGData']['SGSys'])
763
764            spacegroup = phasedict['General']['SGData']['SpGrp'].strip()
765            # regularize capitalization and remove trailing H/R
766            spacegroup = spacegroup[0].upper() + spacegroup[1:].lower().rstrip('rh ')
767            WriteCIFitem('_symmetry_space_group_name_H-M',spacegroup)
768
769            # generate symmetry operations including centering and center of symmetry
770            SymOpList,offsetList,symOpList,G2oprList = G2spc.AllOps(
771                phasedict['General']['SGData'])
772            WriteCIFitem('loop_\n    _space_group_symop_id\n    _space_group_symop_operation_xyz')
773            for i,op in enumerate(SymOpList,start=1):
774                WriteCIFitem('   {:3d}  {:}'.format(i,op.lower()))
775
776            # loop over histogram(s) used in this phase
777            if not oneblock and not self.quickmode:
778                # report pointers to the histograms used in this phase
779                histlist = []
780                for hist in self.Phases[phasenam]['Histograms']:
781                    if self.Phases[phasenam]['Histograms'][hist]['Use']:
782                        if phasebyhistDict.get(hist):
783                            phasebyhistDict[hist].append(phasenam)
784                        else:
785                            phasebyhistDict[hist] = [phasenam,]
786                        blockid = datablockidDict.get(hist)
787                        if not blockid:
788                            print "Internal error: no block for data. Phase "+str(
789                                phasenam)+" histogram "+str(hist)
790                            histlist = []
791                            break
792                        histlist.append(blockid)
793
794                if len(histlist) == 0:
795                    WriteCIFitem('# Note: phase has no associated data')
796                else:
797                    WriteCIFitem('loop_  _pd_block_diffractogram_id')
798
799            # report atom params
800            if phasedict['General']['Type'] == 'nuclear':        #this needs macromolecular variant, etc!
801                WriteAtomsNuclear(phasenam)
802            else:
803                raise Exception,"no export for mm coordinates implemented"
804            # report cell contents
805            WriteComposition(phasenam)
806            if not self.quickmode:      # report distances and angles
807                WriteDistances(phasenam,SymOpList,offsetList,symOpList,G2oprList)
808               
809        def Yfmt(ndec,val):
810            'Format intensity values'
811            out = ("{:."+str(ndec)+"f}").format(val)
812            out = out.rstrip('0')  # strip zeros to right of decimal
813            return out.rstrip('.')  # and decimal place when not needed
814           
815        def WriteReflStat(refcount,hklmin,hklmax,dmin,dmax,nRefSets=1):
816            WriteCIFitem('_reflns_number_total', str(refcount))
817            if hklmin is not None and nRefSets == 1: # hkl range has no meaning with multiple phases
818                WriteCIFitem('_reflns_limit_h_min', str(int(hklmin[0])))
819                WriteCIFitem('_reflns_limit_h_max', str(int(hklmax[0])))
820                WriteCIFitem('_reflns_limit_k_min', str(int(hklmin[1])))
821                WriteCIFitem('_reflns_limit_k_max', str(int(hklmax[1])))
822                WriteCIFitem('_reflns_limit_l_min', str(int(hklmin[2])))
823                WriteCIFitem('_reflns_limit_l_max', str(int(hklmax[2])))
824            if hklmin is not None:
825                WriteCIFitem('_reflns_d_resolution_low  ', G2mth.ValEsd(dmax,-0.009))
826                WriteCIFitem('_reflns_d_resolution_high ', G2mth.ValEsd(dmin,-0.009))
827
828        def WritePowderData(histlbl):
829            histblk = self.Histograms[histlbl]
830            inst = histblk['Instrument Parameters'][0]
831            hId = histblk['hId']
832            pfx = ':' + str(hId) + ':'
833           
834            if 'Lam1' in inst:
835                ratio = self.parmDict.get('I(L2)/I(L1)',inst['I(L2)/I(L1)'][1])
836                sratio = self.sigDict.get('I(L2)/I(L1)',-0.0009)
837                lam1 = self.parmDict.get('Lam1',inst['Lam1'][1])
838                slam1 = self.sigDict.get('Lam1',-0.00009)
839                lam2 = self.parmDict.get('Lam2',inst['Lam2'][1])
840                slam2 = self.sigDict.get('Lam2',-0.00009)
841                # always assume Ka1 & Ka2 if two wavelengths are present
842                WriteCIFitem('loop_' + 
843                             '\n\t_diffrn_radiation_wavelength' +
844                             '\n\t_diffrn_radiation_wavelength_wt' + 
845                             '\n\t_diffrn_radiation_type' + 
846                             '\n\t_diffrn_radiation_wavelength_id')
847                WriteCIFitem('  ' + PutInCol(G2mth.ValEsd(lam1,slam1),15)+
848                             PutInCol('1.0',15) + 
849                             PutInCol('K\\a~1~',10) + 
850                             PutInCol('1',5))
851                WriteCIFitem('  ' + PutInCol(G2mth.ValEsd(lam2,slam2),15)+
852                             PutInCol(G2mth.ValEsd(ratio,sratio),15)+
853                             PutInCol('K\\a~2~',10) + 
854                             PutInCol('2',5))               
855            else:
856                lam1 = self.parmDict.get('Lam',inst['Lam'][1])
857                slam1 = self.sigDict.get('Lam',-0.00009)
858                WriteCIFitem('_diffrn_radiation_wavelength',G2mth.ValEsd(lam1,slam1))
859
860            if not oneblock:
861                if not phasebyhistDict.get(histlbl):
862                    WriteCIFitem('\n# No phases associated with this data set')
863                else:
864                    WriteCIFitem('\n# PHASE TABLE')
865                    WriteCIFitem('loop_' +
866                                 '\n\t_pd_phase_id' + 
867                                 '\n\t_pd_phase_block_id' + 
868                                 '\n\t_pd_phase_mass_%')
869                    wtFrSum = 0.
870                    for phasenam in phasebyhistDict.get(histlbl):
871                        hapData = self.Phases[phasenam]['Histograms'][histlbl]
872                        General = self.Phases[phasenam]['General']
873                        wtFrSum += hapData['Scale'][0]*General['Mass']
874
875                    for phasenam in phasebyhistDict.get(histlbl):
876                        hapData = self.Phases[phasenam]['Histograms'][histlbl]
877                        General = self.Phases[phasenam]['General']
878                        wtFr = hapData['Scale'][0]*General['Mass']/wtFrSum
879                        pfx = str(self.Phases[phasenam]['pId'])+':'+str(hId)+':'
880                        if pfx+'Scale' in self.sigDict:
881                            sig = self.sigDict[pfx+'Scale']*wtFr/hapData['Scale'][0]
882                        else:
883                            sig = -0.0001
884                        WriteCIFitem(
885                            '  '+
886                            str(self.Phases[phasenam]['pId']) +
887                            '  '+datablockidDict[phasenam]+
888                            '  '+G2mth.ValEsd(wtFr,sig)
889                            )
890                    WriteCIFitem('loop_' +
891                                 '\n\t_pd_proc_ls_R_F_factor' +
892                                 '\n\t_pd_proc_ls_R_Fsqd_factor')
893                    for phasenam in phasebyhistDict.get(histlbl):
894                        pfx = str(self.Phases[phasenam]['pId'])+':'+str(hId)+':'
895                        WriteCIFitem(
896                            '  '+
897                            '  '+G2mth.ValEsd(histblk[pfx+'Rf']/100.,-.00009) +
898                            '  '+G2mth.ValEsd(histblk[pfx+'Rf^2']/100.,-.00009)
899                            )
900            else:
901                pfx = '0:'+str(hId)+':'
902                WriteCIFitem('_pd_proc_ls_R_F_factor      ','%.5f'%(histblk[pfx+'Rf']/100.))
903                WriteCIFitem('_pd_proc_ls_R_Fsqd_factor   ','%.5f'%(histblk[pfx+'Rf^2']/100.))
904               
905            WriteCIFitem('_pd_proc_ls_prof_R_factor   ','%.5f'%(histblk['R']/100.))
906            WriteCIFitem('_pd_proc_ls_prof_wR_factor  ','%.5f'%(histblk['wR']/100.))
907            WriteCIFitem('_pd_proc_ls_prof_R_B_factor ','%.5f'%(histblk['Rb']/100.))
908            WriteCIFitem('_pd_proc_ls_prof_wR_B_factor','%.5f'%(histblk['wRb']/100.))
909            WriteCIFitem('_pd_proc_ls_prof_wR_expected','%.5f'%(histblk['wRmin']/100.))
910
911            if histblk['Instrument Parameters'][0]['Type'][1][1] == 'X':
912                WriteCIFitem('_diffrn_radiation_probe','x-ray')
913                pola = histblk['Instrument Parameters'][0].get('Polariz.')
914                if pola:
915                    pfx = ':' + str(hId) + ':'
916                    sig = self.sigDict.get(pfx+'Polariz.',-0.0009)
917                    txt = G2mth.ValEsd(pola[1],sig)
918                    WriteCIFitem('_diffrn_radiation_polarisn_ratio',txt)
919            elif histblk['Instrument Parameters'][0]['Type'][1][1] == 'N':
920                WriteCIFitem('_diffrn_radiation_probe','neutron')
921            # TOF (note that this may not be defined)
922            #if histblk['Instrument Parameters'][0]['Type'][1][2] == 'T':
923            #    WriteCIFitem('_pd_meas_2theta_fixed',text)
924           
925
926            # TODO: this will need help from Bob
927            #if not oneblock:
928            #WriteCIFitem('\n# SCATTERING FACTOR INFO')
929            #WriteCIFitem('loop_  _atom_type_symbol')
930            #if histblk['Instrument Parameters'][0]['Type'][1][1] == 'X':
931            #    WriteCIFitem('      _atom_type_scat_dispersion_real')
932            #    WriteCIFitem('      _atom_type_scat_dispersion_imag')
933            #    for lbl in ('a1','a2','a3', 'a4', 'b1', 'b2', 'b3', 'b4', 'c'):
934            #        WriteCIFitem('      _atom_type_scat_Cromer_Mann_'+lbl)
935            #elif histblk['Instrument Parameters'][0]['Type'][1][1] == 'N':
936            #    WriteCIFitem('      _atom_type_scat_length_neutron')
937            #WriteCIFitem('      _atom_type_scat_source')
938
939            WriteCIFitem('_pd_proc_ls_background_function',FormatBackground(histblk['Background'],histblk['hId']))
940
941            # TODO: this will need help from Bob
942            #WriteCIFitem('_exptl_absorpt_process_details','?')
943            #WriteCIFitem('_exptl_absorpt_correction_T_min','?')
944            #WriteCIFitem('_exptl_absorpt_correction_T_max','?')
945            #C extinction
946            #WRITE(IUCIF,'(A)') '# Extinction correction'
947            #CALL WRVAL(IUCIF,'_gsas_exptl_extinct_corr_T_min',TEXT(1:10))
948            #CALL WRVAL(IUCIF,'_gsas_exptl_extinct_corr_T_max',TEXT(11:20))
949
950            if not oneblock:                 # instrumental profile terms go here
951                WriteCIFitem('_pd_proc_ls_profile_function', 
952                    FormatInstProfile(histblk["Instrument Parameters"],histblk['hId']))
953
954            #refprx = '_refln.' # mm
955            refprx = '_refln_' # normal
956            WriteCIFitem('\n# STRUCTURE FACTOR TABLE')           
957            # compute maximum intensity reflection
958            Imax = 0
959            for phasenam in histblk['Reflection Lists']:
960                scale = self.Phases[phasenam]['Histograms'][histlbl]['Scale'][0]
961                Icorr = np.array([refl[13] for refl in histblk['Reflection Lists'][phasenam]])
962                FO2 = np.array([refl[8] for refl in histblk['Reflection Lists'][phasenam]])
963                I100 = scale*FO2*Icorr
964                Imax = max(Imax,max(I100))
965
966            WriteCIFitem('loop_')
967            if len(histblk['Reflection Lists'].keys()) > 1:
968                WriteCIFitem('\t_pd_refln_phase_id')
969            WriteCIFitem('\t' + refprx + 'index_h' + 
970                         '\n\t' + refprx + 'index_k' + 
971                         '\n\t' + refprx + 'index_l' + 
972                         '\n\t' + refprx + 'F_squared_meas' + 
973                         '\n\t' + refprx + 'F_squared_calc' + 
974                         '\n\t' + refprx + 'phase_calc' + 
975                         '\n\t_pd_refln_d_spacing')
976            if Imax > 0:
977                WriteCIFitem('\t_gsas_i100_meas')
978
979            refcount = 0
980            hklmin = None
981            hklmax = None
982            dmax = None
983            dmin = None
984            for phasenam in histblk['Reflection Lists']:
985                scale = self.Phases[phasenam]['Histograms'][histlbl]['Scale'][0]
986                phaseid = self.Phases[phasenam]['pId']
987                refcount += len(histblk['Reflection Lists'][phasenam])
988                for ref in histblk['Reflection Lists'][phasenam]:
989                    if DEBUG:
990                        print 'DEBUG: skip reflection list'
991                        break
992                    if hklmin is None:
993                        hklmin = ref[0:3]
994                        hklmax = ref[0:3]
995                        dmax = dmin = ref[4]
996                    if len(histblk['Reflection Lists'].keys()) > 1:
997                        s = PutInCol(phaseid,2)
998                    else:
999                        s = ""
1000                    for i,hkl in enumerate(ref[0:3]):
1001                        hklmax[i] = max(hkl,hklmax[i])
1002                        hklmin[i] = min(hkl,hklmin[i])
1003                        s += PutInCol(int(hkl),4)
1004                    for I in ref[8:10]:
1005                        s += PutInCol(G2mth.ValEsd(I,-0.0009),10)
1006                    s += PutInCol(G2mth.ValEsd(ref[10],-0.9),7)
1007                    dmax = max(dmax,ref[4])
1008                    dmin = min(dmin,ref[4])
1009                    s += PutInCol(G2mth.ValEsd(ref[4],-0.009),8)
1010                    if Imax > 0:
1011                        I100 = 100.*scale*ref[8]*ref[13]/Imax
1012                        s += PutInCol(G2mth.ValEsd(I100,-0.09),6)
1013                    WriteCIFitem("  "+s)
1014
1015            WriteReflStat(refcount,hklmin,hklmax,dmin,dmax,len(histblk['Reflection Lists']))
1016            WriteCIFitem('\n# POWDER DATA TABLE')
1017            # is data fixed step? If the step varies by <0.01% treat as fixed step
1018            steps = histblk['Data'][0][1:] - histblk['Data'][0][:-1]
1019            if abs(max(steps)-min(steps)) > abs(max(steps))/10000.:
1020                fixedstep = False
1021            else:
1022                fixedstep = True
1023
1024            if fixedstep: # and not TOF
1025                WriteCIFitem('_pd_meas_2theta_range_min', G2mth.ValEsd(histblk['Data'][0][0],-0.00009))
1026                WriteCIFitem('_pd_meas_2theta_range_max', G2mth.ValEsd(histblk['Data'][0][-1],-0.00009))
1027                WriteCIFitem('_pd_meas_2theta_range_inc', G2mth.ValEsd(steps.sum()/len(steps),-0.00009))
1028                # zero correct, if defined
1029                zero = None
1030                zerolst = histblk['Instrument Parameters'][0].get('Zero')
1031                if zerolst: zero = zerolst[1]
1032                zero = self.parmDict.get('Zero',zero)
1033                if zero:
1034                    WriteCIFitem('_pd_proc_2theta_range_min', G2mth.ValEsd(histblk['Data'][0][0]-zero,-0.00009))
1035                    WriteCIFitem('_pd_proc_2theta_range_max', G2mth.ValEsd(histblk['Data'][0][-1]-zero,-0.00009))
1036                    WriteCIFitem('_pd_proc_2theta_range_inc', G2mth.ValEsd(steps.sum()/len(steps),-0.00009))
1037               
1038            if zero:
1039                WriteCIFitem('_pd_proc_number_of_points', str(len(histblk['Data'][0])))
1040            else:
1041                WriteCIFitem('_pd_meas_number_of_points', str(len(histblk['Data'][0])))
1042            WriteCIFitem('\nloop_')
1043            #            WriteCIFitem('\t_pd_proc_d_spacing') # need easy way to get this
1044            if not fixedstep:
1045                if zero:
1046                    WriteCIFitem('\t_pd_proc_2theta_corrected')
1047                else:
1048                    WriteCIFitem('\t_pd_meas_2theta_scan')
1049            # at least for now, always report weights.
1050            #if countsdata:
1051            #    WriteCIFitem('\t_pd_meas_counts_total')
1052            #else:
1053            WriteCIFitem('\t_pd_meas_intensity_total')
1054            WriteCIFitem('\t_pd_calc_intensity_total')
1055            WriteCIFitem('\t_pd_proc_intensity_bkg_calc')
1056            WriteCIFitem('\t_pd_proc_ls_weight')
1057            maxY = max(histblk['Data'][1].max(),histblk['Data'][3].max())
1058            if maxY < 0: maxY *= -10 # this should never happen, but...
1059            ndec = max(0,10-int(np.log10(maxY))-1) # 10 sig figs should be enough
1060            maxSU = histblk['Data'][2].max()
1061            if maxSU < 0: maxSU *= -1 # this should never happen, but...
1062            ndecSU = max(0,8-int(np.log10(maxSU))-1) # 8 sig figs should be enough
1063            lowlim,highlim = histblk['Limits'][1]
1064
1065            if DEBUG:
1066                print 'DEBUG: skip profile list'
1067            else:   
1068                for x,yobs,yw,ycalc,ybkg in zip(histblk['Data'][0],
1069                                                histblk['Data'][1],
1070                                                histblk['Data'][2],
1071                                                histblk['Data'][3],
1072                                                histblk['Data'][4]):
1073                    if lowlim <= x <= highlim:
1074                        pass
1075                    else:
1076                        yw = 0.0 # show the point is not in use
1077   
1078                    if fixedstep:
1079                        s = ""
1080                    else:
1081                        s = PutInCol(G2mth.ValEsd(x-zero,-0.00009),10)
1082                    s += PutInCol(Yfmt(ndec,yobs),12)
1083                    s += PutInCol(Yfmt(ndec,ycalc),12)
1084                    s += PutInCol(Yfmt(ndec,ybkg),11)
1085                    s += PutInCol(Yfmt(ndecSU,yw),9)
1086                    WriteCIFitem("  "+s)
1087
1088        def WriteSingleXtalData(histlbl):
1089            histblk = self.Histograms[histlbl]
1090            #refprx = '_refln.' # mm
1091            refprx = '_refln_' # normal
1092
1093            WriteCIFitem('\n# STRUCTURE FACTOR TABLE')           
1094            WriteCIFitem('loop_' + 
1095                         '\n\t' + refprx + 'index_h' + 
1096                         '\n\t' + refprx + 'index_k' + 
1097                         '\n\t' + refprx + 'index_l' +
1098                         '\n\t' + refprx + 'F_squared_meas' + 
1099                         '\n\t' + refprx + 'F_squared_sigma' + 
1100                         '\n\t' + refprx + 'F_squared_calc' + 
1101                         '\n\t' + refprx + 'phase_calc'
1102                         )
1103
1104            hklmin = None
1105            hklmax = None
1106            dmax = None
1107            dmin = None
1108            refcount = len(histblk['Data'])
1109            for ref in histblk['Data']:
1110                s = "  "
1111                if hklmin is None:
1112                    hklmin = ref[0:3]
1113                    hklmax = ref[0:3]
1114                    dmax = dmin = ref[4]
1115                for i,hkl in enumerate(ref[0:3]):
1116                    hklmax[i] = max(hkl,hklmax[i])
1117                    hklmin[i] = min(hkl,hklmin[i])
1118                    s += PutInCol(int(hkl),4)
1119                sig = ref[6] * ref[8] / ref[5]
1120                s += PutInCol(G2mth.ValEsd(ref[8],-abs(sig/10)),12)
1121                s += PutInCol(G2mth.ValEsd(sig,-abs(sig)/10.),10)
1122                s += PutInCol(G2mth.ValEsd(ref[9],-abs(sig/10)),12)
1123                s += PutInCol(G2mth.ValEsd(ref[10],-0.9),7)
1124                dmax = max(dmax,ref[4])
1125                dmin = min(dmin,ref[4])
1126                WriteCIFitem(s)
1127            WriteReflStat(refcount,hklmin,hklmax,dmin,dmax)
1128            hId = histblk['hId']
1129            pfx = '0:'+str(hId)+':'
1130            WriteCIFitem('_reflns_wR_factor_obs    ','%.4f'%(histblk['wR']/100.))
1131            WriteCIFitem('_reflns_R_F_factor_obs   ','%.4f'%(histblk[pfx+'Rf']/100.))
1132            WriteCIFitem('_reflns_R_Fsqd_factor_obs','%.4f'%(histblk[pfx+'Rf^2']/100.))
1133
1134        #============================================================
1135        # the export process starts here
1136        # load all of the tree into a set of dicts
1137        self.loadTree()
1138        # create a dict with refined values and their uncertainties
1139        self.loadParmDict()
1140
1141        # Someday: get restraint & constraint info
1142        #restraintDict = self.OverallParms.get('Restraints',{})
1143        #for i in  self.OverallParms['Constraints']:
1144        #    print i
1145        #    for j in self.OverallParms['Constraints'][i]:
1146        #        print j
1147
1148        self.CIFdate = dt.datetime.strftime(dt.datetime.now(),"%Y-%m-%dT%H:%M")
1149        # index powder and single crystal histograms
1150        self.powderDict = {}
1151        self.xtalDict = {}
1152        for hist in self.Histograms:
1153            i = self.Histograms[hist]['hId']
1154            if hist.startswith("PWDR"): 
1155                self.powderDict[i] = hist
1156            elif hist.startswith("HKLF"): 
1157                self.xtalDict[i] = hist
1158        # is there anything to export?
1159        if len(self.Phases) + len(self.powderDict) + len(self.xtalDict) == 0: 
1160            self.G2frame.ErrorDialog(
1161                'Empty project',
1162                'No data or phases to include in CIF')
1163            return
1164        # is there a file name defined?
1165        self.CIFname = os.path.splitext(
1166            os.path.split(self.G2frame.GSASprojectfile)[1]
1167            )[0]
1168        self.CIFname = self.CIFname.replace(' ','')
1169        if not self.CIFname:
1170            self.G2frame.ErrorDialog(
1171                'No GPX name',
1172                'Please save the project to provide a name')
1173            return
1174        # test for quick CIF mode or no data
1175        self.quickmode = False
1176        phasenam = phasenum = None # include all phases
1177        if mode != "full" or len(self.powderDict) + len(self.xtalDict) == 0:
1178            self.quickmode = True
1179            oneblock = True
1180            if len(self.Phases) == 0:
1181                self.G2frame.ErrorDialog(
1182                    'No phase present',
1183                    'Cannot create a coordinates CIF with no phases')
1184                return
1185            elif len(self.Phases) > 1: # quick mode: choose one phase
1186                choices = sorted(self.Phases.keys())
1187                phasenum = G2gd.ItemSelector(choices,self.G2frame)
1188                if phasenum is None: return
1189                phasenam = choices[phasenum]
1190        # will this require a multiblock CIF?
1191        elif len(self.Phases) > 1:
1192            oneblock = False
1193        elif len(self.powderDict) + len(self.xtalDict) > 1:
1194            oneblock = False
1195        else: # one phase, one dataset, Full CIF
1196            oneblock = True
1197
1198        # make sure needed infomation is present
1199        # get CIF author name -- required for full CIFs
1200        try:
1201            self.author = self.OverallParms['Controls'].get("Author",'').strip()
1202        except KeyError:
1203            pass
1204        while not (self.author or self.quickmode):
1205            dlg = G2gd.SingleStringDialog(self.G2frame,'Get CIF Author','Provide CIF Author name (Last, First)')
1206            if not dlg.Show(): return # cancel was pressed
1207            self.author = dlg.GetValue()
1208            dlg.Destroy()
1209        try:
1210            self.OverallParms['Controls']["Author"] = self.author # save for future
1211        except KeyError:
1212            pass
1213        self.shortauthorname = self.author.replace(',','').replace(' ','')[:20]
1214
1215        # check the instrument name for every histogram
1216        if not self.quickmode:
1217            dictlist = []
1218            keylist = []
1219            lbllist = []
1220            invalid = 0
1221            key3 = 'InstrName'
1222            for hist in self.Histograms:
1223                if hist.startswith("PWDR"): 
1224                    key2 = "Sample Parameters"
1225                    d = self.Histograms[hist][key2]
1226                elif hist.startswith("HKLF"): 
1227                    key2 = "Instrument Parameters"
1228                    d = self.Histograms[hist][key2][0]
1229                   
1230                lbllist.append(hist)
1231                dictlist.append(d)
1232                keylist.append(key3)
1233                instrname = d.get(key3)
1234                if instrname is None:
1235                    d[key3] = ''
1236                    invalid += 1
1237                elif instrname.strip() == '':
1238                    invalid += 1
1239            if invalid:
1240                msg = ""
1241                if invalid > 3: msg = (
1242                    "\n\nNote: it may be faster to set the name for\n"
1243                    "one histogram for each instrument and use the\n"
1244                    "File/Copy option to duplicate the name"
1245                    )
1246                if not G2gd.CallScrolledMultiEditor(
1247                    self.G2frame,dictlist,keylist,
1248                    prelbl=range(1,len(dictlist)+1),
1249                    postlbl=lbllist,
1250                    title='Instrument names',
1251                    header="Edit instrument names. Note that a non-blank\nname is required for all histograms"+msg,
1252                    ): return
1253
1254        if oneblock and not self.quickmode:
1255            # select a dataset to use (there should only be one set in one block,
1256            # but take whatever comes 1st
1257            for hist in self.Histograms:
1258                histblk = self.Histograms[hist]
1259                if hist.startswith("PWDR"): 
1260                    instnam = histblk["Sample Parameters"]['InstrName']
1261                    break # ignore all but 1st data histogram
1262                elif hist.startswith("HKLF"): 
1263                    instnam = histblk["Instrument Parameters"][0]['InstrName']
1264                    break # ignore all but 1st data histogram
1265        if self.quickmode:
1266            fil = self.askSaveFile()
1267        else:
1268            fil = self.defSaveFile()
1269        if not fil: return
1270        openCIF(fil)
1271        #======================================================================
1272        # Start writing the CIF - single block
1273        #======================================================================
1274        if oneblock:
1275            WriteCIFitem('data_'+self.CIFname)
1276            if phasenam is None: # if not already selected, select the first phase (should be one)
1277                phasenam = self.Phases.keys()[0]
1278            #print 'phasenam',phasenam
1279            phaseblk = self.Phases[phasenam] # pointer to current phase info
1280            if not self.quickmode:
1281                instnam = instnam.replace(' ','')
1282                WriteCIFitem('_pd_block_id',
1283                             str(self.CIFdate) + "|" + str(self.CIFname) + "|" +
1284                             str(self.shortauthorname) + "|" + instnam)
1285                WriteAudit()
1286                WritePubTemplate()
1287                WriteOverall()
1288                WritePhaseTemplate()
1289            # report the phase info
1290            WritePhaseInfo(phasenam)
1291            if hist.startswith("PWDR") and not self.quickmode:
1292                # preferred orientation
1293                SH = FormatSH(phasenam)
1294                MD = FormatHAPpo(phasenam)
1295                if SH and MD:
1296                    WriteCIFitem('_pd_proc_ls_pref_orient_corr', SH + '\n' + MD)
1297                elif SH or MD:
1298                    WriteCIFitem('_pd_proc_ls_pref_orient_corr', SH + MD)
1299                else:
1300                    WriteCIFitem('_pd_proc_ls_pref_orient_corr', 'none')
1301                    # report profile, since one-block: include both histogram and phase info
1302                WriteCIFitem('_pd_proc_ls_profile_function',
1303                    FormatInstProfile(histblk["Instrument Parameters"],histblk['hId'])
1304                    +'\n'+FormatPhaseProfile(phasenam))
1305                WritePowderTemplate()
1306                WritePowderData(hist)
1307            elif hist.startswith("HKLF") and not self.quickmode:
1308                WriteSnglXtalTemplate()
1309                WriteSingleXtalData(hist)
1310        else:
1311        #======================================================================
1312        # Start writing the CIF - multiblock
1313        #======================================================================
1314            # publication info
1315            WriteCIFitem('\ndata_'+self.CIFname+'_publ')
1316            WriteAudit()
1317            WriteCIFitem('_pd_block_id',
1318                         str(self.CIFdate) + "|" + str(self.CIFname) + "|" +
1319                         str(self.shortauthorname) + "|Overall")
1320            WritePubTemplate()
1321            # overall info
1322            WriteCIFitem('data_'+str(self.CIFname)+'_overall')
1323            WriteOverall()
1324            #============================================================
1325            WriteCIFitem('# POINTERS TO PHASE AND HISTOGRAM BLOCKS')
1326            datablockidDict = {} # save block names here -- N.B. check for conflicts between phase & hist names (unlikely!)
1327            # loop over phase blocks
1328            if len(self.Phases) > 1:
1329                loopprefix = ''
1330                WriteCIFitem('loop_   _pd_phase_block_id')
1331            else:
1332                loopprefix = '_pd_phase_block_id'
1333           
1334            for phasenam in sorted(self.Phases.keys()):
1335                i = self.Phases[phasenam]['pId']
1336                datablockidDict[phasenam] = (str(self.CIFdate) + "|" + str(self.CIFname) + "|" +
1337                             'phase_'+ str(i) + '|' + str(self.shortauthorname))
1338                WriteCIFitem(loopprefix,datablockidDict[phasenam])
1339            # loop over data blocks
1340            if len(self.powderDict) + len(self.xtalDict) > 1:
1341                loopprefix = ''
1342                WriteCIFitem('loop_   _pd_block_diffractogram_id')
1343            else:
1344                loopprefix = '_pd_block_diffractogram_id'
1345            for i in sorted(self.powderDict.keys()):
1346                hist = self.powderDict[i]
1347                histblk = self.Histograms[hist]
1348                instnam = histblk["Sample Parameters"]['InstrName']
1349                instnam = instnam.replace(' ','')
1350                i = histblk['hId']
1351                datablockidDict[hist] = (str(self.CIFdate) + "|" + str(self.CIFname) + "|" +
1352                                         str(self.shortauthorname) + "|" +
1353                                         instnam + "_hist_"+str(i))
1354                WriteCIFitem(loopprefix,datablockidDict[hist])
1355            for i in sorted(self.xtalDict.keys()):
1356                hist = self.xtalDict[i]
1357                histblk = self.Histograms[hist]
1358                instnam = histblk["Instrument Parameters"][0]['InstrName']
1359                instnam = instnam.replace(' ','')
1360                i = histblk['hId']
1361                datablockidDict[hist] = (str(self.CIFdate) + "|" + str(self.CIFname) + "|" +
1362                                         str(self.shortauthorname) + "|" +
1363                                         instnam + "_hist_"+str(i))
1364                WriteCIFitem(loopprefix,datablockidDict[hist])
1365            #============================================================
1366            # loop over phases, exporting them
1367            phasebyhistDict = {} # create a cross-reference to phases by histogram
1368            for j,phasenam in enumerate(sorted(self.Phases.keys())):
1369                i = self.Phases[phasenam]['pId']
1370                WriteCIFitem('\ndata_'+self.CIFname+"_phase_"+str(i))
1371                print "debug, processing ",phasenam
1372                WriteCIFitem('# Information for phase '+str(i))
1373                WriteCIFitem('_pd_block_id',datablockidDict[phasenam])
1374                # report the phase
1375                WritePhaseTemplate()
1376                WritePhaseInfo(phasenam)
1377                # preferred orientation
1378                SH = FormatSH(phasenam)
1379                MD = FormatHAPpo(phasenam)
1380                if SH and MD:
1381                    WriteCIFitem('_pd_proc_ls_pref_orient_corr', SH + '\n' + MD)
1382                elif SH or MD:
1383                    WriteCIFitem('_pd_proc_ls_pref_orient_corr', SH + MD)
1384                else:
1385                    WriteCIFitem('_pd_proc_ls_pref_orient_corr', 'none')
1386                # report sample profile terms
1387                PP = FormatPhaseProfile(phasenam)
1388                if PP:
1389                    WriteCIFitem('_pd_proc_ls_profile_function',PP)
1390                   
1391            #============================================================
1392            # loop over histograms, exporting them
1393            for i in sorted(self.powderDict.keys()):
1394                hist = self.powderDict[i]
1395                histblk = self.Histograms[hist]
1396                if hist.startswith("PWDR"): 
1397                    WriteCIFitem('\ndata_'+self.CIFname+"_pwd_"+str(i))
1398                    #instnam = histblk["Sample Parameters"]['InstrName']
1399                    # report instrumental profile terms
1400                    WriteCIFitem('_pd_proc_ls_profile_function',
1401                        FormatInstProfile(histblk["Instrument Parameters"],histblk['hId']))
1402                    WriteCIFitem('# Information for histogram '+str(i)+': '+hist)
1403                    WriteCIFitem('_pd_block_id',datablockidDict[hist])
1404                    WritePowderTemplate()
1405                    WritePowderData(hist)
1406            for i in sorted(self.xtalDict.keys()):
1407                hist = self.xtalDict[i]
1408                histblk = self.Histograms[hist]
1409                if hist.startswith("HKLF"): 
1410                    WriteCIFitem('\ndata_'+self.CIFname+"_sx_"+str(i))
1411                    #instnam = histblk["Instrument Parameters"][0]['InstrName']
1412                    WriteCIFitem('# Information for histogram '+str(i)+': '+hist)
1413                    WriteCIFitem('_pd_block_id',datablockidDict[hist])
1414                    WriteSnglXtalTemplate()
1415                    WriteSingleXtalData(hist)
1416
1417        WriteCIFitem('#--' + 15*'eof--' + '#')
1418        closeCIF()
Note: See TracBrowser for help on using the repository browser.