source: sasview/sansmodels/src/sans/models/SphereModel.py @ d7b7156

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 d7b7156 was 35aface, checked in by Jae Cho <jhjcho@…>, 14 years ago

addede new models and attr. non_fittable

  • Property mode set to 100644
File size: 4.9 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\sphere.h
23         AND RE-RUN THE GENERATOR SCRIPT
24
25"""
26
27from sans.models.BaseComponent import BaseComponent
28from sans_extension.c_models import CSphereModel
29import copy   
30   
31class SphereModel(CSphereModel, BaseComponent):
32    """
33    Class that evaluates a SphereModel model.
34    This file was auto-generated from ..\c_extensions\sphere.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         radius          = 60.0 [A]
40         sldSph          = 2e-006 [1/A^(2)]
41         sldSolv         = 1e-006 [1/A^(2)]
42         background      = 0.0 [1/cm]
43
44    """
45       
46    def __init__(self):
47        """ Initialization """
48       
49        # Initialize BaseComponent first, then sphere
50        BaseComponent.__init__(self)
51        CSphereModel.__init__(self)
52       
53        ## Name of the model
54        self.name = "SphereModel"
55        ## Model description
56        self.description ="""P(q)=(scale/V)*[3V(sldSph-sldSolv)*(sin(qR)-qRcos(qR))
57                /(qR)^3]^(2)+bkg
58               
59                bkg:background, R: radius of sphere
60                V:The volume of the scatter
61                sldSph: the SLD of the sphere
62                sldSolv: the SLD of the solvent
63                """
64       
65        ## Parameter details [units, min, max]
66        self.details = {}
67        self.details['scale'] = ['', None, None]
68        self.details['radius'] = ['[A]', None, None]
69        self.details['sldSph'] = ['[1/A^(2)]', None, None]
70        self.details['sldSolv'] = ['[1/A^(2)]', None, None]
71        self.details['background'] = ['[1/cm]', None, None]
72
73        ## fittable parameters
74        self.fixed=['radius.width']
75       
76        ## non-fittable parameters
77        self.non_fittable=[]
78       
79        ## parameters with orientation
80        self.orientation_params =[]
81   
82    def clone(self):
83        """ Return a identical copy of self """
84        return self._clone(SphereModel())   
85       
86    def __getstate__(self):
87        """
88        return object state for pickling and copying
89        """
90        model_state = {'params': self.params, 'dispersion': self.dispersion, 'log': self.log}
91       
92        return self.__dict__, model_state
93       
94    def __setstate__(self, state):
95        """
96        create object from pickled state
97       
98        :param state: the state of the current model
99       
100        """
101       
102        self.__dict__, model_state = state
103        self.params = model_state['params']
104        self.dispersion = model_state['dispersion']
105        self.log = model_state['log']
106       
107   
108    def run(self, x=0.0):
109        """
110        Evaluate the model
111       
112        :param x: input q, or [q,phi]
113       
114        :return: scattering function P(q)
115       
116        """
117       
118        return CSphereModel.run(self, x)
119   
120    def runXY(self, x=0.0):
121        """
122        Evaluate the model in cartesian coordinates
123       
124        :param x: input q, or [qx, qy]
125       
126        :return: scattering function P(q)
127       
128        """
129       
130        return CSphereModel.runXY(self, x)
131       
132    def evalDistribution(self, x=[]):
133        """
134        Evaluate the model in cartesian coordinates
135       
136        :param x: input q[], or [qx[], qy[]]
137       
138        :return: scattering function P(q[])
139       
140        """
141        return CSphereModel.evalDistribution(self, x)
142       
143    def calculate_ER(self):
144        """
145        Calculate the effective radius for P(q)*S(q)
146       
147        :return: the value of the effective radius
148       
149        """       
150        return CSphereModel.calculate_ER(self)
151       
152    def set_dispersion(self, parameter, dispersion):
153        """
154        Set the dispersion object for a model parameter
155       
156        :param parameter: name of the parameter [string]
157        :param dispersion: dispersion object of type DispersionModel
158       
159        """
160        return CSphereModel.set_dispersion(self, parameter, dispersion.cdisp)
161       
162   
163# End of file
Note: See TracBrowser for help on using the repository browser.