source: sasview/src/sans/models/SphereSLDModel.py @ d09f0ae1

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 d09f0ae1 was 400155b, checked in by gonzalezm, 10 years ago

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