source: sasview/sansmodels/src/sans/models/FuzzySphereModel.py @ d6da3b1

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 d6da3b1 was 96656e3, checked in by Jae Cho <jhjcho@…>, 14 years ago

update models due to changes of template

  • Property mode set to 100644
File size: 5.1 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\fuzzysphere.h
23         AND RE-RUN THE GENERATOR SCRIPT
24
25"""
26
27from sans.models.BaseComponent import BaseComponent
28from sans_extension.c_models import CFuzzySphereModel
29import copy   
30
31def create_FuzzySphereModel():
32    obj = FuzzySphereModel()
33    #CFuzzySphereModel.__init__(obj) is called by FuzzySphereModel constructor
34    return obj
35
36class FuzzySphereModel(CFuzzySphereModel, BaseComponent):
37    """
38    Class that evaluates a FuzzySphereModel model.
39    This file was auto-generated from ..\c_extensions\fuzzysphere.h.
40    Refer to that file and the structure it contains
41    for details of the model.
42    List of default parameters:
43         scale           = 0.01
44         radius          = 60.0 [A]
45         fuzziness       = 10.0 [A]
46         sldSph          = 1e-006 [1/A^(2)]
47         sldSolv         = 3e-006 [1/A^(2)]
48         background      = 0.001 [1/cm]
49
50    """
51       
52    def __init__(self):
53        """ Initialization """
54       
55        # Initialize BaseComponent first, then sphere
56        BaseComponent.__init__(self)
57        #apply(CFuzzySphereModel.__init__, (self,))
58        CFuzzySphereModel.__init__(self)
59       
60        ## Name of the model
61        self.name = "FuzzySphereModel"
62        ## Model description
63        self.description ="""
64                scale: scale factor times volume fraction,
65                or just volume fraction for absolute scale data
66                radius: radius of the solid sphere
67                fuzziness = the STD of the height of fuzzy interfacial
68                thickness (ie., so-called interfacial roughness)
69                sldSph: the SLD of the sphere
70                sldSolv: the SLD of the solvent
71                background: incoherent background
72                Note: By definition, this function works only when fuzziness << radius."""
73       
74        ## Parameter details [units, min, max]
75        self.details = {}
76        self.details['scale'] = ['', None, None]
77        self.details['radius'] = ['[A]', None, None]
78        self.details['fuzziness'] = ['[A]', None, None]
79        self.details['sldSph'] = ['[1/A^(2)]', None, None]
80        self.details['sldSolv'] = ['[1/A^(2)]', None, None]
81        self.details['background'] = ['[1/cm]', None, None]
82
83        ## fittable parameters
84        self.fixed=['radius.width', 'fuzziness.width']
85       
86        ## non-fittable parameters
87        self.non_fittable = []
88       
89        ## parameters with orientation
90        self.orientation_params = []
91   
92    def __reduce_ex__(self, proto):
93        """
94        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
95        c model.
96        """
97        return (create_FuzzySphereModel,tuple())
98       
99    def clone(self):
100        """ Return a identical copy of self """
101        return self._clone(FuzzySphereModel())   
102       
103   
104    def run(self, x=0.0):
105        """
106        Evaluate the model
107       
108        :param x: input q, or [q,phi]
109       
110        :return: scattering function P(q)
111       
112        """
113       
114        return CFuzzySphereModel.run(self, x)
115   
116    def runXY(self, x=0.0):
117        """
118        Evaluate the model in cartesian coordinates
119       
120        :param x: input q, or [qx, qy]
121       
122        :return: scattering function P(q)
123       
124        """
125       
126        return CFuzzySphereModel.runXY(self, x)
127       
128    def evalDistribution(self, x=[]):
129        """
130        Evaluate the model in cartesian coordinates
131       
132        :param x: input q[], or [qx[], qy[]]
133       
134        :return: scattering function P(q[])
135       
136        """
137        return CFuzzySphereModel.evalDistribution(self, x)
138       
139    def calculate_ER(self):
140        """
141        Calculate the effective radius for P(q)*S(q)
142       
143        :return: the value of the effective radius
144       
145        """       
146        return CFuzzySphereModel.calculate_ER(self)
147       
148    def set_dispersion(self, parameter, dispersion):
149        """
150        Set the dispersion object for a model parameter
151       
152        :param parameter: name of the parameter [string]
153        :param dispersion: dispersion object of type DispersionModel
154       
155        """
156        return CFuzzySphereModel.set_dispersion(self, parameter, dispersion.cdisp)
157       
158   
159# End of file
Note: See TracBrowser for help on using the repository browser.