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