source: trunk/exports/G2cif.py @ 1044

Last change on this file since 1044 was 1044, checked in by vondreele, 9 years ago

provide example for form factor cif stuff (no new code)

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