1 | #!/usr/bin/env python |
---|
2 | """ |
---|
3 | This software was developed by the University of Tennessee as part of the |
---|
4 | Distributed Data Analysis of Neutron Scattering Experiments (DANSE) |
---|
5 | project funded by the US National Science Foundation. |
---|
6 | |
---|
7 | If you use DANSE applications to do scientific research that leads to |
---|
8 | publication, we ask that you acknowledge the use of the software with the |
---|
9 | following sentence: |
---|
10 | |
---|
11 | "This work benefited from DANSE software developed under NSF award DMR-0520547." |
---|
12 | |
---|
13 | copyright 2008, University of Tennessee |
---|
14 | """ |
---|
15 | |
---|
16 | """ Provide functionality for a C extension model |
---|
17 | |
---|
18 | WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY |
---|
19 | DO NOT MODIFY THIS FILE, MODIFY ..\c_extensions\DiamCyl.h |
---|
20 | AND RE-RUN THE GENERATOR SCRIPT |
---|
21 | |
---|
22 | """ |
---|
23 | |
---|
24 | from sans.models.BaseComponent import BaseComponent |
---|
25 | from sans_extension.c_models import CDiamCylFunc |
---|
26 | import copy |
---|
27 | |
---|
28 | class DiamCylFunc(CDiamCylFunc, BaseComponent): |
---|
29 | """ Class that evaluates a DiamCylFunc model. |
---|
30 | This file was auto-generated from ..\c_extensions\DiamCyl.h. |
---|
31 | Refer to that file and the structure it contains |
---|
32 | for details of the model. |
---|
33 | List of default parameters: |
---|
34 | radius = 20.0 A |
---|
35 | length = 400.0 A |
---|
36 | |
---|
37 | """ |
---|
38 | |
---|
39 | def __init__(self): |
---|
40 | """ Initialization """ |
---|
41 | |
---|
42 | # Initialize BaseComponent first, then sphere |
---|
43 | BaseComponent.__init__(self) |
---|
44 | CDiamCylFunc.__init__(self) |
---|
45 | |
---|
46 | ## Name of the model |
---|
47 | self.name = "DiamCylFunc" |
---|
48 | ## Model description |
---|
49 | self.description ="""To calculate the 2nd virial coefficient for |
---|
50 | the non-spherical object, then find the |
---|
51 | radius of sphere that has this value of |
---|
52 | virial coefficient.""" |
---|
53 | |
---|
54 | ## Parameter details [units, min, max] |
---|
55 | self.details = {} |
---|
56 | self.details['radius'] = ['A', None, None] |
---|
57 | self.details['length'] = ['A', None, None] |
---|
58 | |
---|
59 | ## fittable parameters |
---|
60 | self.fixed=['radius.width', 'length.width'] |
---|
61 | |
---|
62 | ## parameters with orientation |
---|
63 | self.orientation_params =[] |
---|
64 | |
---|
65 | def clone(self): |
---|
66 | """ Return a identical copy of self """ |
---|
67 | return self._clone(DiamCylFunc()) |
---|
68 | |
---|
69 | def __getstate__(self): |
---|
70 | """ return object state for pickling and copying """ |
---|
71 | model_state = {'params': self.params, 'dispersion': self.dispersion, 'log': self.log} |
---|
72 | |
---|
73 | return self.__dict__, model_state |
---|
74 | |
---|
75 | def __setstate__(self, state): |
---|
76 | """ create object from pickled state """ |
---|
77 | |
---|
78 | self.__dict__, model_state = state |
---|
79 | self.params = model_state['params'] |
---|
80 | self.dispersion = model_state['dispersion'] |
---|
81 | self.log = model_state['log'] |
---|
82 | |
---|
83 | |
---|
84 | def run(self, x = 0.0): |
---|
85 | """ Evaluate the model |
---|
86 | @param x: input q, or [q,phi] |
---|
87 | @return: scattering function P(q) |
---|
88 | """ |
---|
89 | |
---|
90 | return CDiamCylFunc.run(self, x) |
---|
91 | |
---|
92 | def runXY(self, x = 0.0): |
---|
93 | """ Evaluate the model in cartesian coordinates |
---|
94 | @param x: input q, or [qx, qy] |
---|
95 | @return: scattering function P(q) |
---|
96 | """ |
---|
97 | |
---|
98 | return CDiamCylFunc.runXY(self, x) |
---|
99 | |
---|
100 | def evalDistribition(self, x = []): |
---|
101 | """ Evaluate the model in cartesian coordinates |
---|
102 | @param x: input q[], or [qx[], qy[]] |
---|
103 | @return: scattering function P(q[]) |
---|
104 | """ |
---|
105 | return CDiamCylFunc.evalDistribition(self, x) |
---|
106 | |
---|
107 | def calculate_ER(self): |
---|
108 | """ Calculate the effective radius for P(q)*S(q) |
---|
109 | @return: the value of the effective radius |
---|
110 | """ |
---|
111 | return CDiamCylFunc.calculate_ER(self) |
---|
112 | |
---|
113 | def set_dispersion(self, parameter, dispersion): |
---|
114 | """ |
---|
115 | Set the dispersion object for a model parameter |
---|
116 | @param parameter: name of the parameter [string] |
---|
117 | @dispersion: dispersion object of type DispersionModel |
---|
118 | """ |
---|
119 | return CDiamCylFunc.set_dispersion(self, parameter, dispersion.cdisp) |
---|
120 | |
---|
121 | |
---|
122 | # End of file |
---|