source: trunk/exports/G2cif.py @ 1037

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

more residuals in cif fixes??

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