source: sasview/sansmodels/src/sans/models/CoreShellEllipsoidModel.py @ 20905a0

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 20905a0 was 79ac6f8, checked in by Gervaise Alina <gervyh@…>, 15 years ago

working on documentation
  • Property mode set to 100644
File size: 6.3 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"""
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\spheroid.h
23         AND RE-RUN THE GENERATOR SCRIPT
24
25"""
26
27from sans.models.BaseComponent import BaseComponent
28from sans_extension.c_models import CCoreShellEllipsoidModel
29import copy   
30   
31class CoreShellEllipsoidModel(CCoreShellEllipsoidModel, BaseComponent):
32    """
33    Class that evaluates a CoreShellEllipsoidModel model.
34    This file was auto-generated from ..\c_extensions\spheroid.h.
35    Refer to that file and the structure it contains
36    for details of the model.
37    List of default parameters:
38         scale           = 1.0
39         equat_core      = 200.0 [A]
40         polar_core      = 20.0 [A]
41         equat_shell     = 250.0 [A]
42         polar_shell     = 30.0 [A]
43         sld_core        = 2e-006 [1/A^(2)]
44         sld_shell       = 1e-006 [1/A^(2)]
45         sld_solvent     = 6.3e-006 [1/A^(2)]
46         background      = 0.001 [1/cm]
47         axis_theta      = 0.0 [rad]
48         axis_phi        = 0.0 [rad]
49
50    """
51       
52    def __init__(self):
53        """ Initialization """
54       
55        # Initialize BaseComponent first, then sphere
56        BaseComponent.__init__(self)
57        CCoreShellEllipsoidModel.__init__(self)
58       
59        ## Name of the model
60        self.name = "CoreShellEllipsoidModel"
61        ## Model description
62        self.description ="""[SpheroidCoreShellModel] Calculates the form factor for an spheroid
63                ellipsoid particle with a core_shell structure.
64                The form factor is averaged over all possible
65                orientations of the ellipsoid such that P(q)
66                = scale*<f^2>/Vol + bkg, where f is the
67                single particle scattering amplitude.
68                [Parameters]:
69                equat_core = equatorial radius of core,
70                polar_core = polar radius of core,
71                equat_shell = equatorial radius of shell,
72                polar_shell = polar radius (revolution axis) of shell,
73                sld_core = SLD_core
74                sld_shell = SLD_shell
75                sld_solvent = SLD_solvent
76                background = Incoherent bkg
77                scale =scale
78                Note:It is the users' responsibility to ensure
79                that shell radii are larger than core radii.
80                oblate: polar radius < equatorial radius
81                prolate :  polar radius > equatorial radius"""
82       
83        ## Parameter details [units, min, max]
84        self.details = {}
85        self.details['scale'] = ['', None, None]
86        self.details['equat_core'] = ['[A]', None, None]
87        self.details['polar_core'] = ['[A]', None, None]
88        self.details['equat_shell'] = ['[A]', None, None]
89        self.details['polar_shell'] = ['[A]', None, None]
90        self.details['sld_core'] = ['[1/A^(2)]', None, None]
91        self.details['sld_shell'] = ['[1/A^(2)]', None, None]
92        self.details['sld_solvent'] = ['[1/A^(2)]', None, None]
93        self.details['background'] = ['[1/cm]', None, None]
94        self.details['axis_theta'] = ['[rad]', None, None]
95        self.details['axis_phi'] = ['[rad]', None, None]
96
97        ## fittable parameters
98        self.fixed=['equat_core.width', 'polar_core.width', 'equat_shell.width', 'polar_shell.width', 'axis_phi.width', 'axis_theta.width']
99       
100        ## parameters with orientation
101        self.orientation_params =['axis_phi', 'axis_theta', 'axis_phi.width', 'axis_theta.width']
102   
103    def clone(self):
104        """ Return a identical copy of self """
105        return self._clone(CoreShellEllipsoidModel())   
106       
107    def __getstate__(self):
108        """
109        return object state for pickling and copying
110        """
111        model_state = {'params': self.params, 'dispersion': self.dispersion, 'log': self.log}
112       
113        return self.__dict__, model_state
114       
115    def __setstate__(self, state):
116        """
117        create object from pickled state
118       
119        :param state: the state of the current model
120       
121        """
122       
123        self.__dict__, model_state = state
124        self.params = model_state['params']
125        self.dispersion = model_state['dispersion']
126        self.log = model_state['log']
127       
128   
129    def run(self, x=0.0):
130        """
131        Evaluate the model
132       
133        :param x: input q, or [q,phi]
134       
135        :return: scattering function P(q)
136       
137        """
138       
139        return CCoreShellEllipsoidModel.run(self, x)
140   
141    def runXY(self, x=0.0):
142        """
143        Evaluate the model in cartesian coordinates
144       
145        :param x: input q, or [qx, qy]
146       
147        :return: scattering function P(q)
148       
149        """
150       
151        return CCoreShellEllipsoidModel.runXY(self, x)
152       
153    def evalDistribution(self, x=[]):
154        """
155        Evaluate the model in cartesian coordinates
156       
157        :param x: input q[], or [qx[], qy[]]
158       
159        :return: scattering function P(q[])
160       
161        """
162        return CCoreShellEllipsoidModel.evalDistribution(self, x)
163       
164    def calculate_ER(self):
165        """
166        Calculate the effective radius for P(q)*S(q)
167       
168        :return: the value of the effective radius
169       
170        """       
171        return CCoreShellEllipsoidModel.calculate_ER(self)
172       
173    def set_dispersion(self, parameter, dispersion):
174        """
175        Set the dispersion object for a model parameter
176       
177        :param parameter: name of the parameter [string]
178        :param dispersion: dispersion object of type DispersionModel
179       
180        """
181        return CCoreShellEllipsoidModel.set_dispersion(self, parameter, dispersion.cdisp)
182       
183   
184# End of file
Note: See TracBrowser for help on using the repository browser.