source: trunk/exports/G2cif.py @ 989

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

add constraint derivs for single xtal; allow cellFill to work without esds; update docs; fix controls copy bug

  • Property svn:eol-style set to native
File size: 49.6 KB
Line 
1'''Development code to export a GSAS-II project as a CIF
2The heavy lifting is done in method export
3'''
4
5import datetime as dt
6import os.path
7import GSASIIIO as G2IO
8#reload(G2IO)
9import GSASIIgrid as G2gd
10import GSASIIstrIO as G2stIO
11#reload(G2stIO)
12#import GSASIImapvars as G2mv
13import GSASIImath as G2mth
14reload(G2mth)
15import GSASIIlattice as G2lat
16import GSASIIspc as G2spg
17#reload(G2spg)
18
19def getCallerDocString(): # for development
20    "Return the calling function's doc string"
21    import inspect as ins
22    for item in ins.stack()[1][0].f_code.co_consts:
23        if type(item) is str:
24            return item
25    else:
26        return '?'
27
28class ExportCIF(G2IO.ExportBaseclass):
29    def __init__(self,G2frame):
30        super(self.__class__,self).__init__( # fancy way to say <parentclass>.__init__
31            G2frame=G2frame,
32            formatName = 'full CIF',
33            longFormatName = 'Export project as complete CIF'
34            )
35        self.author = ''
36
37    def export(self,mode='full'):
38        '''Export a CIF
39
40        :param str mode: "full" (default) to create a complete CIF of project,
41          "simple" for a simple CIF with only coordinates
42        '''
43   
44        def WriteCIFitem(name,value=''):
45            if value:
46                if "\n" in value or len(value)> 70:
47                    if name.strip(): print name
48                    print '; '+value
49                    print '; '
50                elif " " in value:
51                    if len(name)+len(value) > 65:
52                        print name,'\n   ','"' + str(value) + '"'
53                    else:
54                        print name,'  ','"' + str(value) + '"'
55                else:
56                    if len(name)+len(value) > 65:
57                        print name,'\n   ',value
58                    else:
59                        print name,'  ',value
60            else:
61                print name
62
63        def WriteAudit():
64            WriteCIFitem('_audit_creation_method',
65                         'created in GSAS-II')
66            WriteCIFitem('_audit_creation_date',self.CIFdate)
67            if self.author:
68                WriteCIFitem('_audit_author_name',self.author)
69            WriteCIFitem('_audit_update_record',
70                         self.CIFdate+'  Initial software-generated CIF')
71
72        def WriteOverall():
73            '''Write out overall refinement information.
74
75            More could be done here, but this is a good start.
76            '''
77            WriteCIFitem('_pd_proc_info_datetime', self.CIFdate)
78            WriteCIFitem('_pd_calc_method', 'Rietveld Refinement')
79            #WriteCIFitem('_refine_ls_shift/su_max',DAT1)
80            #WriteCIFitem('_refine_ls_shift/su_mean',DAT2)
81            WriteCIFitem('_computing_structure_refinement','GSAS-II')
82            try:
83                vars = str(len(self.OverallParms['Covariance']['varyList']))
84            except:
85                vars = '?'
86            WriteCIFitem('_refine_ls_number_parameters',vars)
87            try:
88                GOF = G2mth.ValEsd(self.OverallParms['Covariance']['Rvals']['GOF'],-0.009)
89            except:
90                GOF = '?'
91            WriteCIFitem('_refine_ls_goodness_of_fit_all',GOF)
92
93            # get restraint info
94            # restraintDict = self.OverallParms.get('Restraints',{})
95            # for i in  self.OverallParms['Constraints']:
96            #     print i
97            #     for j in self.OverallParms['Constraints'][i]:
98            #         print j
99            #WriteCIFitem('_refine_ls_number_restraints',TEXT)
100           
101            # other things to consider reporting
102            # _refine_ls_number_reflns
103            # _refine_ls_goodness_of_fit_obs
104            # _refine_ls_R_factor_all
105            # _refine_ls_R_factor_obs
106            # _refine_ls_wR_factor_all
107            # _refine_ls_wR_factor_obs
108            # _refine_ls_restrained_S_all
109            # _refine_ls_restrained_S_obs
110
111            # include an overall profile r-factor, if there is more than one powder histogram
112            if self.npowder > 1:
113                WriteCIFitem('\n# OVERALL POWDER R-FACTOR')
114                try:
115                    R = str(self.OverallParms['Covariance']['Rvals']['Rwp'])
116                except:
117                    R = '?'
118                WriteCIFitem('_pd_proc_ls_prof_wR_factor',R)
119                #WriteCIFitem('_pd_proc_ls_prof_R_factor',TEXT(11:20)) # who cares!
120            WriteCIFitem('_refine_ls_matrix_type','full')
121            #WriteCIFitem('_refine_ls_matrix_type','userblocks')
122
123        def WritePubTemplate():
124            '''TODO: insert the publication template ``template_publ.cif`` or some modified
125            version for this project. Store this in the GPX file?
126            '''
127            print getCallerDocString()
128
129        def WritePhaseTemplate():
130            '''TODO: insert the phase template ``template_phase.cif`` or some modified
131            version for this project
132            '''
133            print getCallerDocString()
134
135        def WritePowderTemplate():
136            '''TODO: insert the phase template ``template_instrument.cif`` or some modified
137            version for this project
138            '''
139            print getCallerDocString()
140
141        def WriteSnglXtalTemplate():
142            '''TODO: insert the single-crystal histogram template
143            for this project
144            '''
145            print getCallerDocString()
146
147        def FormatSH(phasenam):
148            'Format a full spherical harmonics texture description as a string'
149            phasedict = self.Phases[phasenam] # pointer to current phase info           
150            pfx = str(phasedict['pId'])+'::'
151            s = ""
152            textureData = phasedict['General']['SH Texture']   
153            if textureData.get('Order'):
154                s += "Spherical Harmonics correction. Order = "+str(textureData['Order'])
155                s += " Model: " + str(textureData['Model']) + "\n    Orientation angles: "
156                for name in ['omega','chi','phi']:
157                    aname = pfx+'SH '+name
158                    s += name + " = "
159                    sig = self.sigDict.get(aname,-0.09)
160                    s += G2mth.ValEsd(self.parmDict[aname],sig)
161                    s += "; "
162                s += "\n"
163                s1 = "    Coefficients:  "
164                for name in textureData['SH Coeff'][1]:
165                    aname = pfx+name
166                    if len(s1) > 60:
167                        s += s1 + "\n"
168                        s1 = "    "
169                    s1 += aname + ' = '
170                    sig = self.sigDict.get(aname,-0.0009)
171                    s1 += G2mth.ValEsd(self.parmDict[aname],sig)
172                    s1 += "; "
173                s += s1
174            return s
175
176        def FormatHAPpo(phasenam):
177            '''return the March-Dollase/SH correction for every
178            histogram in the current phase formatted into a
179            character string
180            '''
181            phasedict = self.Phases[phasenam] # pointer to current phase info           
182            s = ''
183            for histogram in sorted(phasedict['Histograms']):
184                if histogram.startswith("HKLF"): continue # powder only
185                Histogram = self.Histograms.get(histogram)
186                if not Histogram: continue
187                hapData = phasedict['Histograms'][histogram]
188                if hapData['Pref.Ori.'][0] == 'MD':
189                    aname = str(phasedict['pId'])+':'+str(Histogram['hId'])+':MD'
190                    if self.parmDict.get(aname,1.0) != 1.0: continue
191                    sig = self.sigDict.get(aname,-0.009)
192                    if s != "": s += '\n'
193                    s += 'March-Dollase correction'
194                    if self.npowder > 1:
195                        s += ', histogram '+str(Histogram['hId']+1)
196                    s += ' coef. = ' + G2mth.ValEsd(self.parmDict[aname],sig)
197                    s += ' axis = ' + str(hapData['Pref.Ori.'][3])
198                else: # must be SH
199                    if s != "": s += '\n'
200                    s += 'Simple spherical harmonic correction'
201                    if self.npowder > 1:
202                        s += ', histogram '+str(Histogram['hId']+1)
203                    s += ' Order = '+str(hapData['Pref.Ori.'][4])+'\n'
204                    s1 = "    Coefficients:  "
205                    for item in hapData['Pref.Ori.'][5]:
206                        print item
207                        aname = str(phasedict['pId'])+':'+str(Histogram['hId'])+':'+item
208                        print aname
209                        if len(s1) > 60:
210                            s += s1 + "\n"
211                            s1 = "    "
212                        s1 += aname + ' = '
213                        sig = self.sigDict.get(aname,-0.0009)
214                        s1 += G2mth.ValEsd(self.parmDict[aname],sig)
215                        s1 += "; "
216                    s += s1
217            return s
218
219        def FormatInstProfile(instparmdict):
220            '''Format the instrumental profile parameters with a
221            string description. Will only be called on PWDR histograms
222            '''
223            #print instparmdict[0].keys()
224            return 'TODO: Instrument profile goes here'
225
226        def FormatPhaseProfile(phasenam):
227            '''Format the phase-related profile parameters (size/strain)
228            with a string description.
229            return an empty string or None there are no
230            powder histograms for this phase.
231            '''
232            s = ''
233            phasedict = self.Phases[phasenam] # pointer to current phase info           
234            for histogram in sorted(phasedict['Histograms']):
235                if histogram.startswith("HKLF"): continue # powder only
236                Histogram = self.Histograms.get(histogram)
237                if not Histogram: continue
238                hapData = phasedict['Histograms'][histogram]
239            return 'TODO: Phase profile goes here'
240       
241        def FmtAtomType(sym):
242            'Reformat a GSAS-II atom type symbol to match CIF rules'
243            sym = sym.replace('_','') # underscores are not allowed: no isotope designation?
244            # in CIF, oxidation state sign symbols come after, not before
245            if '+' in sym:
246                sym = sym.replace('+','') + '+'
247            elif '-' in sym:
248                sym = sym.replace('-','') + '-'
249            return sym
250           
251        def PutInCol(val,wid):
252            '''Pad a value to >=wid+1 columns by adding spaces at the end. Always
253            adds at least one space
254            '''
255            val = str(val).replace(' ','')
256            if not val: val = '?'
257            fmt = '{:' + str(wid) + '} '
258            return fmt.format(val)
259
260        def MakeUniqueLabel(lbl,labellist):
261            'Make sure that every atom label is unique'
262            lbl = lbl.strip()
263            if not lbl: # deal with a blank label
264                lbl = 'A_1'
265            if lbl not in labellist:
266                labellist.append(lbl)
267                return lbl
268            i = 1
269            prefix = lbl
270            if '_' in lbl:
271                prefix = lbl[:lbl.rfind('_')]
272                suffix = lbl[lbl.rfind('_')+1:]
273                try:
274                    i = int(suffix)+1
275                except:
276                    pass
277            while prefix+'_'+str(i) in labellist:
278                i += 1
279            else:
280                lbl = prefix+'_'+str(i)
281                labellist.append(lbl)
282
283        def WriteAtomsNuclear(phasenam):
284            'Write atom positions to CIF'
285            phasedict = self.Phases[phasenam] # pointer to current phase info
286            General = phasedict['General']
287            cx,ct,cs,cia = General['AtomPtrs']
288            Atoms = phasedict['Atoms']
289            cfrac = cx+3
290            fpfx = str(phasedict['pId'])+'::Afrac:'       
291            for i,at in enumerate(Atoms):
292                fval = self.parmDict.get(fpfx+str(i),at[cfrac])
293                if fval != 0.0:
294                    break
295            else:
296                WriteCIFitem('\n# PHASE HAS NO ATOMS!')
297                return
298               
299            WriteCIFitem('\n# ATOMIC COORDINATES AND DISPLACEMENT PARAMETERS')
300            WriteCIFitem('loop_ '+
301                         '\n\t_atom_site_label'+
302                         '\n\t_atom_site_type_symbol'+
303                         '\n\t_atom_site_fract_x'+
304                         '\n\t_atom_site_fract_y'+
305                         '\n\t_atom_site_fract_z'+
306                         '\n\t_atom_site_occupancy'+
307                         '\n\t_atom_site_adp_type'+
308                         '\n\t_atom_site_U_iso_or_equiv'+
309                         '\n\t_atom_site_symmetry_multiplicity')
310
311            varnames = {cx:'Ax',cx+1:'Ay',cx+2:'Az',cx+3:'Afrac',
312                        cia+1:'AUiso',cia+2:'AU11',cia+3:'AU22',cia+4:'AU33',
313                        cia+5:'AU12',cia+6:'AU13',cia+7:'AU23'}
314            self.labellist = []
315           
316            pfx = str(phasedict['pId'])+'::'
317            # loop over all atoms
318            naniso = 0
319            for i,at in enumerate(Atoms):
320                s = PutInCol(MakeUniqueLabel(at[ct-1],self.labellist),6) # label
321                fval = self.parmDict.get(fpfx+str(i),at[cfrac])
322                if fval == 0.0: continue # ignore any atoms that have a occupancy set to 0 (exact)
323                s += PutInCol(FmtAtomType(at[ct]),4) # type
324                if at[cia] == 'I':
325                    adp = 'Uiso '
326                else:
327                    adp = 'Uani '
328                    naniso += 1
329                    # compute Uequiv crudely
330                    # correct: Defined as "1/3 trace of diagonalized U matrix".
331                    # SEE cell2GS & Uij2Ueqv to GSASIIlattice. Former is needed to make the GS matrix used by the latter.
332                    t = 0.0
333                    for j in (2,3,4):
334                        var = pfx+varnames[cia+j]+":"+str(i)
335                        t += self.parmDict.get(var,at[cia+j])
336                for j in (cx,cx+1,cx+2,cx+3,cia+1):
337                    if j in (cx,cx+1,cx+2):
338                        dig = 11
339                        sigdig = -0.00009
340                    else:
341                        dig = 10
342                        sigdig = -0.009
343                    var = pfx+varnames[j]+":"+str(i)
344                    dvar = pfx+"d"+varnames[j]+":"+str(i)
345                    if dvar not in self.sigDict:
346                        dvar = var
347                    if j == cia+1 and adp == 'Uani ':
348                        val = t/3.
349                        sig = sigdig
350                    else:
351                        #print var,(var in self.parmDict),(var in self.sigDict)
352                        val = self.parmDict.get(var,at[j])
353                        sig = self.sigDict.get(dvar,sigdig)
354                    s += PutInCol(G2mth.ValEsd(val,sig),dig)
355                s += adp
356                s += PutInCol(at[cs+1],3)
357                WriteCIFitem(s)
358            if naniso == 0: return
359            # now loop over aniso atoms
360            WriteCIFitem('\nloop_' + '\n\t_atom_site_aniso_label' + 
361                         '\n\t_atom_site_aniso_U_11' + '\n\t_atom_site_aniso_U_12' +
362                         '\n\t_atom_site_aniso_U_13' + '\n\t_atom_site_aniso_U_22' +
363                         '\n\t_atom_site_aniso_U_23' + '\n\t_atom_site_aniso_U_33')
364            for i,at in enumerate(Atoms):
365                fval = self.parmDict.get(fpfx+str(i),at[cfrac])
366                if fval == 0.0: continue # ignore any atoms that have a occupancy set to 0 (exact)
367                if at[cia] == 'I': continue
368                s = PutInCol(self.labellist[i],6) # label
369                for j in (2,3,4,5,6,7):
370                    sigdig = -0.0009
371                    var = pfx+varnames[cia+j]+":"+str(i)
372                    val = self.parmDict.get(var,at[cia+j])
373                    sig = self.sigDict.get(var,sigdig)
374                    s += PutInCol(G2mth.ValEsd(val,sig),11)
375                WriteCIFitem(s)
376
377        def HillSortElements(elmlist):
378            '''Sort elements in "Hill" order: C, H, others, (where others
379            are alphabetical).
380
381            :params list elmlist: a list of element strings
382
383            :returns: a sorted list of element strings
384            '''
385            newlist = []
386            oldlist = elmlist[:]
387            for elm in ('C','H'):
388                if elm in elmlist:
389                    newlist.append(elm)
390                    oldlist.pop(oldlist.index(elm))
391            return newlist+sorted(oldlist)
392
393        def WriteComposition(phasenam):
394            '''determine the composition for the unit cell, crudely determine Z and
395            then compute the composition in formula units
396            '''
397            phasedict = self.Phases[phasenam] # pointer to current phase info
398            General = phasedict['General']
399            Z = General.get('cellZ',0.0)
400            cx,ct,cs,cia = General['AtomPtrs']
401            Atoms = phasedict['Atoms']
402            fpfx = str(phasedict['pId'])+'::Afrac:'       
403            cfrac = cx+3
404            cmult = cs+1
405            compDict = {} # combines H,D & T
406            sitemultlist = []
407            massDict = dict(zip(General['AtomTypes'],General['AtomMass']))
408            cellmass = 0
409            for i,at in enumerate(Atoms):
410                atype = at[ct].strip()
411                if atype.find('-') != -1: atype = atype.split('-')[0]
412                if atype.find('+') != -1: atype = atype.split('+')[0]
413                atype = atype[0].upper()+atype[1:2].lower() # force case conversion
414                if atype == "D" or atype == "D": atype = "H"
415                fvar = fpfx+str(i)
416                fval = self.parmDict.get(fvar,at[cfrac])
417                mult = at[cmult]
418                if not massDict.get(at[ct]):
419                    print 'No mass found for atom type '+at[ct]
420                    print 'Will not compute cell contents for phase '+phasenam
421                    return
422                cellmass += massDict[at[ct]]*mult*fval
423                compDict[atype] = compDict.get(atype,0.0) + mult*fval
424                if fval == 1: sitemultlist.append(mult)
425            if len(compDict.keys()) == 0: return # no elements!
426            if Z < 1: # Z has not been computed or set by user
427                Z = 1
428                for i in range(2,min(sitemultlist)+1):
429                    for m in sitemultlist:
430                        if m % i != 0:
431                            break
432                        else:
433                            Z = i
434                General['cellZ'] = Z # save it
435
436            # when scattering factors are included in the CIF, this needs to be
437            # added to the loop here but only in the one-block case.
438            # For multiblock CIFs, scattering factors go in the histogram
439            # blocks  (for all atoms in all appropriate phases)
440
441            #if oneblock: # add scattering factors for current phase here
442            WriteCIFitem('\nloop_  _atom_type_symbol _atom_type_number_in_cell')
443            formula = ''
444            reload(G2mth)
445            for elem in HillSortElements(compDict.keys()):
446                WriteCIFitem('  ' + PutInCol(elem,4) +
447                             G2mth.ValEsd(compDict[elem],-0.009,True))
448                if formula: formula += " "
449                formula += elem
450                if compDict[elem] == Z: continue
451                formula += G2mth.ValEsd(compDict[elem]/Z,-0.009,True)
452            WriteCIFitem( '\n# Note that Z affects _cell_formula_sum and _weight')
453            WriteCIFitem( '_cell_formula_units_Z',str(Z))
454            WriteCIFitem( '_chemical_formula_sum',formula)
455            WriteCIFitem( '_chemical_formula_weight',
456                          G2mth.ValEsd(cellmass/Z,-0.09,True))
457
458        def WriteDistances(phasenam,SymOpList,offsetList,symOpList,G2oprList):
459            '''Report bond distances and angles for the CIF
460
461            Note that _geom_*_symmetry_* fields are values of form
462            n_klm where n is the symmetry operation in SymOpList (counted
463            starting with 1) and (k-5, l-5, m-5) are translations to add
464            to (x,y,z). See
465            http://www.iucr.org/__data/iucr/cifdic_html/1/cif_core.dic/Igeom_angle_site_symmetry_.html
466
467            TODO: need a method to select publication flags for distances/angles
468            '''
469            phasedict = self.Phases[phasenam] # pointer to current phase info           
470            Atoms = phasedict['Atoms']
471            cx,ct,cs,cia = phasedict['General']['AtomPtrs']
472            fpfx = str(phasedict['pId'])+'::Afrac:'       
473            cfrac = cx+3
474            # loop over interatomic distances for this phase
475            WriteCIFitem('\n# MOLECULAR GEOMETRY')
476            WriteCIFitem('loop_' + 
477                         '\n\t_geom_bond_atom_site_label_1' +
478                         '\n\t_geom_bond_atom_site_label_2' + 
479                         '\n\t_geom_bond_distance' + 
480                         '\n\t_geom_bond_site_symmetry_1' + 
481                         '\n\t_geom_bond_site_symmetry_2' + 
482                         '\n\t_geom_bond_publ_flag')
483
484            # Note that labels should be read from self.labellist to correspond
485            # to the values reported in the atoms table and zero occupancy atoms
486            # should not be included
487            fpfx = str(phasedict['pId'])+'::Afrac:'       
488            for i,at in enumerate(Atoms):
489                if self.parmDict.get(fpfx+str(i),at[cfrac]) == 0.0: continue
490                lbl = self.labellist[i]
491
492
493            # loop over interatomic angles for this phase
494            WriteCIFitem('loop_' + 
495                         '\n\t_geom_angle_atom_site_label_1' + 
496                         '\n\t_geom_angle_atom_site_label_2' + 
497                         '\n\t_geom_angle_atom_site_label_3' + 
498                         '\n\t_geom_angle' + 
499                         '\n\t_geom_angle_site_symmetry_1' +
500                         '\n\t_geom_angle_site_symmetry_2' + 
501                         '\n\t_geom_angle_site_symmetry_3' + 
502                         '\n\t_geom_angle_publ_flag')
503
504
505        def WritePhaseInfo(phasenam):
506            WriteCIFitem('\n# phase info for '+str(phasenam) + ' follows')
507            phasedict = self.Phases[phasenam] # pointer to current phase info           
508            WriteCIFitem('_pd_phase_name', phasenam)
509            pfx = str(phasedict['pId'])+'::'
510            A,sigA = G2stIO.cellFill(pfx,phasedict['General']['SGData'],self.parmDict,self.sigDict)
511            cellSig = G2stIO.getCellEsd(pfx,
512                                       phasedict['General']['SGData'],A,
513                                       self.OverallParms['Covariance'])  # returns 7 vals, includes sigVol
514            cellList = G2lat.A2cell(A) + (G2lat.calc_V(A),)
515            defsigL = 3*[-0.00001] + 3*[-0.001] + [-0.01] # significance to use when no sigma
516            names = ['length_a','length_b','length_c',
517                     'angle_alpha','angle_beta ','angle_gamma',
518                     'volume']
519            prevsig = 0
520            for lbl,defsig,val,sig in zip(names,defsigL,cellList,cellSig):
521                if sig:
522                    txt = G2mth.ValEsd(val,sig)
523                    prevsig = -sig # use this as the significance for next value
524                else:
525                    txt = G2mth.ValEsd(val,min(defsig,prevsig),True)
526                WriteCIFitem('_cell_'+lbl,txt)
527                   
528            WriteCIFitem('_symmetry_cell_setting',
529                         phasedict['General']['SGData']['SGSys'])
530
531            spacegroup = phasedict['General']['SGData']['SpGrp'].strip()
532            # regularize capitalization and remove trailing H/R
533            spacegroup = spacegroup[0].upper() + spacegroup[1:].lower().rstrip('rh ')
534            WriteCIFitem('_symmetry_space_group_name_H-M',spacegroup)
535
536            # generate symmetry operations including centering and center of symmetry
537            SymOpList,offsetList,symOpList,G2oprList = G2spg.AllOps(
538                phasedict['General']['SGData'])
539            WriteCIFitem('loop_ _space_group_symop_id _space_group_symop_operation_xyz')
540            for i,op in enumerate(SymOpList,start=1):
541                WriteCIFitem('   {:3d}  {:}'.format(i,op.lower()))
542
543            # loop over histogram(s) used in this phase
544            if not oneblock and not self.quickmode:
545                # report pointers to the histograms used in this phase
546                histlist = []
547                for hist in self.Phases[phasenam]['Histograms']:
548                    if self.Phases[phasenam]['Histograms'][hist]['Use']:
549                        if phasebyhistDict.get(hist):
550                            phasebyhistDict[hist].append(phasenam)
551                        else:
552                            phasebyhistDict[hist] = [phasenam,]
553                        blockid = datablockidDict.get(hist)
554                        if not blockid:
555                            print "Internal error: no block for data. Phase "+str(
556                                phasenam)+" histogram "+str(hist)
557                            histlist = []
558                            break
559                        histlist.append(blockid)
560
561                if len(histlist) == 0:
562                    WriteCIFitem('# Note: phase has no associated data')
563                else:
564                    WriteCIFitem('loop_  _pd_block_diffractogram_id')
565
566            # report atom params
567            if phasedict['General']['Type'] == 'nuclear':        #this needs macromolecular variant, etc!
568                WriteAtomsNuclear(phasenam)
569            else:
570                raise Exception,"no export for mm coordinates implemented"
571            # report cell contents
572            WriteComposition(phasenam)
573            if not self.quickmode:      # report distances and angles
574                WriteDistances(phasenam,SymOpList,offsetList,symOpList,G2oprList)
575
576        def WritePowderData(histlbl):
577            text = '?'
578            histblk = self.Histograms[histlbl]
579            inst = histblk['Instrument Parameters'][0]
580            hId = histblk['hId']
581            pfx = ':' + str(hId) + ':'
582            print 'TODO: powder here data for',histblk["Sample Parameters"]['InstrName']
583            # see wrpowdhist.for & wrreflist.for
584           
585            #refprx = '_refln.' # mm
586            refprx = '_refln_' # normal
587
588            WriteCIFitem('\n# SCATTERING FACTOR INFO')
589            if 'Lam1' in inst:
590                ratio = self.parmDict.get('I(L2)/I(L1)',inst['I(L2)/I(L1)'][1])
591                sratio = self.sigDict.get('I(L2)/I(L1)',-0.0009)
592                lam1 = self.parmDict.get('Lam1',inst['Lam1'][1])
593                slam1 = self.sigDict.get('Lam1',-0.00009)
594                lam2 = self.parmDict.get('Lam2',inst['Lam2'][1])
595                slam2 = self.sigDict.get('Lam2',-0.00009)
596                # always assume Ka1 & Ka2 if two wavelengths are present
597                WriteCIFitem('loop_' + 
598                             '\n\t_diffrn_radiation_wavelength' +
599                             '\n\t_diffrn_radiation_wavelength_wt' + 
600                             '\n\t_diffrn_radiation_type' + 
601                             '\n\t_diffrn_radiation_wavelength_id')
602                WriteCIFitem('  ' + PutInCol(G2mth.ValEsd(lam1,slam1),15)+
603                             PutInCol('1.0',15) + 
604                             PutInCol('K\\a~1~',10) + 
605                             PutInCol('1',5))
606                WriteCIFitem('  ' + PutInCol(G2mth.ValEsd(lam2,slam2),15)+
607                             PutInCol(G2mth.ValEsd(ratio,sratio),15)+
608                             PutInCol('K\\a~2~',10) + 
609                             PutInCol('2',5))               
610            else:
611                lam1 = self.parmDict.get('Lam',inst['Lam'])
612                slam1 = self.sigDict.get('Lam',-0.00009)
613                WriteCIFitem('_diffrn_radiation_wavelength',G2mth.ValEsd(lam1,slam1))
614
615
616            if not oneblock:
617                if not phasebyhistDict.get(histlbl):
618                    WriteCIFitem('\n# No phases associated with this data set')
619                else:
620                    WriteCIFitem('\n# PHASE TABLE')
621                    WriteCIFitem('loop_' +
622                                 '\n\t_pd_phase_id' + 
623                                 '\n\t_pd_phase_block_id' + 
624                                 '\n\t_pd_phase_mass_%')
625                    wtFrSum = 0.
626                    for phasenam in phasebyhistDict.get(histlbl):
627                        hapData = self.Phases[phasenam]['Histograms'][histlbl]
628                        General = self.Phases[phasenam]['General']
629                        wtFrSum += hapData['Scale'][0]*General['Mass']
630
631                    for phasenam in phasebyhistDict.get(histlbl):
632                        hapData = self.Phases[phasenam]['Histograms'][histlbl]
633                        General = self.Phases[phasenam]['General']
634                        wtFr = hapData['Scale'][0]*General['Mass']/wtFrSum
635                        pfx = str(self.Phases[phasenam]['pId'])+':'+str(hId)+':'
636                        if pfx+'Scale' in self.sigDict:
637                            sig = self.sigDict[pfx+'Scale']*wtFr/hapData['Scale'][0]
638                        else:
639                            sig = -0.0001
640                        WriteCIFitem(
641                            '  '+
642                            str(self.Phases[phasenam]['pId']) +
643                            '  '+datablockidDict[phasenam]+
644                            '  '+G2mth.ValEsd(wtFr,sig)
645                            )
646
647            # this will need help from Bob
648            # WriteCIFitem('_pd_proc_ls_prof_R_factor','?')
649            # WriteCIFitem('_pd_proc_ls_prof_wR_factor','?')
650            # WriteCIFitem('_pd_proc_ls_prof_wR_expected','?')
651            # WriteCIFitem('_refine_ls_R_Fsqd_factor','?')
652
653            phasenam = self.Phases.keys()[0]
654            for key in self.Phases[phasenam]['Histograms']:
655                print key
656                print '------------'
657                print self.Phases[phasenam]['Histograms'][key]
658            raise Exception, "testing"
659            print histblk.keys()
660            for key in histblk:
661                print key,histblk[key]
662            print inst
663            #print self.parmDict.keys()
664            #print self.sigDict.keys()
665           
666            #WriteCIFitem('_pd_meas_2theta_fixed',text)
667            WriteCIFitem('_diffrn_radiation_probe','x-ray')
668            WriteCIFitem('_diffrn_radiation_probe','neutron')
669            WriteCIFitem('_diffrn_radiation_polarisn_ratio','?')
670           
671            WriteCIFitem('loop_  _atom_type_symbol')
672            if oneblock:
673                WriteCIFitem('       _atom_type_number_in_cell')
674            #IF (HTYP(2:2) .eq. 'X' .AND. HTYP(3:3) .ne. 'E') THEN
675            WriteCIFitem('      _atom_type_scat_dispersion_real')
676            WriteCIFitem('      _atom_type_scat_dispersion_imag')
677            for lbl in ('a1','a2','a3', 'a4', 'b1', 'b2', 'b3', 'b4', 'c'):
678                WriteCIFitem('      _atom_type_scat_Cromer_Mann_'+lbl)
679            #ELSEIF (HTYP(2:2) .eq. 'N') THEN
680            WriteCIFitem('      _atom_type_scat_length_neutron')
681            #ENDIF
682            WriteCIFitem('      _atom_type_scat_source')
683
684            #C document the background function used
685            WriteCIFitem('_pd_proc_ls_background_function','?')
686
687            WriteCIFitem('_exptl_absorpt_process_details','?')
688            WriteCIFitem('_exptl_absorpt_correction_T_min','?')
689            WriteCIFitem('_exptl_absorpt_correction_T_max','?')
690            #C extinction
691            #WRITE(IUCIF,'(A)') '# Extinction correction'
692            #CALL WRVAL(IUCIF,'_gsas_exptl_extinct_corr_T_min',TEXT(1:10))
693            #CALL WRVAL(IUCIF,'_gsas_exptl_extinct_corr_T_max',TEXT(11:20))
694
695            if not oneblock:
696                # instrumental profile terms go here
697                WriteCIFitem('_pd_proc_ls_profile_function','?')
698
699            #print 'Data'
700            #for item in histblk['Data']:
701            #    print item
702                #try:
703                #    print key,histblk[key].keys()
704                #except:
705                #    print key
706                #    print histblk[key]
707            #print 'Background'
708            print histblk['Reflection Lists']['Garnet'][1]
709            for i in range(0,80):
710                for j in [0,1,2,13]:
711                    print histblk['Reflection Lists']['Garnet'][i][j],
712                print
713                #print histblk['Reflection Lists']['Garnet'][i][12].shape
714                #print histblk['Reflection Lists']['Garnet'][i][14]
715            #print histblk['Background'][0]
716            #print histblk['Background'][1]
717            import numpy as np
718            refList = np.array([refl[:11] for refl in histblk['Reflection Lists']['Garnet']])
719            #refList = histblk['Reflection Lists']['Garnet']
720            Icorr = np.array([refl[13] for refl in histblk['Reflection Lists']['Garnet']])
721            FO2 = np.array([refl[8] for refl in histblk['Reflection Lists']['Garnet']])
722            print Icorr
723            I100 = refList.T[8]*Icorr
724            print I100
725            print I100/max(I100)
726            Icorr = np.array([refl[13] for refl in histblk['Reflection Lists']['Garnet']]) * np.array([refl[8] for refl in histblk['Reflection Lists']['Garnet']])
727            print I100/max(I100)
728
729            WriteCIFitem('\n# STRUCTURE FACTOR TABLE')           
730            WriteCIFitem('loop_' + 
731                         '\n\t' + refprx + 'index_h' + 
732                         '\n\t' + refprx + 'index_k' + 
733                         '\n\t' + refprx + 'index_l' + 
734                         '\n\t_pd_refln_wavelength_id' +
735                         '\n\t_pd_refln_phase_id' + 
736                         '\n\t' + refprx + 'status' + 
737                         '\n\t' + refprx + 'F_squared_meas' + 
738                         '\n\t' + refprx + 'F_squared_sigma' + 
739                         '\n\t' + refprx + 'F_squared_calc' + 
740                         '\n\t' + refprx + 'phase_calc' + 
741                         '\n\t_pd_refln_d_spacing' + 
742                         '\n\t_gsas_i100_meas')
743
744            WriteCIFitem('_reflns_number_total', text)
745            WriteCIFitem('_reflns_limit_h_min', text)
746            WriteCIFitem('_reflns_limit_h_max', text)
747            WriteCIFitem('_reflns_limit_k_min', text)
748            WriteCIFitem('_reflns_limit_k_max', text)
749            WriteCIFitem('_reflns_limit_l_min', text)
750            WriteCIFitem('_reflns_limit_l_max', text)
751            WriteCIFitem('_reflns_d_resolution_high', text)
752            WriteCIFitem('_reflns_d_resolution_low', text)
753           
754            WriteCIFitem('\n# POWDER DATA TABLE')
755            # is data fixed step?
756            fixedstep = False
757            # are ESDs sqrt(I)
758            countsdata = False
759            zero = 0.01
760            if fixedstep:
761                WriteCIFitem('_pd_meas_2theta_range_min', text)
762                WriteCIFitem('_pd_meas_2theta_range_max', text)
763                WriteCIFitem('_pd_meas_2theta_range_inc', text)
764                # zero correct
765                if zero != 0.0:
766                    WriteCIFitem('_pd_proc_2theta_range_min', text)
767                    WriteCIFitem('_pd_proc_2theta_range_max', text)
768                    WriteCIFitem('_pd_proc_2theta_range_inc', text)
769            WriteCIFitem('loop_' +
770                         '\n\t_pd_proc_d_spacing')
771                         #'_pd_meas_time_of_flight'
772            if not fixedstep:
773                if zero != 0.0:
774                    WriteCIFitem('\t_pd_proc_2theta_corrected')
775                else:
776                    WriteCIFitem('\t_pd_meas_2theta_scan')
777            if countsdata:
778                WriteCIFitem('\t_pd_meas_counts_total')
779            else:
780                WriteCIFitem('\t_pd_meas_intensity_total')
781            WriteCIFitem('\t_pd_proc_ls_weight')
782            WriteCIFitem('\t_pd_proc_intensity_bkg_calc')
783            WriteCIFitem('\t_pd_calc_intensity_total')
784            if zero != 0.0:
785                WriteCIFitem('_pd_proc_number_of_points', text)
786            else:
787                WriteCIFitem('_pd_meas_number_of_points', text)
788                         
789        def WriteSingleXtalData(histlbl):
790            histblk = self.Histograms[histlbl]
791            print 'TODO: single xtal here data for',histblk["Instrument Parameters"][0]['InstrName']
792            # see wrreflist.for
793            refprx = '_refln.' # mm
794            refprx = '_refln_' # normal
795           
796            WriteCIFitem('\n# STRUCTURE FACTOR TABLE')           
797            WriteCIFitem('loop_' + 
798                         '\n\t' + refprx + 'index_h' + 
799                         '\n\t' + refprx + 'index_k' + 
800                         '\n\t' + refprx + 'index_l' + 
801                         '\n\t' + refprx + 'status' + 
802                         '\n\t' + refprx + 'F_squared_meas' + 
803                         '\n\t' + refprx + 'F_squared_sigma' + 
804                         '\n\t' + refprx + 'F_squared_calc' + 
805                         '\n\t' + refprx + 'phase_calc')
806            WriteCIFitem('_reflns_number_total', text)
807            WriteCIFitem('_reflns_number_observed', text)
808            WriteCIFitem('_reflns_limit_h_min', text)
809            WriteCIFitem('_reflns_limit_h_max', text)
810            WriteCIFitem('_reflns_limit_k_min', text)
811            WriteCIFitem('_reflns_limit_k_max', text)
812            WriteCIFitem('_reflns_limit_l_min', text)
813            WriteCIFitem('_reflns_limit_l_max', text)
814            WriteCIFitem('_reflns_d_resolution_high', text)
815            WriteCIFitem('_reflns_d_resolution_low', text)
816
817        #============================================================
818        # the export process starts here
819        # also load all of the tree into a set of dicts
820        self.loadTree()
821        #self.dumpTree()
822        # create a dict with refined values and their uncertainties
823        self.loadParmDict()
824        #
825
826        # get restraint info
827        #restraintDict = self.OverallParms.get('Restraints',{})
828        #for i in  self.OverallParms['Constraints']:
829        #    print i
830        #    for j in self.OverallParms['Constraints'][i]:
831        #        print j
832        #return
833
834        self.CIFdate = dt.datetime.strftime(dt.datetime.now(),"%Y-%m-%dT%H:%M")
835        # count phases, powder and single crystal histograms
836        self.nphase = len(self.Phases)
837        self.npowder = 0
838        self.nsingle = 0
839        for hist in self.Histograms:
840            if hist.startswith("PWDR"): 
841                self.npowder += 1
842            elif hist.startswith("HKLF"): 
843                self.nsingle += 1
844        # is there anything to export?
845        if self.nphase + self.npowder + self.nsingle == 0: 
846            self.G2frame.ErrorDialog(
847                'Empty project',
848                'No data or phases to include in CIF')
849            return
850        # is there a file name defined?
851        self.CIFname = os.path.splitext(
852            os.path.split(self.G2frame.GSASprojectfile)[1]
853            )[0]
854        self.CIFname = self.CIFname.replace(' ','')
855        if not self.CIFname:
856            self.G2frame.ErrorDialog(
857                'No GPX name',
858                'Please save the project to provide a name')
859            return
860        # test for quick CIF mode or no data
861        self.quickmode = False
862        phasenam = phasenum = None # include all phases
863        if mode != "full" or self.npowder + self.nsingle == 0:
864            self.quickmode = True
865            oneblock = True
866            if self.nphase == 0:
867                self.G2frame.ErrorDialog(
868                    'No phase present',
869                    'Cannot create a coordinates CIF with no phases')
870                return
871            elif self.nphase > 1: # quick mode: choose one phase
872                choices = sorted(self.Phases.keys())
873                phasenum = G2gd.ItemSelector(choices,self.G2frame)
874                if phasenum is None: return
875                phasenam = choices[phasenum]
876        # will this require a multiblock CIF?
877        elif self.nphase > 1:
878            oneblock = False
879        elif self.npowder + self.nsingle > 1:
880            oneblock = False
881        else: # one phase, one dataset, Full CIF
882            oneblock = True
883
884        # make sure needed infomation is present
885        # get CIF author name -- required for full CIFs
886        try:
887            self.author = self.OverallParms['Controls'].get("Author",'').strip()
888        except KeyError:
889            pass
890        while not (self.author or self.quickmode):
891            dlg = G2gd.SingleStringDialog(self.G2frame,'Get CIF Author','Provide CIF Author name (Last, First)')
892            if not dlg.Show(): return # cancel was pressed
893            self.author = dlg.GetValue()
894            dlg.Destroy()
895        try:
896            self.OverallParms['Controls']["Author"] = self.author # save for future
897        except KeyError:
898            pass
899        self.shortauthorname = self.author.replace(',','').replace(' ','')[:20]
900
901        # check the instrument name for every histogram
902        if not self.quickmode:
903            dictlist = []
904            keylist = []
905            lbllist = []
906            invalid = 0
907            key3 = 'InstrName'
908            for hist in self.Histograms:
909                if hist.startswith("PWDR"): 
910                    key2 = "Sample Parameters"
911                    d = self.Histograms[hist][key2]
912                elif hist.startswith("HKLF"): 
913                    key2 = "Instrument Parameters"
914                    d = self.Histograms[hist][key2][0]
915                   
916                lbllist.append(hist)
917                dictlist.append(d)
918                keylist.append(key3)
919                instrname = d.get(key3)
920                if instrname is None:
921                    d[key3] = ''
922                    invalid += 1
923                elif instrname.strip() == '':
924                    invalid += 1
925            if invalid:
926                msg = ""
927                if invalid > 3: msg = (
928                    "\n\nNote: it may be faster to set the name for\n"
929                    "one histogram for each instrument and use the\n"
930                    "File/Copy option to duplicate the name"
931                    )
932                if not G2gd.CallScrolledMultiEditor(
933                    self.G2frame,dictlist,keylist,
934                    prelbl=range(1,len(dictlist)+1),
935                    postlbl=lbllist,
936                    title='Instrument names',
937                    header="Edit instrument names. Note that a non-blank\nname is required for all histograms"+msg,
938                    ): return
939
940        if oneblock and not self.quickmode:
941            # select a dataset to use (there should only be one set in one block,
942            # but take whatever comes 1st
943            for hist in self.Histograms:
944                histblk = self.Histograms[hist]
945                if hist.startswith("PWDR"): 
946                    instnam = histblk["Sample Parameters"]['InstrName']
947                    break # ignore all but 1st data histogram
948                elif hist.startswith("HKLF"): 
949                    instnam = histblk["Instrument Parameters"][0]['InstrName']
950                    break # ignore all but 1st data histogram
951        #======================================================================
952        # Start writing the CIF - single block
953        #======================================================================
954        if oneblock:
955            WriteCIFitem('data_'+self.CIFname)
956            if phasenam is None: # if not already selected, select the first phase (should be one)
957                phasenam = self.Phases.keys()[0]
958            #print 'phasenam',phasenam
959            phaseblk = self.Phases[phasenam] # pointer to current phase info
960            if not self.quickmode:
961                instnam = instnam.replace(' ','')
962                WriteCIFitem('_pd_block_id',
963                             str(self.CIFdate) + "|" + str(self.CIFname) + "|" +
964                             str(self.shortauthorname) + "|" + instnam)
965                WriteAudit()
966                WritePubTemplate()
967                WriteOverall()
968                WritePhaseTemplate()
969            # report the phase info
970            WritePhaseInfo(phasenam)
971            if hist.startswith("PWDR") and not self.quickmode:
972                # preferred orientation
973                SH = FormatSH(phasenam)
974                MD = FormatHAPpo(phasenam)
975                if SH and MD:
976                    WriteCIFitem('_pd_proc_ls_pref_orient_corr', SH + '\n' + MD)
977                elif SH or MD:
978                    WriteCIFitem('_pd_proc_ls_pref_orient_corr', SH + MD)
979                else:
980                    WriteCIFitem('_pd_proc_ls_pref_orient_corr', 'none')
981                    # report profile, since one-block: include both histogram and phase info
982                WriteCIFitem('_pd_proc_ls_profile_function',
983                             FormatInstProfile(histblk["Instrument Parameters"])
984                             + '\n' +
985                             FormatPhaseProfile(phasenam))
986                WritePowderTemplate()
987                WritePowderData(hist)
988            elif hist.startswith("HKLF") and not self.quickmode:
989                WriteSnglXtalTemplate()
990                WriteSingleXtalData(hist)
991        else:
992        #======================================================================
993        # Start writing the CIF - multiblock
994        #======================================================================
995            # publication info
996            WriteCIFitem('\ndata_'+self.CIFname+'_publ')
997            WriteAudit()
998            WriteCIFitem('_pd_block_id',
999                         str(self.CIFdate) + "|" + str(self.CIFname) + "|" +
1000                         str(self.shortauthorname) + "|Overall")
1001            WritePubTemplate()
1002            # overall info
1003            WriteCIFitem('data_'+str(self.CIFname)+'_overall')
1004            WriteOverall()
1005            #============================================================
1006            WriteCIFitem('# POINTERS TO PHASE AND HISTOGRAM BLOCKS')
1007            datablockidDict = {} # save block names here -- N.B. check for conflicts between phase & hist names (unlikely!)
1008            # loop over phase blocks
1009            if self.nphase > 1:
1010                loopprefix = ''
1011                WriteCIFitem('loop_   _pd_phase_block_id')
1012            else:
1013                loopprefix = '_pd_phase_block_id'
1014           
1015            for phasenam in sorted(self.Phases.keys()):
1016                i = self.Phases[phasenam]['pId']
1017                datablockidDict[phasenam] = (str(self.CIFdate) + "|" + str(self.CIFname) + "|" +
1018                             'phase_'+ str(i) + '|' + str(self.shortauthorname))
1019                WriteCIFitem(loopprefix,datablockidDict[phasenam])
1020            # loop over data blocks
1021            if self.npowder + self.nsingle > 1:
1022                loopprefix = ''
1023                WriteCIFitem('loop_   _pd_block_diffractogram_id')
1024            else:
1025                loopprefix = '_pd_block_diffractogram_id'
1026            for hist in self.Histograms:
1027                histblk = self.Histograms[hist]
1028                if hist.startswith("PWDR"): 
1029                    instnam = histblk["Sample Parameters"]['InstrName']
1030                elif hist.startswith("HKLF"): 
1031                    instnam = histblk["Instrument Parameters"][0]['InstrName']
1032                instnam = instnam.replace(' ','')
1033                i = histblk['hId']
1034                datablockidDict[hist] = (str(self.CIFdate) + "|" + str(self.CIFname) + "|" +
1035                                         str(self.shortauthorname) + "|" +
1036                                         instnam + "_hist_"+str(i))
1037                WriteCIFitem(loopprefix,datablockidDict[hist])
1038            #============================================================
1039            # loop over phases, exporting them
1040            phasebyhistDict = {} # create a cross-reference to phases by histogram
1041            for j,phasenam in enumerate(sorted(self.Phases.keys())):
1042                i = self.Phases[phasenam]['pId']
1043                WriteCIFitem('\ndata_'+self.CIFname+"_phase_"+str(i))
1044                print "debug, processing ",phasenam
1045                WriteCIFitem('# Information for phase '+str(i))
1046                WriteCIFitem('_pd_block_id',datablockidDict[phasenam])
1047                # report the phase
1048                WritePhaseTemplate()
1049                WritePhaseInfo(phasenam)
1050                # preferred orientation
1051                SH = FormatSH(phasenam)
1052                MD = FormatHAPpo(phasenam)
1053                if SH and MD:
1054                    WriteCIFitem('_pd_proc_ls_pref_orient_corr', SH + '\n' + MD)
1055                elif SH or MD:
1056                    WriteCIFitem('_pd_proc_ls_pref_orient_corr', SH + MD)
1057                else:
1058                    WriteCIFitem('_pd_proc_ls_pref_orient_corr', 'none')
1059                # report sample profile terms
1060                PP = FormatPhaseProfile(phasenam)
1061                if PP:
1062                    WriteCIFitem('_pd_proc_ls_profile_function',PP)
1063                   
1064            #============================================================
1065            # loop over histograms, exporting them
1066            for hist in self.Histograms:
1067                histblk = self.Histograms[hist]
1068                i = histblk['hId']
1069                if hist.startswith("PWDR"): 
1070                    WriteCIFitem('\ndata_'+self.CIFname+"_pwd_"+str(i))
1071                    #instnam = histblk["Sample Parameters"]['InstrName']
1072                    # report instrumental profile terms
1073                    WriteCIFitem('_pd_proc_ls_profile_function',
1074                                 FormatInstProfile(histblk["Instrument Parameters"]))
1075                    WriteCIFitem('# Information for histogram '+str(i)+': '+
1076                                 hist)
1077                    WriteCIFitem('_pd_block_id',datablockidDict[hist])
1078                    WritePowderTemplate()
1079                    WritePowderData(hist)
1080                elif hist.startswith("HKLF"): 
1081                    WriteCIFitem('\ndata_'+self.CIFname+"_sx_"+str(i))
1082                    #instnam = histblk["Instrument Parameters"][0]['InstrName']
1083                    WriteCIFitem('# Information for histogram '+str(i)+': '+
1084                                 hist)
1085                    WriteCIFitem('_pd_block_id',datablockidDict[hist])
1086                    WriteSnglXtalTemplate()
1087                    WriteSingleXtalData(hist)
1088
1089        WriteCIFitem('#--' + 15*'eof--' + '#')
1090
Note: See TracBrowser for help on using the repository browser.