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

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 48b29eb was 92df66f8, checked in by Gervaise Alina <gervyh@…>, 13 years ago

commit wrap model
  • Property mode set to 100644
File size: 10.7 KB
RevLine 
[4b3d25b]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
[92df66f8]28from sans.models.sans_extension.c_models import CSphereSLDModel
[4b3d25b]29import copy   
[96656e3]30
31def create_SphereSLDModel():
32    obj = SphereSLDModel()
33    #CSphereSLDModel.__init__(obj) is called by SphereSLDModel constructor
34    return obj
35
[4b3d25b]36class SphereSLDModel(CSphereSLDModel, BaseComponent):
37    """
38    Class that evaluates a SphereSLDModel model.
39    This file was auto-generated from ..\c_extensions\spheresld.h.
40    Refer to that file and the structure it contains
41    for details of the model.
42    List of default parameters:
43         n_shells        = 1.0
44         scale           = 1.0
45         thick_inter0    = 50.0 [A]
46         func_inter0     = 0.0
[92df66f8]47         sld_core0       = 2.07e-06 [1/A^(2)]
48         sld_solv        = 1e-06 [1/A^(2)]
[4b3d25b]49         background      = 0.0
[92df66f8]50         sld_flat1       = 4e-06 [1/A^(2)]
51         sld_flat2       = 3.5e-06 [1/A^(2)]
52         sld_flat3       = 4e-06 [1/A^(2)]
53         sld_flat4       = 3.5e-06 [1/A^(2)]
54         sld_flat5       = 4e-06 [1/A^(2)]
55         sld_flat6       = 3.5e-06 [1/A^(2)]
56         sld_flat7       = 4e-06 [1/A^(2)]
57         sld_flat8       = 3.5e-06 [1/A^(2)]
58         sld_flat9       = 4e-06 [1/A^(2)]
59         sld_flat10      = 3.5e-06 [1/A^(2)]
[4b3d25b]60         thick_inter1    = 50.0 [A]
61         thick_inter2    = 50.0 [A]
62         thick_inter3    = 50.0 [A]
63         thick_inter4    = 50.0 [A]
64         thick_inter5    = 50.0 [A]
65         thick_inter6    = 50.0 [A]
66         thick_inter7    = 50.0 [A]
67         thick_inter8    = 50.0 [A]
68         thick_inter9    = 50.0 [A]
69         thick_inter10   = 50.0 [A]
70         thick_flat1     = 100.0 [A]
71         thick_flat2     = 100.0 [A]
72         thick_flat3     = 100.0 [A]
73         thick_flat4     = 100.0 [A]
74         thick_flat5     = 100.0 [A]
75         thick_flat6     = 100.0 [A]
76         thick_flat7     = 100.0 [A]
77         thick_flat8     = 100.0 [A]
78         thick_flat9     = 100.0 [A]
79         thick_flat10    = 100.0 [A]
80         func_inter1     = 0.0
81         func_inter2     = 0.0
82         func_inter3     = 0.0
83         func_inter4     = 0.0
84         func_inter5     = 0.0
85         func_inter6     = 0.0
86         func_inter7     = 0.0
87         func_inter8     = 0.0
88         func_inter9     = 0.0
89         func_inter10    = 0.0
90         nu_inter1       = 2.5
91         nu_inter2       = 2.5
92         nu_inter3       = 2.5
93         nu_inter4       = 2.5
94         nu_inter5       = 2.5
95         nu_inter6       = 2.5
96         nu_inter7       = 2.5
97         nu_inter8       = 2.5
98         nu_inter9       = 2.5
99         nu_inter10      = 2.5
100         npts_inter      = 35.0
101         nu_inter0       = 2.5
102         rad_core0       = 50.0 [A]
103
104    """
105       
106    def __init__(self):
107        """ Initialization """
108       
109        # Initialize BaseComponent first, then sphere
110        BaseComponent.__init__(self)
[96656e3]111        #apply(CSphereSLDModel.__init__, (self,))
[4b3d25b]112        CSphereSLDModel.__init__(self)
113       
114        ## Name of the model
115        self.name = "SphereSLDModel"
116        ## Model description
117        self.description ="""Calculate neutron reflectivity using the Parratt iterative formula
118                Parameters:
119                background:background
120                scale: scale factor
121                sld_core0: the SLD of the substrate
122                sld_solv: the SLD of the incident medium
123                or superstrate
124                sld_flatN: the SLD of the flat region of
125                the N'th layer
126                thick_flatN: the thickness of the flat
127                region of the N'th layer
128                func_interN: the function used to describe
129                the interface of the N'th layer
130                nu_interN: the coefficient for the func_interN
131                thick_interN: the thickness of the interface
132                of the N'th layer
133                Note: the layer number starts to increase
134                from the bottom (substrate) to the top."""
135       
136        ## Parameter details [units, min, max]
137        self.details = {}
138        self.details['n_shells'] = ['', None, None]
139        self.details['scale'] = ['', None, None]
140        self.details['thick_inter0'] = ['[A]', None, None]
141        self.details['func_inter0'] = ['', None, None]
142        self.details['sld_core0'] = ['[1/A^(2)]', None, None]
143        self.details['sld_solv'] = ['[1/A^(2)]', None, None]
144        self.details['background'] = ['', None, None]
145        self.details['sld_flat1'] = ['[1/A^(2)]', None, None]
146        self.details['sld_flat2'] = ['[1/A^(2)]', None, None]
147        self.details['sld_flat3'] = ['[1/A^(2)]', None, None]
148        self.details['sld_flat4'] = ['[1/A^(2)]', None, None]
149        self.details['sld_flat5'] = ['[1/A^(2)]', None, None]
150        self.details['sld_flat6'] = ['[1/A^(2)]', None, None]
151        self.details['sld_flat7'] = ['[1/A^(2)]', None, None]
152        self.details['sld_flat8'] = ['[1/A^(2)]', None, None]
153        self.details['sld_flat9'] = ['[1/A^(2)]', None, None]
154        self.details['sld_flat10'] = ['[1/A^(2)]', None, None]
155        self.details['thick_inter1'] = ['[A]', None, None]
156        self.details['thick_inter2'] = ['[A]', None, None]
157        self.details['thick_inter3'] = ['[A]', None, None]
158        self.details['thick_inter4'] = ['[A]', None, None]
159        self.details['thick_inter5'] = ['[A]', None, None]
160        self.details['thick_inter6'] = ['[A]', None, None]
161        self.details['thick_inter7'] = ['[A]', None, None]
162        self.details['thick_inter8'] = ['[A]', None, None]
163        self.details['thick_inter9'] = ['[A]', None, None]
164        self.details['thick_inter10'] = ['[A]', None, None]
165        self.details['thick_flat1'] = ['[A]', None, None]
166        self.details['thick_flat2'] = ['[A]', None, None]
167        self.details['thick_flat3'] = ['[A]', None, None]
168        self.details['thick_flat4'] = ['[A]', None, None]
169        self.details['thick_flat5'] = ['[A]', None, None]
170        self.details['thick_flat6'] = ['[A]', None, None]
171        self.details['thick_flat7'] = ['[A]', None, None]
172        self.details['thick_flat8'] = ['[A]', None, None]
173        self.details['thick_flat9'] = ['[A]', None, None]
174        self.details['thick_flat10'] = ['[A]', None, None]
175        self.details['func_inter1'] = ['', None, None]
176        self.details['func_inter2'] = ['', None, None]
177        self.details['func_inter3'] = ['', None, None]
178        self.details['func_inter4'] = ['', None, None]
179        self.details['func_inter5'] = ['', None, None]
180        self.details['func_inter6'] = ['', None, None]
181        self.details['func_inter7'] = ['', None, None]
182        self.details['func_inter8'] = ['', None, None]
183        self.details['func_inter9'] = ['', None, None]
184        self.details['func_inter10'] = ['', None, None]
185        self.details['nu_inter1'] = ['', None, None]
186        self.details['nu_inter2'] = ['', None, None]
187        self.details['nu_inter3'] = ['', None, None]
188        self.details['nu_inter4'] = ['', None, None]
189        self.details['nu_inter5'] = ['', None, None]
190        self.details['nu_inter6'] = ['', None, None]
191        self.details['nu_inter7'] = ['', None, None]
192        self.details['nu_inter8'] = ['', None, None]
193        self.details['nu_inter9'] = ['', None, None]
194        self.details['nu_inter10'] = ['', None, None]
195        self.details['npts_inter'] = ['', None, None]
196        self.details['nu_inter0'] = ['', None, None]
197        self.details['rad_core0'] = ['[A]', None, None]
198
199        ## fittable parameters
[7a8faf8]200        self.fixed=['rad_core0.width', 'thick_inter0.width']
[4b3d25b]201       
202        ## non-fittable parameters
[96656e3]203        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']
[4b3d25b]204       
205        ## parameters with orientation
[96656e3]206        self.orientation_params = []
[c7a7e1b]207
208    def __setstate__(self, state):
209        """
210        restore the state of a model from pickle
211        """
212        self.__dict__, self.params, self.dispersion = state
213       
[96656e3]214    def __reduce_ex__(self, proto):
[4b3d25b]215        """
[96656e3]216        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
217        c model.
[4b3d25b]218        """
[c7a7e1b]219        state = (self.__dict__, self.params, self.dispersion)
220        return (create_SphereSLDModel,tuple(), state, None, None)
[4b3d25b]221       
[96656e3]222    def clone(self):
223        """ Return a identical copy of self """
224        return self._clone(SphereSLDModel())   
[4b3d25b]225       
226   
227    def run(self, x=0.0):
228        """
229        Evaluate the model
230       
231        :param x: input q, or [q,phi]
232       
233        :return: scattering function P(q)
234       
235        """
236       
237        return CSphereSLDModel.run(self, x)
238   
239    def runXY(self, x=0.0):
240        """
241        Evaluate the model in cartesian coordinates
242       
243        :param x: input q, or [qx, qy]
244       
245        :return: scattering function P(q)
246       
247        """
248       
249        return CSphereSLDModel.runXY(self, x)
250       
251    def evalDistribution(self, x=[]):
252        """
253        Evaluate the model in cartesian coordinates
254       
255        :param x: input q[], or [qx[], qy[]]
256       
257        :return: scattering function P(q[])
258       
259        """
260        return CSphereSLDModel.evalDistribution(self, x)
261       
262    def calculate_ER(self):
263        """
264        Calculate the effective radius for P(q)*S(q)
265       
266        :return: the value of the effective radius
267       
268        """       
269        return CSphereSLDModel.calculate_ER(self)
270       
271    def set_dispersion(self, parameter, dispersion):
272        """
273        Set the dispersion object for a model parameter
274       
275        :param parameter: name of the parameter [string]
276        :param dispersion: dispersion object of type DispersionModel
277       
278        """
279        return CSphereSLDModel.set_dispersion(self, parameter, dispersion.cdisp)
280       
281   
282# End of file
Note: See TracBrowser for help on using the repository browser.