source: sasview/sansmodels/src/sans/models/SphereSLDModel.py @ b9b9930

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 b9b9930 was 4b3d25b, checked in by Jae Cho <jhjcho@…>, 14 years ago

new model and some bug fixes
  • Property mode set to 100644
File size: 10.6 KB
Line 
1#!/usr/bin/env python
2
3##############################################################################
4#       This software was developed by the University of Tennessee as part of the
5#       Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
6#       project funded by the US National Science Foundation.
7#
8#       If you use DANSE applications to do scientific research that leads to
9#       publication, we ask that you acknowledge the use of the software with the
10#       following sentence:
11#
12#       "This work benefited from DANSE software developed under NSF award DMR-0520547."
13#
14#       copyright 2008, University of Tennessee
15##############################################################################
16
17
18"""
19Provide functionality for a C extension model
20
21:WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
22         DO NOT MODIFY THIS FILE, MODIFY ..\c_extensions\spheresld.h
23         AND RE-RUN THE GENERATOR SCRIPT
24
25"""
26
27from sans.models.BaseComponent import BaseComponent
28from sans_extension.c_models import CSphereSLDModel
29import copy   
30   
31class SphereSLDModel(CSphereSLDModel, BaseComponent):
32    """
33    Class that evaluates a SphereSLDModel model.
34    This file was auto-generated from ..\c_extensions\spheresld.h.
35    Refer to that file and the structure it contains
36    for details of the model.
37    List of default parameters:
38         n_shells        = 1.0
39         scale           = 1.0
40         thick_inter0    = 50.0 [A]
41         func_inter0     = 0.0
42         sld_core0       = 2.07e-006 [1/A^(2)]
43         sld_solv        = 1e-006 [1/A^(2)]
44         background      = 0.0
45         sld_flat1       = 4e-006 [1/A^(2)]
46         sld_flat2       = 3.5e-006 [1/A^(2)]
47         sld_flat3       = 4e-006 [1/A^(2)]
48         sld_flat4       = 3.5e-006 [1/A^(2)]
49         sld_flat5       = 4e-006 [1/A^(2)]
50         sld_flat6       = 3.5e-006 [1/A^(2)]
51         sld_flat7       = 4e-006 [1/A^(2)]
52         sld_flat8       = 3.5e-006 [1/A^(2)]
53         sld_flat9       = 4e-006 [1/A^(2)]
54         sld_flat10      = 3.5e-006 [1/A^(2)]
55         thick_inter1    = 50.0 [A]
56         thick_inter2    = 50.0 [A]
57         thick_inter3    = 50.0 [A]
58         thick_inter4    = 50.0 [A]
59         thick_inter5    = 50.0 [A]
60         thick_inter6    = 50.0 [A]
61         thick_inter7    = 50.0 [A]
62         thick_inter8    = 50.0 [A]
63         thick_inter9    = 50.0 [A]
64         thick_inter10   = 50.0 [A]
65         thick_flat1     = 100.0 [A]
66         thick_flat2     = 100.0 [A]
67         thick_flat3     = 100.0 [A]
68         thick_flat4     = 100.0 [A]
69         thick_flat5     = 100.0 [A]
70         thick_flat6     = 100.0 [A]
71         thick_flat7     = 100.0 [A]
72         thick_flat8     = 100.0 [A]
73         thick_flat9     = 100.0 [A]
74         thick_flat10    = 100.0 [A]
75         func_inter1     = 0.0
76         func_inter2     = 0.0
77         func_inter3     = 0.0
78         func_inter4     = 0.0
79         func_inter5     = 0.0
80         func_inter6     = 0.0
81         func_inter7     = 0.0
82         func_inter8     = 0.0
83         func_inter9     = 0.0
84         func_inter10    = 0.0
85         nu_inter1       = 2.5
86         nu_inter2       = 2.5
87         nu_inter3       = 2.5
88         nu_inter4       = 2.5
89         nu_inter5       = 2.5
90         nu_inter6       = 2.5
91         nu_inter7       = 2.5
92         nu_inter8       = 2.5
93         nu_inter9       = 2.5
94         nu_inter10      = 2.5
95         npts_inter      = 35.0
96         nu_inter0       = 2.5
97         rad_core0       = 50.0 [A]
98
99    """
100       
101    def __init__(self):
102        """ Initialization """
103       
104        # Initialize BaseComponent first, then sphere
105        BaseComponent.__init__(self)
106        CSphereSLDModel.__init__(self)
107       
108        ## Name of the model
109        self.name = "SphereSLDModel"
110        ## Model description
111        self.description ="""Calculate neutron reflectivity using the Parratt iterative formula
112                Parameters:
113                background:background
114                scale: scale factor
115                sld_core0: the SLD of the substrate
116                sld_solv: the SLD of the incident medium
117                or superstrate
118                sld_flatN: the SLD of the flat region of
119                the N'th layer
120                thick_flatN: the thickness of the flat
121                region of the N'th layer
122                func_interN: the function used to describe
123                the interface of the N'th layer
124                nu_interN: the coefficient for the func_interN
125                thick_interN: the thickness of the interface
126                of the N'th layer
127                Note: the layer number starts to increase
128                from the bottom (substrate) to the top."""
129       
130        ## Parameter details [units, min, max]
131        self.details = {}
132        self.details['n_shells'] = ['', None, None]
133        self.details['scale'] = ['', None, None]
134        self.details['thick_inter0'] = ['[A]', None, None]
135        self.details['func_inter0'] = ['', None, None]
136        self.details['sld_core0'] = ['[1/A^(2)]', None, None]
137        self.details['sld_solv'] = ['[1/A^(2)]', None, None]
138        self.details['background'] = ['', None, None]
139        self.details['sld_flat1'] = ['[1/A^(2)]', None, None]
140        self.details['sld_flat2'] = ['[1/A^(2)]', None, None]
141        self.details['sld_flat3'] = ['[1/A^(2)]', None, None]
142        self.details['sld_flat4'] = ['[1/A^(2)]', None, None]
143        self.details['sld_flat5'] = ['[1/A^(2)]', None, None]
144        self.details['sld_flat6'] = ['[1/A^(2)]', None, None]
145        self.details['sld_flat7'] = ['[1/A^(2)]', None, None]
146        self.details['sld_flat8'] = ['[1/A^(2)]', None, None]
147        self.details['sld_flat9'] = ['[1/A^(2)]', None, None]
148        self.details['sld_flat10'] = ['[1/A^(2)]', None, None]
149        self.details['thick_inter1'] = ['[A]', None, None]
150        self.details['thick_inter2'] = ['[A]', None, None]
151        self.details['thick_inter3'] = ['[A]', None, None]
152        self.details['thick_inter4'] = ['[A]', None, None]
153        self.details['thick_inter5'] = ['[A]', None, None]
154        self.details['thick_inter6'] = ['[A]', None, None]
155        self.details['thick_inter7'] = ['[A]', None, None]
156        self.details['thick_inter8'] = ['[A]', None, None]
157        self.details['thick_inter9'] = ['[A]', None, None]
158        self.details['thick_inter10'] = ['[A]', None, None]
159        self.details['thick_flat1'] = ['[A]', None, None]
160        self.details['thick_flat2'] = ['[A]', None, None]
161        self.details['thick_flat3'] = ['[A]', None, None]
162        self.details['thick_flat4'] = ['[A]', None, None]
163        self.details['thick_flat5'] = ['[A]', None, None]
164        self.details['thick_flat6'] = ['[A]', None, None]
165        self.details['thick_flat7'] = ['[A]', None, None]
166        self.details['thick_flat8'] = ['[A]', None, None]
167        self.details['thick_flat9'] = ['[A]', None, None]
168        self.details['thick_flat10'] = ['[A]', None, None]
169        self.details['func_inter1'] = ['', None, None]
170        self.details['func_inter2'] = ['', None, None]
171        self.details['func_inter3'] = ['', None, None]
172        self.details['func_inter4'] = ['', None, None]
173        self.details['func_inter5'] = ['', None, None]
174        self.details['func_inter6'] = ['', None, None]
175        self.details['func_inter7'] = ['', None, None]
176        self.details['func_inter8'] = ['', None, None]
177        self.details['func_inter9'] = ['', None, None]
178        self.details['func_inter10'] = ['', None, None]
179        self.details['nu_inter1'] = ['', None, None]
180        self.details['nu_inter2'] = ['', None, None]
181        self.details['nu_inter3'] = ['', None, None]
182        self.details['nu_inter4'] = ['', None, None]
183        self.details['nu_inter5'] = ['', None, None]
184        self.details['nu_inter6'] = ['', None, None]
185        self.details['nu_inter7'] = ['', None, None]
186        self.details['nu_inter8'] = ['', None, None]
187        self.details['nu_inter9'] = ['', None, None]
188        self.details['nu_inter10'] = ['', None, None]
189        self.details['npts_inter'] = ['', None, None]
190        self.details['nu_inter0'] = ['', None, None]
191        self.details['rad_core0'] = ['[A]', None, None]
192
193        ## fittable parameters
194        self.fixed=[]
195       
196        ## non-fittable parameters
197        self.non_fittable=['n_shells', 'func_inter0', 'func_inter1', 'func_inter2', 'func_inter3', 'func_inter4', 'func_inter5', 'func_inter5', 'func_inter7', 'func_inter8', 'func_inter9', 'func_inter10']
198       
199        ## parameters with orientation
200        self.orientation_params =[]
201   
202    def clone(self):
203        """ Return a identical copy of self """
204        return self._clone(SphereSLDModel())   
205       
206    def __getstate__(self):
207        """
208        return object state for pickling and copying
209        """
210        model_state = {'params': self.params, 'dispersion': self.dispersion, 'log': self.log}
211       
212        return self.__dict__, model_state
213       
214    def __setstate__(self, state):
215        """
216        create object from pickled state
217       
218        :param state: the state of the current model
219       
220        """
221       
222        self.__dict__, model_state = state
223        self.params = model_state['params']
224        self.dispersion = model_state['dispersion']
225        self.log = model_state['log']
226       
227   
228    def run(self, x=0.0):
229        """
230        Evaluate the model
231       
232        :param x: input q, or [q,phi]
233       
234        :return: scattering function P(q)
235       
236        """
237       
238        return CSphereSLDModel.run(self, x)
239   
240    def runXY(self, x=0.0):
241        """
242        Evaluate the model in cartesian coordinates
243       
244        :param x: input q, or [qx, qy]
245       
246        :return: scattering function P(q)
247       
248        """
249       
250        return CSphereSLDModel.runXY(self, x)
251       
252    def evalDistribution(self, x=[]):
253        """
254        Evaluate the model in cartesian coordinates
255       
256        :param x: input q[], or [qx[], qy[]]
257       
258        :return: scattering function P(q[])
259       
260        """
261        return CSphereSLDModel.evalDistribution(self, x)
262       
263    def calculate_ER(self):
264        """
265        Calculate the effective radius for P(q)*S(q)
266       
267        :return: the value of the effective radius
268       
269        """       
270        return CSphereSLDModel.calculate_ER(self)
271       
272    def set_dispersion(self, parameter, dispersion):
273        """
274        Set the dispersion object for a model parameter
275       
276        :param parameter: name of the parameter [string]
277        :param dispersion: dispersion object of type DispersionModel
278       
279        """
280        return CSphereSLDModel.set_dispersion(self, parameter, dispersion.cdisp)
281       
282   
283# End of file
Note: See TracBrowser for help on using the repository browser.