source: sasview/src/sans/models/ReflModel.py @ 400155b

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 400155b was 400155b, checked in by gonzalezm, 9 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: 9.8 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\refl.h
23   AND RE-RUN THE GENERATOR SCRIPT
24"""
25
26from sans.models.BaseComponent import BaseComponent
27from sans.models.sans_extension.c_models import CReflModel
28
29def create_ReflModel():
30    """
31       Create a model instance
32    """
33    obj = ReflModel()
34    # CReflModel.__init__(obj) is called by
35    # the ReflModel constructor
36    return obj
37
38class ReflModel(CReflModel, BaseComponent):
39    """
40    Class that evaluates a ReflModel model.
41    This file was auto-generated from src\sans\models\include\refl.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_layers        = 1.0
48    * scale           = 1.0
49    * thick_inter0    = 1.0 [A]
50    * func_inter0     = 0.0
51    * sld_bottom0     = 2.07e-06 [1/A^(2)]
52    * sld_medium      = 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    = 1.0 [A]
65    * thick_inter2    = 1.0 [A]
66    * thick_inter3    = 1.0 [A]
67    * thick_inter4    = 1.0 [A]
68    * thick_inter5    = 1.0 [A]
69    * thick_inter6    = 1.0 [A]
70    * thick_inter7    = 1.0 [A]
71    * thick_inter8    = 1.0 [A]
72    * thick_inter9    = 1.0 [A]
73    * thick_inter10   = 1.0 [A]
74    * thick_flat1     = 10.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
95    """
96       
97    def __init__(self, multfactor=1):
98        """ Initialization """
99        self.__dict__ = {}
100       
101        # Initialize BaseComponent first, then sphere
102        BaseComponent.__init__(self)
103        #apply(CReflModel.__init__, (self,))
104
105        CReflModel.__init__(self)
106        self.is_multifunc = False
107                       
108        ## Name of the model
109        self.name = "ReflModel"
110        ## Model description
111        self.description = """
112        Calculate neutron reflectivity using the Parratt iterative formula
113                Parameters:
114                background:background
115                scale: scale factor
116                sld_bottom0: the SLD of the substrate
117                sld_medium: the SLD of the incident medium
118                or superstrate
119                sld_flatN: the SLD of the flat region of
120                the N'th layer
121                thick_flatN: the thickness of the flat
122                region of the N'th layer
123                func_interN: the function used to describe
124                the interface of the N'th layer
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       
131        ## Parameter details [units, min, max]
132        self.details = {}
133        self.details['n_layers'] = ['', None, None]
134        self.details['scale'] = ['', None, None]
135        self.details['thick_inter0'] = ['[A]', None, None]
136        self.details['func_inter0'] = ['', None, None]
137        self.details['sld_bottom0'] = ['[1/A^(2)]', None, None]
138        self.details['sld_medium'] = ['[1/A^(2)]', None, None]
139        self.details['background'] = ['', None, None]
140        self.details['sld_flat1'] = ['[1/A^(2)]', None, None]
141        self.details['sld_flat2'] = ['[1/A^(2)]', None, None]
142        self.details['sld_flat3'] = ['[1/A^(2)]', None, None]
143        self.details['sld_flat4'] = ['[1/A^(2)]', None, None]
144        self.details['sld_flat5'] = ['[1/A^(2)]', None, None]
145        self.details['sld_flat6'] = ['[1/A^(2)]', None, None]
146        self.details['sld_flat7'] = ['[1/A^(2)]', None, None]
147        self.details['sld_flat8'] = ['[1/A^(2)]', None, None]
148        self.details['sld_flat9'] = ['[1/A^(2)]', None, None]
149        self.details['sld_flat10'] = ['[1/A^(2)]', None, None]
150        self.details['thick_inter1'] = ['[A]', None, None]
151        self.details['thick_inter2'] = ['[A]', None, None]
152        self.details['thick_inter3'] = ['[A]', None, None]
153        self.details['thick_inter4'] = ['[A]', None, None]
154        self.details['thick_inter5'] = ['[A]', None, None]
155        self.details['thick_inter6'] = ['[A]', None, None]
156        self.details['thick_inter7'] = ['[A]', None, None]
157        self.details['thick_inter8'] = ['[A]', None, None]
158        self.details['thick_inter9'] = ['[A]', None, None]
159        self.details['thick_inter10'] = ['[A]', None, None]
160        self.details['thick_flat1'] = ['[A]', None, None]
161        self.details['thick_flat2'] = ['[A]', None, None]
162        self.details['thick_flat3'] = ['[A]', None, None]
163        self.details['thick_flat4'] = ['[A]', None, None]
164        self.details['thick_flat5'] = ['[A]', None, None]
165        self.details['thick_flat6'] = ['[A]', None, None]
166        self.details['thick_flat7'] = ['[A]', None, None]
167        self.details['thick_flat8'] = ['[A]', None, None]
168        self.details['thick_flat9'] = ['[A]', None, None]
169        self.details['thick_flat10'] = ['[A]', None, None]
170        self.details['func_inter1'] = ['', None, None]
171        self.details['func_inter2'] = ['', None, None]
172        self.details['func_inter3'] = ['', None, None]
173        self.details['func_inter4'] = ['', None, None]
174        self.details['func_inter5'] = ['', None, None]
175        self.details['func_inter6'] = ['', None, None]
176        self.details['func_inter7'] = ['', None, None]
177        self.details['func_inter8'] = ['', None, None]
178        self.details['func_inter9'] = ['', None, None]
179        self.details['func_inter10'] = ['', None, None]
180
181        ## fittable parameters
182        self.fixed = []
183       
184        ## non-fittable parameters
185        self.non_fittable = ['n_layers',
186                             'func_inter0',
187                             'func_inter1',
188                             'func_inter2',
189                             'func_inter3',
190                             'func_inter4',
191                             'func_inter5',
192                             'func_inter5',
193                             'func_inter7',
194                             'func_inter8',
195                             'func_inter9',
196                             'func_inter10']
197       
198        ## parameters with orientation
199        self.orientation_params = []
200
201        ## parameters with magnetism
202        self.magnetic_params = []
203
204        self.category = None
205        self.multiplicity_info = None
206       
207    def __setstate__(self, state):
208        """
209        restore the state of a model from pickle
210        """
211        self.__dict__, self.params, self.dispersion = state
212       
213    def __reduce_ex__(self, proto):
214        """
215        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
216        c model.
217        """
218        state = (self.__dict__, self.params, self.dispersion)
219        return (create_ReflModel, tuple(), state, None, None)
220       
221    def clone(self):
222        """ Return a identical copy of self """
223        return self._clone(ReflModel())   
224       
225    def run(self, x=0.0):
226        """
227        Evaluate the model
228       
229        :param x: input q, or [q,phi]
230       
231        :return: scattering function P(q)
232       
233        """
234        return CReflModel.run(self, x)
235   
236    def runXY(self, x=0.0):
237        """
238        Evaluate the model in cartesian coordinates
239       
240        :param x: input q, or [qx, qy]
241       
242        :return: scattering function P(q)
243       
244        """
245        return CReflModel.runXY(self, x)
246       
247    def evalDistribution(self, x):
248        """
249        Evaluate the model in cartesian coordinates
250       
251        :param x: input q[], or [qx[], qy[]]
252       
253        :return: scattering function P(q[])
254       
255        """
256        return CReflModel.evalDistribution(self, x)
257       
258    def calculate_ER(self):
259        """
260        Calculate the effective radius for P(q)*S(q)
261       
262        :return: the value of the effective radius
263       
264        """       
265        return CReflModel.calculate_ER(self)
266       
267    def calculate_VR(self):
268        """
269        Calculate the volf ratio for P(q)*S(q)
270       
271        :return: the value of the volf ratio
272       
273        """       
274        return CReflModel.calculate_VR(self)
275             
276    def set_dispersion(self, parameter, dispersion):
277        """
278        Set the dispersion object for a model parameter
279       
280        :param parameter: name of the parameter [string]
281        :param dispersion: dispersion object of type DispersionModel
282       
283        """
284        return CReflModel.set_dispersion(self,
285               parameter, dispersion.cdisp)
286       
287   
288# End of file
289
Note: See TracBrowser for help on using the repository browser.