source: sasview/sansmodels/src/sans/models/FlexibleCylinderModel.py @ 2ca00c4

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 2ca00c4 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.0 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\flexible_cylinder.h
23         AND RE-RUN THE GENERATOR SCRIPT
24
25"""
26
27from sans.models.BaseComponent import BaseComponent
28from sans_extension.c_models import CFlexibleCylinderModel
29import copy   
30
31def create_FlexibleCylinderModel():
32    obj = FlexibleCylinderModel()
33    #CFlexibleCylinderModel.__init__(obj) is called by FlexibleCylinderModel constructor
34    return obj
35
36class FlexibleCylinderModel(CFlexibleCylinderModel, BaseComponent):
37    """
38    Class that evaluates a FlexibleCylinderModel model.
39    This file was auto-generated from ..\c_extensions\flexible_cylinder.h.
40    Refer to that file and the structure it contains
41    for details of the model.
42    List of default parameters:
43         scale           = 1.0
44         length          = 1000.0 [A]
45         kuhn_length     = 100.0 [A]
46         radius          = 20.0 [A]
47         sldCyl          = 1e-006 [1/A^(2)]
48         sldSolv         = 6.3e-006 [1/A^(2)]
49         background      = 0.0001 [1/cm]
50
51    """
52       
53    def __init__(self):
54        """ Initialization """
55       
56        # Initialize BaseComponent first, then sphere
57        BaseComponent.__init__(self)
58        #apply(CFlexibleCylinderModel.__init__, (self,))
59        CFlexibleCylinderModel.__init__(self)
60       
61        ## Name of the model
62        self.name = "FlexibleCylinderModel"
63        ## Model description
64        self.description =""" Note : scale and contrast=sldCyl-sldSolv are both multiplicative factors in the
65                model and are perfectly correlated. One or
66                both of these parameters must be held fixed
67                during model fitting."""
68       
69        ## Parameter details [units, min, max]
70        self.details = {}
71        self.details['scale'] = ['', None, None]
72        self.details['length'] = ['[A]', None, None]
73        self.details['kuhn_length'] = ['[A]', None, None]
74        self.details['radius'] = ['[A]', None, None]
75        self.details['sldCyl'] = ['[1/A^(2)]', None, None]
76        self.details['sldSolv'] = ['[1/A^(2)]', None, None]
77        self.details['background'] = ['[1/cm]', None, None]
78
79        ## fittable parameters
80        self.fixed=['length.width', 'kuhn_length.width', 'radius.width']
81       
82        ## non-fittable parameters
83        self.non_fittable = []
84       
85        ## parameters with orientation
86        self.orientation_params = []
87   
88    def __reduce_ex__(self, proto):
89        """
90        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
91        c model.
92        """
93        return (create_FlexibleCylinderModel,tuple())
94       
95    def clone(self):
96        """ Return a identical copy of self """
97        return self._clone(FlexibleCylinderModel())   
98       
99   
100    def run(self, x=0.0):
101        """
102        Evaluate the model
103       
104        :param x: input q, or [q,phi]
105       
106        :return: scattering function P(q)
107       
108        """
109       
110        return CFlexibleCylinderModel.run(self, x)
111   
112    def runXY(self, x=0.0):
113        """
114        Evaluate the model in cartesian coordinates
115       
116        :param x: input q, or [qx, qy]
117       
118        :return: scattering function P(q)
119       
120        """
121       
122        return CFlexibleCylinderModel.runXY(self, x)
123       
124    def evalDistribution(self, x=[]):
125        """
126        Evaluate the model in cartesian coordinates
127       
128        :param x: input q[], or [qx[], qy[]]
129       
130        :return: scattering function P(q[])
131       
132        """
133        return CFlexibleCylinderModel.evalDistribution(self, x)
134       
135    def calculate_ER(self):
136        """
137        Calculate the effective radius for P(q)*S(q)
138       
139        :return: the value of the effective radius
140       
141        """       
142        return CFlexibleCylinderModel.calculate_ER(self)
143       
144    def set_dispersion(self, parameter, dispersion):
145        """
146        Set the dispersion object for a model parameter
147       
148        :param parameter: name of the parameter [string]
149        :param dispersion: dispersion object of type DispersionModel
150       
151        """
152        return CFlexibleCylinderModel.set_dispersion(self, parameter, dispersion.cdisp)
153       
154   
155# End of file
Note: See TracBrowser for help on using the repository browser.