ReflAdvModel.py @ bdc25e2

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 bdc25e2 was c7a7e1b, checked in by Gervaise Alina <gervyh@…>, 14 years ago
working on model pickle
Property mode set to `100644`
File size: 11.8 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	"""
19	Provide 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\refl_adv.h
23	AND RE-RUN THE GENERATOR SCRIPT
24
25	"""
26
27	from sans.models.BaseComponent import BaseComponent
28	from sans_extension.c_models import CReflAdvModel
29	import copy
30
31	def create_ReflAdvModel():
32	obj = ReflAdvModel()
33	#CReflAdvModel.__init__(obj) is called by ReflAdvModel constructor
34	return obj
35
36	class ReflAdvModel(CReflAdvModel, BaseComponent):
37	"""
38	Class that evaluates a ReflAdvModel model.
39	This file was auto-generated from ..\c_extensions\refl_adv.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 = 50.0 [A]
46	func_inter0 = 0.0
47	sld_bottom0 = 2.07e-006 [1/A^(2)]
48	sld_medium = 1e-006 [1/A^(2)]
49	background = 0.0
50	sld_flat1 = 4e-006 [1/A^(2)]
51	sld_flat2 = 3.5e-006 [1/A^(2)]
52	sld_flat3 = 4e-006 [1/A^(2)]
53	sld_flat4 = 3.5e-006 [1/A^(2)]
54	sld_flat5 = 4e-006 [1/A^(2)]
55	sld_flat6 = 3.5e-006 [1/A^(2)]
56	sld_flat7 = 4e-006 [1/A^(2)]
57	sld_flat8 = 3.5e-006 [1/A^(2)]
58	sld_flat9 = 4e-006 [1/A^(2)]
59	sld_flat10 = 3.5e-006 [1/A^(2)]
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	sldIM_flat1 = 0.0 [1/A^(2)]
91	sldIM_flat2 = 0.0 [1/A^(2)]
92	sldIM_flat3 = 0.0 [1/A^(2)]
93	sldIM_flat4 = 0.0 [1/A^(2)]
94	sldIM_flat5 = 0.0 [1/A^(2)]
95	sldIM_flat6 = 0.0 [1/A^(2)]
96	sldIM_flat7 = 0.0 [1/A^(2)]
97	sldIM_flat8 = 0.0 [1/A^(2)]
98	sldIM_flat9 = 0.0 [1/A^(2)]
99	sldIM_flat10 = 0.0 [1/A^(2)]
100	nu_inter1 = 2.5
101	nu_inter2 = 2.5
102	nu_inter3 = 2.5
103	nu_inter4 = 2.5
104	nu_inter5 = 2.5
105	nu_inter6 = 2.5
106	nu_inter7 = 2.5
107	nu_inter8 = 2.5
108	nu_inter9 = 2.5
109	nu_inter10 = 2.5
110	sldIM_sub0 = 0.0
111	sldIM_medium = 0.0
112	npts_inter = 21.0
113	nu_inter0 = 2.5
114
115	"""
116
117	def __init__(self):
118	""" Initialization """
119
120	# Initialize BaseComponent first, then sphere
121	BaseComponent.__init__(self)
122	#apply(CReflAdvModel.__init__, (self,))
123	CReflAdvModel.__init__(self)
124
125	## Name of the model
126	self.name = "ReflAdvModel"
127	## Model description
128	self.description ="""Calculate neutron reflectivity using the Parratt iterative formula
129	Parameters:
130	background:background
131	scale: scale factor
132	sld_bottom0: the SLD of the substrate
133	sld_medium: the SLD of the incident medium
134	or superstrate
135	sld_flatN: the SLD of the flat region of
136	the N'th layer
137	thick_flatN: the thickness of the flat
138	region of the N'th layer
139	func_interN: the function used to describe
140	the interface of the N'th layer
141	nu_interN: the coefficient for the func_interN
142	thick_interN: the thickness of the interface
143	of the N'th layer
144	Note: the layer number starts to increase
145	from the bottom (substrate) to the top."""
146
147	## Parameter details [units, min, max]
148	self.details = {}
149	self.details['n_layers'] = ['', None, None]
150	self.details['scale'] = ['', None, None]
151	self.details['thick_inter0'] = ['[A]', None, None]
152	self.details['func_inter0'] = ['', None, None]
153	self.details['sld_bottom0'] = ['[1/A^(2)]', None, None]
154	self.details['sld_medium'] = ['[1/A^(2)]', None, None]
155	self.details['background'] = ['', None, None]
156	self.details['sld_flat1'] = ['[1/A^(2)]', None, None]
157	self.details['sld_flat2'] = ['[1/A^(2)]', None, None]
158	self.details['sld_flat3'] = ['[1/A^(2)]', None, None]
159	self.details['sld_flat4'] = ['[1/A^(2)]', None, None]
160	self.details['sld_flat5'] = ['[1/A^(2)]', None, None]
161	self.details['sld_flat6'] = ['[1/A^(2)]', None, None]
162	self.details['sld_flat7'] = ['[1/A^(2)]', None, None]
163	self.details['sld_flat8'] = ['[1/A^(2)]', None, None]
164	self.details['sld_flat9'] = ['[1/A^(2)]', None, None]
165	self.details['sld_flat10'] = ['[1/A^(2)]', None, None]
166	self.details['thick_inter1'] = ['[A]', None, None]
167	self.details['thick_inter2'] = ['[A]', None, None]
168	self.details['thick_inter3'] = ['[A]', None, None]
169	self.details['thick_inter4'] = ['[A]', None, None]
170	self.details['thick_inter5'] = ['[A]', None, None]
171	self.details['thick_inter6'] = ['[A]', None, None]
172	self.details['thick_inter7'] = ['[A]', None, None]
173	self.details['thick_inter8'] = ['[A]', None, None]
174	self.details['thick_inter9'] = ['[A]', None, None]
175	self.details['thick_inter10'] = ['[A]', None, None]
176	self.details['thick_flat1'] = ['[A]', None, None]
177	self.details['thick_flat2'] = ['[A]', None, None]
178	self.details['thick_flat3'] = ['[A]', None, None]
179	self.details['thick_flat4'] = ['[A]', None, None]
180	self.details['thick_flat5'] = ['[A]', None, None]
181	self.details['thick_flat6'] = ['[A]', None, None]
182	self.details['thick_flat7'] = ['[A]', None, None]
183	self.details['thick_flat8'] = ['[A]', None, None]
184	self.details['thick_flat9'] = ['[A]', None, None]
185	self.details['thick_flat10'] = ['[A]', None, None]
186	self.details['func_inter1'] = ['', None, None]
187	self.details['func_inter2'] = ['', None, None]
188	self.details['func_inter3'] = ['', None, None]
189	self.details['func_inter4'] = ['', None, None]
190	self.details['func_inter5'] = ['', None, None]
191	self.details['func_inter6'] = ['', None, None]
192	self.details['func_inter7'] = ['', None, None]
193	self.details['func_inter8'] = ['', None, None]
194	self.details['func_inter9'] = ['', None, None]
195	self.details['func_inter10'] = ['', None, None]
196	self.details['sldIM_flat1'] = ['[1/A^(2)]', None, None]
197	self.details['sldIM_flat2'] = ['[1/A^(2)]', None, None]
198	self.details['sldIM_flat3'] = ['[1/A^(2)]', None, None]
199	self.details['sldIM_flat4'] = ['[1/A^(2)]', None, None]
200	self.details['sldIM_flat5'] = ['[1/A^(2)]', None, None]
201	self.details['sldIM_flat6'] = ['[1/A^(2)]', None, None]
202	self.details['sldIM_flat7'] = ['[1/A^(2)]', None, None]
203	self.details['sldIM_flat8'] = ['[1/A^(2)]', None, None]
204	self.details['sldIM_flat9'] = ['[1/A^(2)]', None, None]
205	self.details['sldIM_flat10'] = ['[1/A^(2)]', None, None]
206	self.details['nu_inter1'] = ['', None, None]
207	self.details['nu_inter2'] = ['', None, None]
208	self.details['nu_inter3'] = ['', None, None]
209	self.details['nu_inter4'] = ['', None, None]
210	self.details['nu_inter5'] = ['', None, None]
211	self.details['nu_inter6'] = ['', None, None]
212	self.details['nu_inter7'] = ['', None, None]
213	self.details['nu_inter8'] = ['', None, None]
214	self.details['nu_inter9'] = ['', None, None]
215	self.details['nu_inter10'] = ['', None, None]
216	self.details['sldIM_sub0'] = ['', None, None]
217	self.details['sldIM_medium'] = ['', None, None]
218	self.details['npts_inter'] = ['', None, None]
219	self.details['nu_inter0'] = ['', None, None]
220
221	## fittable parameters
222	self.fixed=[]
223
224	## non-fittable parameters
225	self.non_fittable = ['n_layers', 'func_inter0', 'func_inter1', 'func_inter2', 'func_inter3', 'func_inter4', 'func_inter5', 'func_inter5', 'func_inter7', 'func_inter8', 'func_inter9', 'func_inter10']
226
227	## parameters with orientation
228	self.orientation_params = []
229
230	def __setstate__(self, state):
231	"""
232	restore the state of a model from pickle
233	"""
234	self.__dict__, self.params, self.dispersion = state
235
236	def __reduce_ex__(self, proto):
237	"""
238	Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
239	c model.
240	"""
241	state = (self.__dict__, self.params, self.dispersion)
242	return (create_ReflAdvModel,tuple(), state, None, None)
243
244	def clone(self):
245	""" Return a identical copy of self """
246	return self._clone(ReflAdvModel())
247
248
249	def run(self, x=0.0):
250	"""
251	Evaluate the model
252
253	:param x: input q, or [q,phi]
254
255	:return: scattering function P(q)
256
257	"""
258
259	return CReflAdvModel.run(self, x)
260
261	def runXY(self, x=0.0):
262	"""
263	Evaluate the model in cartesian coordinates
264
265	:param x: input q, or [qx, qy]
266
267	:return: scattering function P(q)
268
269	"""
270
271	return CReflAdvModel.runXY(self, x)
272
273	def evalDistribution(self, x=[]):
274	"""
275	Evaluate the model in cartesian coordinates
276
277	:param x: input q[], or [qx[], qy[]]
278
279	:return: scattering function P(q[])
280
281	"""
282	return CReflAdvModel.evalDistribution(self, x)
283
284	def calculate_ER(self):
285	"""
286	Calculate the effective radius for P(q)*S(q)
287
288	:return: the value of the effective radius
289
290	"""
291	return CReflAdvModel.calculate_ER(self)
292
293	def set_dispersion(self, parameter, dispersion):
294	"""
295	Set the dispersion object for a model parameter
296
297	:param parameter: name of the parameter [string]
298	:param dispersion: dispersion object of type DispersionModel
299
300	"""
301	return CReflAdvModel.set_dispersion(self, parameter, dispersion.cdisp)
302
303
304	# End of file

Note: See TracBrowser for help on using the repository browser.

SasView

source: sasview/sansmodels/src/sans/models/ReflAdvModel.py @ bdc25e2

Download in other formats: