source: trunk/exports/G2export_PDB.py @ 1123

Last change on this file since 1123 was 1123, checked in by toby, 8 years ago

add import and export routines to sphinx

  • Property svn:keywords set to Date Author Revision URL Id
File size: 12.8 KB
Line 
1#!/usr/bin/env python
2# -*- coding: utf-8 -*-
3########### SVN repository information ###################
4# $Date: 2013-10-25 19:24:22 +0000 (Fri, 25 Oct 2013) $
5# $Author: toby $
6# $Revision: 1123 $
7# $URL: trunk/exports/G2export_PDB.py $
8# $Id: G2export_PDB.py 1123 2013-10-25 19:24:22Z toby $
9########### SVN repository information ###################
10'''
11*Module G2export_PDB: Macromolecular export*
12--------------------------------------------
13Code to export a phase into the venerated/obsolete (pick one)
14ASCII PDB format. Also defines exporter :class:`ExportPhaseCartXYZ`
15which writes atom positions in orthogonal coordinates for a phase.
16
17'''
18import numpy as np
19import os.path
20import GSASIIpath
21GSASIIpath.SetVersionNumber("$Revision: 1123 $")
22import GSASIIIO as G2IO
23#import GSASIIgrid as G2gd
24import GSASIIstrIO as G2stIO
25#import GSASIImath as G2mth
26import GSASIIlattice as G2lat
27import GSASIIspc as G2spc
28#import GSASIIphsGUI as G2pg
29#import GSASIIstrMain as G2stMn
30
31class ExportPhasePDB(G2IO.ExportBaseclass):
32    '''Used to create a PDB file for a phase
33
34    :param wx.Frame G2frame: reference to main GSAS-II frame
35    '''
36    def __init__(self,G2frame):
37        super(self.__class__,self).__init__( # fancy way to say <parentclass>.__init__
38            G2frame=G2frame,
39            formatName = 'PDB',
40            extension='.PDB',
41            longFormatName = 'Export phase as .PDB file'
42            )
43        self.exporttype = ['phase']
44        self.multiple = True
45
46    def Exporter(self,event=None):
47        '''Export as a PDB file
48        '''
49       
50        def PDBheader():
51            self.Write("HEADER phase "+str(phasenam)+" from "+str(self.G2frame.GSASprojectfile))
52            self.Write("TITLE")
53            self.Write("COMPND")
54            self.Write("SOURCE")
55            self.Write("KEYWDS")
56            self.Write("EXPDTA    X-RAY POWDER DIFFRACTION")
57            self.Write("REVDAT")
58            self.Write("JRNL")
59            self.Write("REMARK   1")
60            self.Write("REMARK   2")                                                                     
61            self.Write("REMARK   2 RESOLUTION. 2.66 ANGSTROMS.")                                         
62            self.Write("REMARK   2 POWDER DIFFRACTION MINIMUM D-SPACING.")
63           
64        def PDBremark250():                               
65            self.Write('REMARK 250')                                                                     
66            self.Write('REMARK 250 REFINEMENT.')                                                         
67            self.Write('REMARK 250   PROGRAM     : GSAS-II')                                                 
68            self.Write('REMARK 250   AUTHORS     : TOBY & VON DREELE')
69            self.Write('REMARK 250   REFRENCE    : J. APPL. CRYST. 46, 544-549(2013)')                             
70            self.Write('REMARK 250')
71            self.Write('REMARK 250  DATA USED IN REFINEMENT')                                             
72            self.Write('REMARK 250   RESOLUTION RANGE HIGH (ANGSTROMS) :  x.xx')                         
73            self.Write('REMARK 250   RESOLUTION RANGE LOW  (ANGSTROMS) : xx.xx')                         
74            self.Write('REMARK 250   POWDER DIFFRACTION DATA.')                                           
75            self.Write('REMARK 250')
76            self.Write('REMARK 250  FIT TO DATA USED IN REFINEMENT')                                     
77            self.Write('REMARK 250   NUMBER OF POWDER PATTERNS         :     x')                         
78            self.Write('REMARK 250   PROFILE R VALUES              (%) :  x.xx')                         
79            self.Write('REMARK 250   WEIGHTED PROFILE R VALUES     (%) :  x.xx')                         
80            self.Write('REMARK 250   F**2 R VALUES                 (%) : xx.xx')                         
81            self.Write('REMARK 250   NUMBERS OF POWDER PATTERN POINTS  :  xxxx')                         
82            self.Write('REMARK 250   NUMBERS OF REFLECTIONS            :  xxxx')                         
83            self.Write('REMARK 250   TOTAL NUMBER OF POWDER POINTS     :  xxxx')                         
84            self.Write('REMARK 250')
85            self.Write('REMARK 250  NUMBER OF NON-HYDROGEN ATOMS USED IN REFINEMENT.')                   
86            self.Write('REMARK 250   PROTEIN ATOMS       :      xxxx')                                             
87            self.Write('REMARK 250   NUCLEIC ACID ATOMS  :      xxxx')                                             
88            self.Write('REMARK 250   HETEROGEN ATOMS     :      xxxx')                                             
89            self.Write('REMARK 250   SOLVENT ATOMS       :      xxxx')                                             
90            self.Write('REMARK 250')
91            self.Write('REMARK 250  MODEL REFINEMENT.')                                                   
92            self.Write('REMARK 250   NUMBER OF LEAST-SQUARES PARAMETERS :  xxxx')                         
93            self.Write('REMARK 250   NUMBER OF RESTRAINTS               :  xxxx')                         
94            self.Write('REMARK 250')
95            self.Write('REMARK 250  RMS DEVIATIONS FROM RESTRAINT TARGET VALUES. NUMBER.')               
96            self.Write('REMARK 250   BOND ANGLES                      (DEG) : x.xx   xxx')               
97#            self.Write('REMARK 250   ANTI-BUMPING DISTANCE RESTRAINTS   (A) :x.xxx   xxx')               
98#            self.Write('REMARK 250   HYDROGEN BOND DISTANCE RESTRAINTS  (A) :x.xxx   xxx')               
99            self.Write('REMARK 250   INTERATOMIC DISTANCES              (A) :x.xxx   xxx')               
100            self.Write('REMARK 250   DISTANCES FROM RESTRAINT PLANES    (A) :x.xxx   xxx')               
101            self.Write('REMARK 250   TORSION PSEUDOPOTENTIAL RESTRAINTS (E) : x.xx   xxx')               
102            self.Write('REMARK 250   TORSION ANGLE RESTRAINTS           (E) : x.xx   xxx')               
103            self.Write('REMARK 250')
104            self.Write('REMARK 200')                                                                     
105            self.Write('DBREF')
106           
107        def PDBseqres(seqList):
108            chains = seqList.keys()
109            chains.sort()
110            nSeq = 0
111            for chain in chains:
112                nres = len(seqList[chain])
113                nrec = (nres-1)/13+1
114                iB = 0
115                for irec in range(nrec):
116                    iF = min(iB+13,nres)
117                    text = 'SEQRES {:3d}{:2s}{:5d}  '+(iF-iB)*'{:4s}'
118                    self.Write(text.format(irec+1,chain,nres,*seqList[chain][iB:iF]))
119                    nSeq += 1
120                    iB += 13
121            return nSeq
122           
123        # the export process starts here
124        self.InitExport(event)
125        # load all of the tree into a set of dicts
126        self.loadTree()
127        # create a dict with refined values and their uncertainties
128        self.loadParmDict()
129        if self.ExportSelect(AskFile=True):    # set export parameters
130            return 
131        for phasenam in self.phasenam:
132            phasedict = self.Phases[phasenam] # pointer to current phase info
133            General = phasedict['General']
134            if General['Type'] != 'macromolecular':
135                print 'not macromolecular phase'
136                return
137            i = self.Phases[phasenam]['pId']
138            if len(self.phasenam) > 1: # if more than one filename is included, add a phase #
139                nam,ext = os.path.splitext(self.filename)
140                fil = nam+"_"+str(i)+ext
141            else:
142                fil = self.filename
143            fp = self.OpenFile(fil)
144            Atoms = phasedict['Atoms']
145            cx,ct,cs,cia = General['AtomPtrs']
146            seqList = {}
147            AA3letter = ['ALA','ARG','ASN','ASP','CYS','GLN','GLU','GLY','HIS','ILE',
148                'LEU','LYS','MET','PHE','PRO','SER','THR','TRP','TYR','VAL','MSE']
149            seq = 0
150            for atom in Atoms:
151                if atom[ct-3] in AA3letter and int(atom[ct-4]) != seq:
152                    if atom[ct-2] not in seqList:
153                        seqList[atom[ct-2]] = []
154                    seqList[atom[ct-2]].append(atom[ct-3])
155                    seq = int(atom[ct-4])
156            PDBheader()
157            PDBremark250()
158            nSeq = PDBseqres(seqList)
159           
160            # get cell parameters
161            Cell = General['Cell'][1:7]
162            line = "CRYST1 {:8.3f} {:8.3f} {:8.3f} {:6.2f} {:6.2f} {:6.2f} ".format(*Cell)
163            line += General['SGData']['SpGrp'].ljust(13)
164            line += '%2d'%(len(General['SGData']['SGOps'])*len(General['SGData']['SGCen']))
165            self.Write(line)
166            self.Write('ORIGX1      1.000000  0.000000  0.000000        0.00000')
167            self.Write('ORIGX2      0.000000  1.000000  0.000000        0.00000')
168            self.Write('ORIGX3      0.000000  0.000000  1.000000        0.00000')
169            A,B = G2lat.cell2AB(Cell)
170            self.Write('SCALE1     {:9.6f} {:9.6f} {:9.6f}        0.00000'.format(*B[0]))
171            self.Write('SCALE2     {:9.6f} {:9.6f} {:9.6f}        0.00000'.format(*B[1]))
172            self.Write('SCALE3     {:9.6f} {:9.6f} {:9.6f}        0.00000'.format(*B[2]))
173            iatom = 1
174            nHet = 0
175            nTer = 0
176            fmt = '{:6s}{:5d}  {:4s}{:3s} {:1s}{:4s}    '+3*'{:8.3f}'+2*'{:6.2f}'+'{:s}'
177            for atom in Atoms:
178                if atom[cia] == 'I':    #need to deal with aniso thermals for proteins = "ANISOU" records
179                    Biso = atom[cia+1]*8.*np.pi**2
180                xyz = np.inner(A,np.array(atom[cx:cx+3]))
181                if atom[ct-3] in AA3letter:
182                    self.Write(fmt.format('ATOM  ',iatom,atom[ct-1],atom[ct-3].strip(),    \
183                        atom[ct-2].strip(),atom[ct-4].rjust(4),xyz[0],xyz[1],xyz[2],atom[cx+3], \
184                        Biso,atom[ct].rjust(12)))
185                    if atom[ct-1] == 'OXT':
186                        iatom += 1
187                        self.Write('{:6s}{:5d}  {:4s}{:3s}'.format('TER   ',iatom,atom[ct-1],atom[ct-3].strip()))
188                        nTer += 1
189                else:
190                    nHet += 1
191                    self.Write(fmt.format('HETATM',iatom,atom[ct-1],atom[ct-3].strip(),    \
192                        atom[ct-2].strip(),atom[ct-4].rjust(4),xyz[0],xyz[1],xyz[2],atom[cx+3], \
193                        Biso,atom[ct].rjust(12)))
194                iatom += 1
195           
196            vals = [3,0,nHet,0,0,0,6,len(Atoms),nTer,0,nSeq]
197            fmt = 'MASTER'+11*'{:5d}'
198            self.Write(fmt.format(*vals))
199            self.Write('END')
200            self.CloseFile()
201            print('Phase '+str(phasenam)+' written to file '+str(fil))
202
203class ExportPhaseCartXYZ(G2IO.ExportBaseclass):
204    '''Used to create a Cartesian XYZ file for a phase
205
206    :param wx.Frame G2frame: reference to main GSAS-II frame
207    '''
208    def __init__(self,G2frame):
209        super(self.__class__,self).__init__( # fancy way to say <parentclass>.__init__
210            G2frame=G2frame,
211            formatName = 'Cartesian XYZ',
212            extension='.XYZ',
213            longFormatName = 'Export phase with Cartesian coordinates as .XYZ file'
214            )
215        self.exporttype = ['phase']
216        self.multiple = True
217
218    def Exporter(self,event=None):
219        '''Export as a XYZ file
220        '''
221        # the export process starts here
222        self.InitExport(event)
223        # load all of the tree into a set of dicts
224        self.loadTree()
225        # create a dict with refined values and their uncertainties
226        self.loadParmDict()
227        if self.ExportSelect(AskFile=True):    # set export parameters
228            return 
229        for phasenam in self.phasenam:
230            phasedict = self.Phases[phasenam] # pointer to current phase info
231            General = phasedict['General']
232            i = self.Phases[phasenam]['pId']
233            if len(self.phasenam) > 1: # if more than one filename is included, add a phase #
234                nam,ext = os.path.splitext(self.filename)
235                fil = nam+"_"+str(i)+ext
236            else:
237                fil = self.filename
238            fp = self.OpenFile(fil)
239            Atoms = phasedict['Atoms']
240            if not len(Atoms):
241                print('**** ERROR - Phase '+str(phasenam)+' has no atoms! ****')
242                return
243            cx,ct,cs,cia = General['AtomPtrs']
244            Cell = General['Cell'][1:7]
245            A,B = G2lat.cell2AB(Cell)
246            fmt = '{:4s}'+3*'{:12.4f}'
247            self.Write('{:6d}'.format(len(Atoms)))
248            self.Write(' ')
249            for atom in Atoms:
250                xyz = np.inner(A,np.array(atom[cx:cx+3]))
251                self.Write(fmt.format(atom[ct],*xyz))
252            self.CloseFile()
253            print('Phase '+str(phasenam)+' written to file '+str(fil))
254   
Note: See TracBrowser for help on using the repository browser.