source: sasview/src/sans/models/ReflModel.py @ 81b524f

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 81b524f was 81b524f, checked in by Jeff Krzywon <jeffery.krzywon@…>, 11 years ago

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