source: sasview/sansmodels/src/sans/models/LamellarModel.py @ fe9c19b4

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 fe9c19b4 was fe9c19b4, checked in by Gervaise Alina <gervyh@…>, 15 years ago

implement set and get state

  • Property mode set to 100644
File size: 4.7 KB
Line 
1#!/usr/bin/env python
2"""
3        This software was developed by the University of Tennessee as part of the
4        Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
5        project funded by the US National Science Foundation.
6
7        If you use DANSE applications to do scientific research that leads to
8        publication, we ask that you acknowledge the use of the software with the
9        following sentence:
10
11        "This work benefited from DANSE software developed under NSF award DMR-0520547."
12
13        copyright 2008, University of Tennessee
14"""
15
16""" Provide functionality for a C extension model
17
18        WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
19                 DO NOT MODIFY THIS FILE, MODIFY ..\c_extensions\lamellar.h
20                 AND RE-RUN THE GENERATOR SCRIPT
21
22"""
23
24from sans.models.BaseComponent import BaseComponent
25from sans_extension.c_models import CLamellarModel
26import copy   
27   
28class LamellarModel(CLamellarModel, BaseComponent):
29    """ Class that evaluates a LamellarModel model.
30        This file was auto-generated from ..\c_extensions\lamellar.h.
31        Refer to that file and the structure it contains
32        for details of the model.
33        List of default parameters:
34         scale           = 1.0
35         bi_thick        = 50.0 [A]
36         sld_bi          = 1e-006 [1/A^(2)]
37         sld_sol         = 6.3e-006 [1/A^(2)]
38         background      = 0.0 [1/cm]
39
40    """
41       
42    def __init__(self):
43        """ Initialization """
44       
45        # Initialize BaseComponent first, then sphere
46        BaseComponent.__init__(self)
47        CLamellarModel.__init__(self)
48       
49        ## Name of the model
50        self.name = "LamellarModel"
51        ## Model description
52        self.description ="""[Dilute Lamellar Form Factor](from a lyotropic lamellar phase)
53                I(q)= 2*pi*P(q)/(delta *q^(2)), where
54                P(q)=2*(contrast/q)^(2)*(1-cos(q*delta))^(2))
55                bi_thick = bilayer thickness
56                sld_bi = SLD of bilayer
57                sld_sol = SLD of solvent
58                background = Incoherent background
59                scale = scale factor
60                """
61       
62        ## Parameter details [units, min, max]
63        self.details = {}
64        self.details['scale'] = ['', None, None]
65        self.details['bi_thick'] = ['[A]', None, None]
66        self.details['sld_bi'] = ['[1/A^(2)]', None, None]
67        self.details['sld_sol'] = ['[1/A^(2)]', None, None]
68        self.details['background'] = ['[1/cm]', None, None]
69
70        ## fittable parameters
71        self.fixed=[]
72       
73        ## parameters with orientation
74        self.orientation_params =[]
75   
76    def clone(self):
77        """ Return a identical copy of self """
78        return self._clone(LamellarModel())   
79       
80    def __getstate__(self):
81        """ return object state for pickling and copying """
82        print "__dict__",self.__dict__
83        #self.__dict__['params'] = self.params
84        #self.__dict__['dispersion'] = self.dispersion
85        #self.__dict__['log'] = self.log
86        model_state = {'params': self.params, 'dispersion': self.dispersion, 'log': self.log}
87       
88        return self.__dict__, model_state
89       
90    def __setstate__(self, state):
91        """ create object from pickled state """
92       
93        self.__dict__, model_state = state
94        self.params = model_state['params']
95        self.dispersion = model_state['dispersion']
96        self.log = model_state['log']
97       
98   
99    def run(self, x = 0.0):
100        """ Evaluate the model
101            @param x: input q, or [q,phi]
102            @return: scattering function P(q)
103        """
104       
105        return CLamellarModel.run(self, x)
106   
107    def runXY(self, x = 0.0):
108        """ Evaluate the model in cartesian coordinates
109            @param x: input q, or [qx, qy]
110            @return: scattering function P(q)
111        """
112       
113        return CLamellarModel.runXY(self, x)
114       
115    def evalDistribition(self, x = []):
116        """ Evaluate the model in cartesian coordinates
117            @param x: input q[], or [qx[], qy[]]
118            @return: scattering function P(q[])
119        """
120        return CLamellarModel.evalDistribition(self, x)
121       
122    def calculate_ER(self):
123        """ Calculate the effective radius for P(q)*S(q)
124            @return: the value of the effective radius
125        """       
126        return CLamellarModel.calculate_ER(self)
127       
128    def set_dispersion(self, parameter, dispersion):
129        """
130            Set the dispersion object for a model parameter
131            @param parameter: name of the parameter [string]
132            @dispersion: dispersion object of type DispersionModel
133        """
134        return CLamellarModel.set_dispersion(self, parameter, dispersion.cdisp)
135       
136   
137# End of file
Note: See TracBrowser for help on using the repository browser.