source: trunk/exports/G2cif.py @ 1022

Last change on this file since 1022 was 1022, checked in by toby, 9 years ago

fix error on adding an atom to a new phase before Draw Options are initialized

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