source: sasview/sanscalculator/src/sans/calculator/sans_gen.py @ afcb052

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since afcb052 was afd45674, checked in by Jae Cho <jhjcho@…>, 11 years ago

Added total volume param in the sasgen model

  • Property mode set to 100644
File size: 40.2 KB
Line 
1"""
2SANS generic computation and sld file readers
3"""
4from sans.models.BaseComponent import BaseComponent
5import sans.models.sans_extension.sld2i as mod
6from periodictable import formula
7from periodictable import nsf
8import numpy
9import os
10import copy
11
12MFactor_AM = 2.853E-12
13MFactor_mT = 2.3164E-9
14METER2ANG = 1.0E+10
15#Avogadro constant [1/mol]
16NA = 6.02214129e+23
17
18def mag2sld(mag, v_unit=None):
19    """
20    Convert magnetization to magnatic SLD
21    sldm = Dm * mag where Dm = gamma * classical elec. radius/(2*Bohr magneton)
22    Dm ~ 2.853E-12 [A^(-2)] ==> Shouldn't be 2.90636E-12 [A^(-2)]???
23    """ 
24    if v_unit == "A/m":
25        factor = MFactor_AM
26    elif v_unit == "mT":
27        factor = MFactor_mT
28    else:
29        raise ValueError, "Invalid valueunit"
30    sld_m = factor * mag
31    return sld_m
32
33class GenSAS(BaseComponent):
34    """
35    Generic SAS computation Model based on sld (n & m) arrays
36    """
37    def __init__(self):
38        """
39        Init
40       
41        :Params sld_data: MagSLD object
42        """
43        # Initialize BaseComponent
44        BaseComponent.__init__(self)
45        self.sld_data = None
46        self.data_pos_unit = None
47        self.data_x = None
48        self.data_y = None
49        self.data_z = None
50        self.data_sldn = None
51        self.data_mx = None
52        self.data_my = None
53        self.data_mz = None
54        self.data_vol = None #[A^3]
55        self.is_avg = False
56        ## Name of the model
57        self.name = "GenSAS"
58        ## Define parameters
59        self.params = {}
60        self.params['scale']       = 1.0
61        self.params['background']  = 0.0
62        self.params['solvent_SLD']     = 0.0
63        self.params['total_volume'] = 1.0
64        self.params['Up_frac_in']     = 1.0
65        self.params['Up_frac_out']    = 1.0
66        self.params['Up_theta']  = 0.0
67        self.description = 'GenSAS'
68        ## Parameter details [units, min, max]
69        self.details = {}
70        self.details['scale']      = ['', None, None]
71        self.details['background'] = ['[1/cm]', None, None]
72        self.details['solvent_SLD']    = ['1/A^(2)', None, None]
73        self.details['total_volume']    = ['A^(3)', None, None]
74        self.details['Up_frac_in']    = ['[u/(u+d)]', None, None]
75        self.details['Up_frac_out']   = ['[u/(u+d)]', None, None]
76        self.details['Up_theta'] = ['[deg]', None, None]
77        # fixed parameters
78        self.fixed = []
79       
80    def set_pixel_volumes(self, volume):     
81        """
82        Set the volume of a pixel in (A^3) unit
83        :Param volume: pixel volume [float]
84        """
85        if self.data_vol == None:
86            raise
87        self.data_vol = volume
88   
89    def set_is_avg(self, is_avg=False): 
90        """
91        Sets is_avg: [bool]
92        """
93        self.is_avg = is_avg
94         
95    def _gen(self, x, y, i):
96        """
97        Evaluate the function
98        :Param x: array of x-values
99        :Param y: array of y-values
100        :Param i: array of initial i-value
101        :return: function value
102        """
103        len_x = len(self.data_x)
104        if self.is_avg:
105            len_x *= -1
106        len_q = len(x)
107        sldn = copy.deepcopy(self.data_sldn)
108        sldn -= self.params['solvent_SLD']
109        model = mod.new_GenI(len_x, self.data_x, self.data_y, self.data_z, 
110                             sldn, self.data_mx, self.data_my, 
111                             self.data_mz, self.data_vol,
112                             self.params['Up_frac_in'], 
113                             self.params['Up_frac_out'], 
114                             self.params['Up_theta'])
115
116        mod.genicom(model, len_q, x, y, i)
117        vol_correction = self.data_total_volume / self.params['total_volume']
118        return  self.params['scale'] * vol_correction * i + \
119                        self.params['background']
120       
121    def set_sld_data(self, sld_data=None):   
122        """
123        Sets sld_data
124        """
125        self.sld_data = sld_data
126        self.data_pos_unit = sld_data.pos_unit
127        self.data_x = sld_data.pos_x
128        self.data_y = sld_data.pos_y
129        self.data_z = sld_data.pos_z
130        self.data_sldn = sld_data.sld_n
131        self.data_mx = sld_data.sld_mx
132        self.data_my = sld_data.sld_my
133        self.data_mz = sld_data.sld_mz
134        self.data_vol = sld_data.vol_pix
135        self.data_total_volume = sum(sld_data.vol_pix)
136        self.params['total_volume'] = sum(sld_data.vol_pix)
137       
138    def getProfile(self):
139        """
140        Get SLD profile
141       
142        : return: sld_data
143        """
144        return self.sld_data
145     
146    def run(self, x = 0.0):
147        """
148        Evaluate the model
149        :param x: simple value
150        :return: (I value)
151        """
152        if x.__class__.__name__ == 'list':
153            i_out = numpy.zeros_like(x[0])
154            y_in = numpy.zeros_like(x[0])
155            # 1D I is found at y =0 in the 2D pattern
156            return self._gen(x[0], y_in, i_out )
157        else:
158            msg = "Q must be given as list of qx's and qy's"
159            raise ValueError, msg
160   
161    def runXY(self, x = 0.0):
162        """
163        Evaluate the model
164        :param x: simple value
165        :return: I value
166        :Use this runXY() for the computation
167        """
168        if x.__class__.__name__ == 'list':
169            i_out = numpy.zeros_like(x[0])
170            import time
171            s = time.time()
172            out = self._gen(x[0], x[1], i_out)
173            print "i_out_time", time.time() - s
174            return out
175        else:
176            msg = "Q must be given as list of qx's and qy's"
177            raise ValueError, msg
178       
179    def evalDistribution(self, qdist):
180        """
181        Evaluate a distribution of q-values.
182        * For 1D, a numpy array is expected as input:
183            evalDistribution(q)   
184        where q is a numpy array.
185        * For 2D, a list of numpy arrays are expected: [qx_prime,qy_prime],
186          where 1D arrays, 
187        :param qdist: ndarray of scalar q-values or list [qx,qy]
188                    where qx,qy are 1D ndarrays
189        """
190        if qdist.__class__.__name__ == 'list':
191            out = self.runXY(qdist)
192            return out
193        else:
194            mesg = "evalDistribution is expecting an ndarray of "
195            mesg += "a list [qx,qy] where qx,qy are arrays."
196            raise RuntimeError, mesg
197     
198class OMF2SLD:
199    """
200    Convert OMFData to MAgData
201    """
202    def __init__(self): 
203        """
204        Init
205        """
206        self.pos_x = None
207        self.pos_y = None
208        self.pos_z = None
209        self.mx = None
210        self.my = None
211        self.mz = None
212        self.sld_n = None
213        self.vol_pix = None
214        self.output = None
215        self.omfdata = None
216   
217    def set_data(self, omfdata, shape='rectangular'):
218        """
219        Set all data
220        """
221        self.omfdata = omfdata
222        length = int(omfdata.xnodes * omfdata.ynodes * omfdata.znodes)
223        pos_x = numpy.arange(omfdata.xmin, 
224                             omfdata.xnodes*omfdata.xstepsize + omfdata.xmin, 
225                             omfdata.xstepsize)
226        pos_y = numpy.arange(omfdata.ymin, 
227                             omfdata.ynodes*omfdata.ystepsize + omfdata.ymin, 
228                             omfdata.ystepsize)
229        pos_z = numpy.arange(omfdata.zmin, 
230                             omfdata.znodes*omfdata.zstepsize + omfdata.zmin, 
231                             omfdata.zstepsize)
232        self.pos_x = numpy.tile(pos_x, int(omfdata.ynodes * omfdata.znodes))
233        self.pos_y = pos_y.repeat(int(omfdata.xnodes))
234        self.pos_y = numpy.tile(self.pos_y, int(omfdata.znodes))
235        self.pos_z = pos_z.repeat(int(omfdata.xnodes * omfdata.ynodes))
236        self.mx = omfdata.mx
237        self.my = omfdata.my
238        self.mz = omfdata.mz
239        self.sld_n = numpy.zeros(length)
240           
241        if omfdata.mx == None:
242            self.mx = numpy.zeros(length)
243        if omfdata.my == None:
244            self.my = numpy.zeros(length)
245        if omfdata.mz == None:
246            self.mz = numpy.zeros(length)
247       
248        self._check_data_length(length)
249        self.remove_null_points(False, False)
250        mask = numpy.ones(len(self.sld_n), dtype=bool)
251        if shape.lower() == 'ellipsoid':
252            try:
253                # Pixel (step) size included
254                x_c = max(self.pos_x) + min(self.pos_x)
255                y_c = max(self.pos_y) + min(self.pos_y)
256                z_c = max(self.pos_z) + min(self.pos_z)
257                x_d = max(self.pos_x) - min(self.pos_x)
258                y_d = max(self.pos_y) - min(self.pos_y)
259                z_d = max(self.pos_z) - min(self.pos_z)
260                x_r = (x_d + omfdata.xstepsize) / 2.0
261                y_r = (y_d + omfdata.ystepsize) / 2.0
262                z_r = (z_d + omfdata.zstepsize) / 2.0
263                x_dir2 = ((self.pos_x - x_c / 2.0) / x_r)
264                x_dir2 *= x_dir2
265                y_dir2 = ((self.pos_y - y_c / 2.0) / y_r)
266                y_dir2 *= y_dir2
267                z_dir2 = ((self.pos_z - z_c / 2.0) / z_r)
268                z_dir2 *= z_dir2
269                mask = (x_dir2 + y_dir2 + z_dir2) <= 1.0
270            except:
271                pass
272        self.output = MagSLD(self.pos_x[mask], self.pos_y[mask], 
273                             self.pos_z[mask], self.sld_n[mask], 
274                             self.mx[mask], self.my[mask], self.mz[mask])
275        self.output.set_pix_type('pixel')
276        self.output.set_pixel_symbols('pixel')
277       
278    def get_omfdata(self):
279        """
280        Return all data
281        """
282        return self.omfdata
283   
284    def get_output(self):
285        """
286        Return output
287        """
288        return self.output
289   
290    def _check_data_length(self, length):
291        """
292        Check if the data lengths are consistent
293        :Params length: data length
294        """
295        msg = "Error: Inconsistent data length."
296        if len(self.pos_x) != length:
297            raise ValueError, msg
298        if len(self.pos_y) != length:
299            raise ValueError, msg
300        if len(self.pos_z) != length:
301            raise ValueError, msg
302        if len(self.mx) != length:
303            raise ValueError, msg
304        if len(self.my) != length:
305            raise ValueError, msg
306        if len(self.mz) != length:
307            raise ValueError, msg
308       
309    def remove_null_points(self, remove=False, recenter=False):
310        """
311        Removes any mx, my, and mz = 0 points
312        """
313        if remove:
314            is_nonzero = (numpy.fabs(self.mx) + numpy.fabs(self.my) + 
315                          numpy.fabs(self.mz)).nonzero() 
316            if len(is_nonzero[0]) > 0: 
317                self.pos_x = self.pos_x[is_nonzero]
318                self.pos_y = self.pos_y[is_nonzero]
319                self.pos_z = self.pos_z[is_nonzero]
320                self.sld_n = self.sld_n[is_nonzero]
321                self.mx = self.mx[is_nonzero]
322                self.my = self.my[is_nonzero]
323                self.mz = self.mz[is_nonzero]
324        if recenter:
325            self.pos_x -= (min(self.pos_x) + max(self.pos_x)) / 2.0
326            self.pos_y -= (min(self.pos_y) + max(self.pos_y)) / 2.0
327            self.pos_z -= (min(self.pos_z) + max(self.pos_z)) / 2.0
328 
329    def get_magsld(self):
330        """
331        return MagSLD
332        """
333        return self.output
334   
335       
336class OMFReader:
337    """
338    Class to load omf/ascii files (3 columns w/header).
339    """
340    ## File type
341    type_name = "OMF ASCII"
342   
343    ## Wildcards
344    type = ["OMF files (*.OMF, *.omf)|*.omf"]
345    ## List of allowed extensions
346    ext = ['.omf', '.OMF']
347       
348    def read(self, path):
349        """
350        Load data file
351        :param path: file path
352        :return: x, y, z, sld_n, sld_mx, sld_my, sld_mz
353        """
354        #data_conv_m = None
355        desc = ""
356        mx = numpy.zeros(0)
357        my = numpy.zeros(0)
358        mz = numpy.zeros(0)
359        try:
360            data_conv_val = None
361            data_conv_mesh = None
362            input_f = open(path, 'rb')
363            buff = input_f.read()
364            lines = buff.split('\n')
365            input_f.close()
366            output = OMFData()
367            valueunit = None
368            for line in lines:
369                toks = line.split()
370                # Read data
371                try:
372                    _mx = float(toks[0])
373                    _my = float(toks[1])
374                    _mz = float(toks[2])
375                    _mx = mag2sld(_mx, valueunit)
376                    _my = mag2sld(_my, valueunit)
377                    _mz = mag2sld(_mz, valueunit)
378                    mx = numpy.append(mx, _mx)
379                    my = numpy.append(my, _my)
380                    mz = numpy.append(mz, _mz)
381                except:
382                    # Skip non-data lines
383                    pass
384                #Reading Header; Segment count ignored
385                s_line = line.split(":", 1)
386                if s_line[0].lower().count("oommf") > 0:
387                    oommf = s_line[1].lstrip()
388                if s_line[0].lower().count("title") > 0:
389                    title = s_line[1].lstrip()
390                if s_line[0].lower().count("desc") > 0:
391                    desc += s_line[1].lstrip()
392                    desc += '\n'
393                if s_line[0].lower().count("meshtype") > 0:
394                    meshtype = s_line[1].lstrip()
395                if s_line[0].lower().count("meshunit") > 0:
396                    meshunit = s_line[1].lstrip()
397                    if meshunit.count("m") < 1:
398                        msg = "Error: \n"
399                        msg += "We accept only m as meshunit"
400                        raise ValueError, msg
401                if s_line[0].lower().count("xbase") > 0:
402                    xbase = s_line[1].lstrip()
403                if s_line[0].lower().count("ybase") > 0:
404                    ybase = s_line[1].lstrip()
405                if s_line[0].lower().count("zbase") > 0:
406                    zbase = s_line[1].lstrip()
407                if s_line[0].lower().count("xstepsize") > 0:
408                    xstepsize = s_line[1].lstrip()
409                if s_line[0].lower().count("ystepsize") > 0:
410                    ystepsize = s_line[1].lstrip()
411                if s_line[0].lower().count("zstepsize") > 0:
412                    zstepsize = s_line[1].lstrip()
413                if s_line[0].lower().count("xnodes") > 0:
414                    xnodes = s_line[1].lstrip()
415                if s_line[0].lower().count("ynodes") > 0:
416                    ynodes = s_line[1].lstrip()
417                if s_line[0].lower().count("znodes") > 0:
418                    znodes = s_line[1].lstrip()
419                if s_line[0].lower().count("xmin") > 0:
420                    xmin = s_line[1].lstrip()
421                if s_line[0].lower().count("ymin") > 0:
422                    ymin = s_line[1].lstrip()
423                if s_line[0].lower().count("zmin") > 0:
424                    zmin = s_line[1].lstrip()
425                if s_line[0].lower().count("xmax") > 0:
426                    xmax = s_line[1].lstrip()
427                if s_line[0].lower().count("ymax") > 0:
428                    ymax = s_line[1].lstrip()
429                if s_line[0].lower().count("zmax") > 0:
430                    zmax = s_line[1].lstrip()
431                if s_line[0].lower().count("valueunit") > 0:
432                    valueunit = s_line[1].lstrip().rstrip()
433                if s_line[0].lower().count("valuemultiplier") > 0:
434                    valuemultiplier = s_line[1].lstrip()
435                if s_line[0].lower().count("valuerangeminmag") > 0:
436                    valuerangeminmag = s_line[1].lstrip()
437                if s_line[0].lower().count("valuerangemaxmag") > 0:
438                    valuerangemaxmag = s_line[1].lstrip()
439                if s_line[0].lower().count("end") > 0:
440                    #output.set_sldms(mx, my, mz)   
441                    output.filename = os.path.basename(path)
442                    output.oommf = oommf
443                    output.title = title
444                    output.desc = desc
445                    output.meshtype = meshtype
446                    output.xbase = float(xbase) * METER2ANG
447                    output.ybase = float(ybase) * METER2ANG
448                    output.zbase = float(zbase) * METER2ANG
449                    output.xstepsize = float(xstepsize) * METER2ANG
450                    output.ystepsize = float(ystepsize) * METER2ANG
451                    output.zstepsize = float(zstepsize) * METER2ANG
452                    output.xnodes = float(xnodes)
453                    output.ynodes = float(ynodes)
454                    output.znodes = float(znodes)
455                    output.xmin = float(xmin) * METER2ANG
456                    output.ymin = float(ymin) * METER2ANG
457                    output.zmin = float(zmin) * METER2ANG
458                    output.xmax = float(xmax) * METER2ANG
459                    output.ymax = float(ymax) * METER2ANG
460                    output.zmax = float(zmax) * METER2ANG
461                    output.valuemultiplier = valuemultiplier
462                    output.valuerangeminmag = mag2sld(float(valuerangeminmag), \
463                                                      valueunit)
464                    output.valuerangemaxmag = mag2sld(float(valuerangemaxmag), \
465                                                      valueunit)
466            output.set_m(mx, my, mz)
467            return output
468        except:
469            msg = "%s is not supported: \n" % path
470            msg += "We accept only Text format OMF file."
471            raise RuntimeError, msg
472
473class PDBReader:
474    """
475    PDB reader class: limited for reading the lines starting with 'ATOM'
476    """
477    type_name = "PDB"
478    ## Wildcards
479    type = ["pdb files (*.PDB, *.pdb)|*.pdb"]
480    ## List of allowed extensions
481    ext = ['.pdb', '.PDB']   
482   
483    def read(self, path):
484        """
485        Load data file
486       
487        :param path: file path
488       
489        :return: MagSLD
490       
491        :raise RuntimeError: when the file can't be opened
492        """
493        pos_x = numpy.zeros(0)
494        pos_y = numpy.zeros(0)
495        pos_z = numpy.zeros(0)
496        sld_n = numpy.zeros(0)
497        sld_mx = numpy.zeros(0)
498        sld_my = numpy.zeros(0)
499        sld_mz = numpy.zeros(0)
500        vol_pix = numpy.zeros(0)
501        pix_symbol = numpy.zeros(0)
502        try:
503            input_f = open(path, 'rb')
504            buff = input_f.read()
505            lines = buff.split('\n')
506            input_f.close()
507            for line in lines:
508                try:
509                    #toks = line.split()
510                    # check if line starts with "ATOM"
511                    if line[0:6].strip().count('ATM') > 0 or \
512                                line[0:6].strip() == 'ATOM':
513                        # define fields of interest
514                        atom_id = line[6:11].strip()
515                        atom_name = line[12:16].strip()
516                        try:
517                            float(line[12])
518                            atom_name = atom_name[1].upper()
519                        except:
520                            if len(atom_name) == 4:
521                                atom_name = atom_name[0].upper()
522                            elif line[12] != ' ': 
523                                atom_name = atom_name[0].upper() + \
524                                        atom_name[1].lower() 
525                            else:
526                                atom_name = atom_name[0].upper()
527                        #res_name = line[17:20].strip()
528                        #chain_name = line[21:22].strip()
529                        _pos_x = float(line[30:38].strip())
530                        _pos_y = float(line[38:46].strip())
531                        _pos_z = float(line[46:54].strip())
532                       
533                        pos_x = numpy.append(pos_x, _pos_x)
534                        pos_y = numpy.append(pos_y, _pos_y)
535                        pos_z = numpy.append(pos_z, _pos_z)
536                        try:
537                            # sld in Ang unit (from fm)
538                            #val = formula(atom_name).atoms.keys()[0].neutron.b_c
539                            #val *= 1.0e-5
540                            val = nsf.neutron_sld(atom_name)[0]
541                            # sld in Ang^-2 unit
542                            val *= 1.0e-6
543                            sld_n = numpy.append(sld_n, val)
544                            atom = formula(atom_name)
545                            # cm to A units
546                            vol = 1.0e+24 * atom.mass / atom.density / NA
547                            vol_pix = numpy.append(vol_pix, vol)
548                        except:
549                            print "Error: set the sld of %s to zero"% atom_name
550                            sld_n = numpy.append(sld_n,  0.0)                     
551                        sld_mx = numpy.append(sld_mx, 0)
552                        sld_my = numpy.append(sld_my, 0)
553                        sld_mz = numpy.append(sld_mz, 0)
554                        pix_symbol = numpy.append(pix_symbol, atom_name)
555                except:
556                    pass
557            #re-centering
558            #pos_x -= (min(pos_x) + max(pos_x)) / 2.0
559            #pos_y -= (min(pos_y) + max(pos_y)) / 2.0
560            #pos_z -= (min(pos_z) + max(pos_z)) / 2.0
561
562            output = MagSLD(pos_x, pos_y, pos_z, sld_n, sld_mx, sld_my, sld_mz)
563            output.filename = os.path.basename(path)
564            output.set_pix_type('atom')
565            output.set_pixel_symbols(pix_symbol)
566            output.set_nodes()
567            output.set_pixel_volumes(vol_pix)
568            output.sld_unit = '1/A^(2)'
569            return output
570        except:
571            RuntimeError, "%s is not a sld file" % path
572
573    def write(self, path, data):
574        """
575        Write
576        """
577        #Not implemented
578        print "Not implemented... "
579
580class SLDReader:
581    """
582    Class to load ascii files (7 columns).
583    """
584    ## File type
585    type_name = "SLD ASCII"
586   
587    ## Wildcards
588    type = ["sld files (*.SLD, *.sld)|*.sld",
589            "txt files (*.TXT, *.txt)|*.txt"]
590    ## List of allowed extensions
591    ext = ['.txt', '.TXT', '.sld', 'SLD', '.*']
592   
593    def read(self, path):
594        """
595        Load data file
596       
597        :param path: file path
598       
599        :return MagSLD: x, y, z, sld_n, sld_mx, sld_my, sld_mz
600       
601        :raise RuntimeError: when the file can't be opened
602        :raise ValueError: when the length of the data vectors are inconsistent
603        """
604        try:
605            pos_x = numpy.zeros(0)
606            pos_y = numpy.zeros(0)
607            pos_z = numpy.zeros(0)
608            sld_n = numpy.zeros(0)
609            sld_mx = numpy.zeros(0)
610            sld_my = numpy.zeros(0)
611            sld_mz = numpy.zeros(0)
612            try:
613                # Use numpy to speed up loading
614                input_f = numpy.loadtxt(path, dtype='float', skiprows=1, 
615                                        ndmin=1, unpack=True)
616                pos_x = numpy.array(input_f[0])
617                pos_y = numpy.array(input_f[1])
618                pos_z = numpy.array(input_f[2])
619                sld_n = numpy.array(input_f[3])
620                sld_mx = numpy.array(input_f[4])
621                sld_my = numpy.array(input_f[5])
622                sld_mz = numpy.array(input_f[6])
623                ncols = len(input_f)
624                if ncols == 8:
625                    vol_pix = numpy.array(input_f[7])
626                elif ncols == 7:
627                     vol_pix = None
628            except:
629                # For older version of numpy
630                input_f = open(path, 'rb')
631                buff = input_f.read()
632                lines = buff.split('\n')
633                input_f.close()
634                for line in lines:
635                    toks = line.split()
636                    try:
637                        _pos_x = float(toks[0])
638                        _pos_y = float(toks[1])
639                        _pos_z = float(toks[2])
640                        _sld_n = float(toks[3])
641                        _sld_mx = float(toks[4])
642                        _sld_my = float(toks[5])
643                        _sld_mz = float(toks[6])
644   
645                        pos_x = numpy.append(pos_x, _pos_x)
646                        pos_y = numpy.append(pos_y, _pos_y)
647                        pos_z = numpy.append(pos_z, _pos_z)
648                        sld_n = numpy.append(sld_n, _sld_n)
649                        sld_mx = numpy.append(sld_mx, _sld_mx)
650                        sld_my = numpy.append(sld_my, _sld_my)
651                        sld_mz = numpy.append(sld_mz, _sld_mz)
652                        try:
653                            _vol_pix =  float(toks[7])
654                            vol_pix = numpy.append(vol_pix, _vol_pix)
655                        except:
656                            vol_pix = None
657                    except:
658                        # Skip non-data lines
659                        pass
660           
661            # re-center     
662            #pos_x -= (min(pos_x) + max(pos_x)) / 2.0
663            #pos_y -= (min(pos_y) + max(pos_y)) / 2.0
664            #pos_z -= (min(pos_z) + max(pos_z)) / 2.0
665
666            output = MagSLD(pos_x, pos_y, pos_z, sld_n, 
667                            sld_mx, sld_my, sld_mz)
668
669            output.filename = os.path.basename(path)
670            output.set_pix_type('pixel')
671            output.set_pixel_symbols('pixel')
672            if vol_pix != None:
673                output.set_pixel_volumes(vol_pix)
674            return output
675        except:
676            RuntimeError, "%s is not a sld file" % path
677       
678    def write(self, path, data):
679        """
680        Write sld file
681       
682        :Param path: file path
683        :Param data: MagSLD data object
684        """
685        if path == None:
686            raise ValueError, "Missing the file path."
687        if data == None:
688            raise ValueError, "Missing the data to save."
689       
690        x_val = data.pos_x
691        y_val = data.pos_y
692        z_val = data.pos_z
693        vol_pix = data.vol_pix
694       
695        length = len(x_val)
696       
697        sld_n = data.sld_n
698        if sld_n == None:
699            sld_n = numpy.zerros(length)
700           
701        sld_mx = data.sld_mx
702        if sld_mx == None:
703            sld_mx = numpy.zerros(length)
704            sld_my = numpy.zerros(length)
705            sld_mz = numpy.zerros(length)
706        else:
707            sld_my = data.sld_my
708            sld_mz = data.sld_mz
709           
710        out = open(path, 'w')
711        # First Line: Column names
712        out.write("X  Y  Z  SLDN SLDMx  SLDMy  SLDMz VOLUMEpix")
713        for ind in range(length):
714            out.write("\n%g  %g  %g  %g  %g  %g  %g %g" % (x_val[ind], y_val[ind], 
715                                                    z_val[ind], sld_n[ind], 
716                                                    sld_mx[ind], sld_my[ind], 
717                                                    sld_mz[ind], vol_pix[ind])) 
718        out.close()       
719           
720           
721class OMFData:
722    """
723    OMF Data.
724    """
725    _meshunit = "A"
726    _valueunit = "A^(-2)"
727    def __init__(self):
728        """
729        Init for mag SLD
730        """
731        self.filename = 'default'
732        self.oommf = ''
733        self.title = ''
734        self.desc = ''
735        self.meshtype = ''
736        self.meshunit = self._meshunit
737        self.valueunit = self._valueunit
738        self.xbase = 0.0
739        self.ybase = 0.0
740        self.zbase = 0.0
741        self.xstepsize = 6.0
742        self.ystepsize = 6.0
743        self.zstepsize = 6.0
744        self.xnodes = 10.0
745        self.ynodes = 10.0
746        self.znodes = 10.0
747        self.xmin = 0.0
748        self.ymin = 0.0
749        self.zmin = 0.0
750        self.xmax = 60.0
751        self.ymax = 60.0
752        self.zmax = 60.0
753        self.mx = None
754        self.my = None
755        self.mz = None
756        self.valuemultiplier = 1.
757        self.valuerangeminmag = 0
758        self.valuerangemaxmag = 0
759       
760    def __str__(self):
761        """
762        doc strings
763        """
764        _str =  "Type:            %s\n" % self.__class__.__name__
765        _str += "File:            %s\n" % self.filename
766        _str += "OOMMF:           %s\n" % self.oommf
767        _str += "Title:           %s\n" % self.title
768        _str += "Desc:            %s\n" % self.desc
769        _str += "meshtype:        %s\n" % self.meshtype
770        _str += "meshunit:        %s\n" % str(self.meshunit)
771        _str += "xbase:           %s [%s]\n" % (str(self.xbase), self.meshunit)
772        _str += "ybase:           %s [%s]\n" % (str(self.ybase), self.meshunit)
773        _str += "zbase:           %s [%s]\n" % (str(self.zbase), self.meshunit)
774        _str += "xstepsize:       %s [%s]\n" % (str(self.xstepsize), 
775                                                self.meshunit)
776        _str += "ystepsize:       %s [%s]\n" % (str(self.ystepsize), 
777                                                self.meshunit)
778        _str += "zstepsize:       %s [%s]\n" % (str(self.zstepsize), 
779                                                self.meshunit)
780        _str += "xnodes:          %s\n" % str(self.xnodes)
781        _str += "ynodes:          %s\n" % str(self.ynodes)
782        _str += "znodes:          %s\n" % str(self.znodes)
783        _str += "xmin:            %s [%s]\n" % (str(self.xmin), self.meshunit)
784        _str += "ymin:            %s [%s]\n" % (str(self.ymin), self.meshunit)
785        _str += "zmin:            %s [%s]\n" % (str(self.zmin), self.meshunit)
786        _str += "xmax:            %s [%s]\n" % (str(self.xmax), self.meshunit)
787        _str += "ymax:            %s [%s]\n" % (str(self.ymax), self.meshunit)
788        _str += "zmax:            %s [%s]\n" % (str(self.zmax), self.meshunit)
789        _str += "valueunit:       %s\n" % self.valueunit
790        _str += "valuemultiplier: %s\n" % str(self.valuemultiplier)
791        _str += "ValueRangeMinMag:%s [%s]\n" % (str(self.valuerangeminmag), 
792                                                 self.valueunit)
793        _str += "ValueRangeMaxMag:%s [%s]\n" % (str(self.valuerangemaxmag), 
794                                                 self.valueunit)
795        return _str
796   
797    def set_m(self, mx, my, mz):
798        """
799        Set the Mx, My, Mz values
800        """
801        self.mx = mx
802        self.my = my
803        self.mz = mz
804               
805class MagSLD:
806    """
807    Magnetic SLD.
808    """
809    pos_x = None
810    pos_y = None
811    pos_z = None
812    sld_n = None
813    sld_mx = None
814    sld_my = None
815    sld_mz = None
816    # Units
817    _pos_unit = 'A'
818    _sld_unit = '1/A^(2)'
819    _pix_type = 'pixel'
820   
821    def __init__(self, pos_x, pos_y, pos_z, sld_n=None, 
822                 sld_mx=None, sld_my=None, sld_mz=None, vol_pix=None):
823        """
824        Init for mag SLD
825        :params : All should be numpy 1D array
826        """
827        self.is_data = True
828        self.filename = ''
829        self.xstepsize = 6.0
830        self.ystepsize = 6.0
831        self.zstepsize = 6.0
832        self.xnodes = 10.0
833        self.ynodes = 10.0
834        self.znodes = 10.0
835        self.has_stepsize = False
836        self.pos_unit = self._pos_unit
837        self.sld_unit = self._sld_unit
838        self.pix_type = 'pixel'
839        self.pos_x = pos_x
840        self.pos_y = pos_y
841        self.pos_z = pos_z
842        self.sld_n = sld_n
843        self.sld_mx = sld_mx
844        self.sld_my = sld_my
845        self.sld_mz = sld_mz
846        self.vol_pix = vol_pix
847        self.sld_m = None
848        self.sld_phi = None
849        self.sld_theta = None
850        self.pix_symbol = None
851        if sld_mx != None and sld_my != None and sld_mz != None:
852            self.set_sldms(sld_mx, sld_my, sld_mz)
853        self.set_nodes()
854                   
855    def __str__(self):
856        """
857        doc strings
858        """
859        _str =  "Type:       %s\n" % self.__class__.__name__
860        _str += "File:       %s\n" % self.filename
861        _str += "Axis_unit:  %s\n" % self.pos_unit
862        _str += "SLD_unit:   %s\n" % self.sld_unit
863        return _str
864   
865    def set_pix_type(self, pix_type):
866        """
867        Set pixel type
868        :Param pix_type: string, 'pixel' or 'atom'
869        """
870        self.pix_type = pix_type
871       
872    def set_sldn(self, sld_n):
873        """
874        Sets neutron SLD
875        """
876        if sld_n.__class__.__name__ == 'float':
877            if self.is_data:
878                # For data, put the value to only the pixels w non-zero M
879                is_nonzero = (numpy.fabs(self.sld_mx) + 
880                                  numpy.fabs(self.sld_my) + 
881                                  numpy.fabs(self.sld_mz)).nonzero() 
882                self.sld_n = numpy.zeros(len(self.pos_x))
883                if len(self.sld_n[is_nonzero]) > 0:
884                    self.sld_n[is_nonzero] = sld_n
885                else:
886                    self.sld_n.fill(sld_n)
887            else:
888                # For non-data, put the value to all the pixels
889                self.sld_n = numpy.ones(len(self.pos_x)) * sld_n
890        else:
891            self.sld_n = sld_n
892           
893    def set_sldms(self, sld_mx, sld_my, sld_mz):
894        """
895        Sets (|m|, m_theta, m_phi)
896        """
897        if sld_mx.__class__.__name__ == 'float':
898            self.sld_mx = numpy.ones(len(self.pos_x)) * sld_mx
899        else:
900            self.sld_mx = sld_mx
901        if sld_my.__class__.__name__ == 'float':
902            self.sld_my = numpy.ones(len(self.pos_x)) * sld_my
903        else:
904            self.sld_my = sld_my
905        if sld_mz.__class__.__name__ == 'float':
906            self.sld_mz = numpy.ones(len(self.pos_x)) * sld_mz
907        else:
908            self.sld_mz = sld_mz
909
910        sld_m = numpy.sqrt(sld_mx * sld_mx + sld_my * sld_my + \
911                                sld_mz * sld_mz) 
912        self.sld_m = sld_m
913   
914    def set_pixel_symbols(self, symbol='pixel'): 
915        """
916        Set pixel
917        :Params pixel: str; pixel or atomic symbol, or array of strings
918        """
919        if self.sld_n == None:
920            return
921        if symbol.__class__.__name__ == 'str':
922            self.pix_symbol = numpy.repeat(symbol, len(self.sld_n))
923        else:
924            self.pix_symbol = symbol
925           
926    def set_pixel_volumes(self, vol): 
927        """
928        Set pixel volumes
929        :Params pixel: str; pixel or atomic symbol, or array of strings
930        """
931        if self.sld_n == None:
932            return
933        if vol.__class__.__name__ == 'ndarray':
934            self.vol_pix = vol
935        elif vol.__class__.__name__.count('float') > 0:
936            self.vol_pix = numpy.repeat(vol, len(self.sld_n))
937        else:
938            self.vol_pix = None
939
940    def get_sldn(self):
941        """
942        Returns nuclear sld
943        """
944        return self.sld_n
945   
946    def get_sld_mxyz(self):
947        """
948        Returns (sld_mx, sldmy, sld_mz)
949        """
950        return (self.sld_mx, self.sldmy, self.sld_mz)
951   
952    def get_sld_m(self):
953        """
954        Returns (sldm, sld_theta, sld_phi)
955        """
956        return (self.sldm, self.sld_theta, self.sld_phi)
957   
958    def set_nodes(self):
959        """
960        Set xnodes, ynodes, and znodes
961        """
962        self.set_stepsize()
963        if self.pix_type == 'pixel':
964            try:
965                xdist = (max(self.pos_x) - min(self.pos_x)) / self.xstepsize
966                ydist = (max(self.pos_y) - min(self.pos_y)) / self.ystepsize
967                zdist = (max(self.pos_z) - min(self.pos_z)) / self.zstepsize
968                self.xnodes = int(xdist) + 1
969                self.ynodes = int(ydist) + 1
970                self.znodes = int(zdist) + 1
971            except:
972                self.xnodes = None
973                self.ynodes = None
974                self.znodes = None
975        else:
976            self.xnodes = None
977            self.ynodes = None
978            self.znodes = None
979     
980    def set_stepsize(self):
981        """
982        Set xtepsize, ystepsize, and zstepsize
983        """
984        if self.pix_type == 'pixel':
985            try:
986                xpos_pre = self.pos_x[0]
987                ypos_pre = self.pos_y[0]
988                zpos_pre = self.pos_z[0]
989                for x_pos in self.pos_x:
990                    if xpos_pre != x_pos:
991                        self.xstepsize = numpy.fabs(x_pos - xpos_pre)
992                        break
993                for y_pos in self.pos_y:
994                    if ypos_pre != y_pos:
995                        self.ystepsize = numpy.fabs(y_pos - ypos_pre)
996                        break
997                for z_pos in self.pos_z:
998                    if zpos_pre != z_pos:
999                        self.zstepsize = numpy.fabs(z_pos - zpos_pre)
1000                        break
1001                #default pix volume
1002                self.vol_pix = numpy.ones(len(self.pos_x))
1003                vol = self.xstepsize * self.ystepsize * self.zstepsize
1004                self.set_pixel_volumes(vol)
1005                self.has_stepsize = True
1006            except:
1007                self.xstepsize = None
1008                self.ystepsize = None
1009                self.zstepsize = None
1010                self.vol_pix = None
1011                self.has_stepsize = False
1012        else:
1013            self.xstepsize = None
1014            self.ystepsize = None
1015            self.zstepsize = None
1016            self.has_stepsize = True
1017        return self.xstepsize, self.ystepsize, self.zstepsize
1018
1019   
1020def test_load():
1021    from danse.common.plottools.arrow3d import Arrow3D
1022    import os
1023    dir = os.path.abspath(os.path.curdir)
1024    print dir
1025    for i in range(6):
1026        dir, _ = os.path.split(dir)
1027        tfile = os.path.join(dir, "test", "CoreXY_ShellZ.txt")
1028        ofile = os.path.join(dir, "test", "A_Raw_Example-1.omf")
1029        if os.path.isfile(tfile):
1030            tfpath = tfile
1031            ofpath = ofile
1032            break
1033    reader = SLDReader()
1034    oreader = OMFReader()
1035    output = reader.read(tfpath)
1036    ooutput = oreader.read(ofpath)
1037    foutput = OMF2SLD()
1038    foutput.set_data(ooutput)
1039
1040    import matplotlib.pyplot as plt
1041    from mpl_toolkits.mplot3d import Axes3D
1042    fig = plt.figure()
1043    ax = fig.gca(projection='3d')
1044    ax.plot(output.pos_x, output.pos_y, output.pos_z, '.', c="g", 
1045            alpha = 0.7, markeredgecolor='gray',rasterized=True)
1046    gap = 7
1047    max_mx = max(output.sld_mx)
1048    max_my = max(output.sld_my)
1049    max_mz = max(output.sld_mz)
1050    max_m = max(max_mx,max_my,max_mz)
1051    x2 = output.pos_x+output.sld_mx/max_m * gap
1052    y2 = output.pos_y+output.sld_my/max_m * gap
1053    z2 = output.pos_z+output.sld_mz/max_m * gap
1054    x_arrow = numpy.column_stack((output.pos_x,x2))
1055    y_arrow = numpy.column_stack((output.pos_y,y2))
1056    z_arrow = numpy.column_stack((output.pos_z,z2))
1057    unit_x2 = output.sld_mx / max_m
1058    unit_y2 = output.sld_my / max_m
1059    unit_z2 = output.sld_mz / max_m
1060    color_x = numpy.fabs(unit_x2 * 0.8)
1061    color_y = numpy.fabs(unit_y2 * 0.8)
1062    color_z = numpy.fabs(unit_z2 * 0.8)
1063    colors =  numpy.column_stack((color_x, color_y, color_z))
1064    a = Arrow3D(None, x_arrow,y_arrow,z_arrow, colors, mutation_scale=10, lw=1, 
1065                arrowstyle="->", color="y", alpha = 0.5)
1066
1067    ax.add_artist(a)
1068    plt.show()
1069   
1070def test():
1071    import os
1072    dir = os.path.abspath(os.path.curdir)
1073    for i in range(3):
1074        dir, _ = os.path.split(dir)
1075        #tfile = os.path.join(dir, "test", "C_Example_Converted.txt")
1076        ofile = os.path.join(dir, "test", "A_Raw_Example-1.omf")
1077        if os.path.isfile(ofile):
1078            #tfpath = tfile
1079            ofpath = ofile
1080            break
1081    #reader = SLDReader()
1082    oreader = OMFReader()
1083    #output = reader.read(tfpath)
1084    ooutput = oreader.read(ofpath)
1085    foutput = OMF2SLD() 
1086    foutput.set_data(ooutput) 
1087    writer =  SLDReader() 
1088    writer.write(os.path.join(os.path.dirname(ofpath), "out.txt"), 
1089                 foutput.output)
1090    model = GenSAS()
1091    model.set_sld_data(foutput.output) 
1092    x = numpy.arange(1000)/10000. + 1e-5
1093    y = numpy.arange(1000)/10000. + 1e-5
1094    #z = numpy.arange(1000)/10000. + 1e-5
1095    i = numpy.zeros(1000)
1096    out = model.runXY([x,y,i])
1097       
1098if __name__ == "__main__": 
1099    test()
1100    test_load()
Note: See TracBrowser for help on using the repository browser.