source: sasview/sansmodels/src/sans/models/EllipticalCylinderModel.py @ d85ee8c

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 d85ee8c 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.5 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\elliptical_cylinder.h
23         AND RE-RUN THE GENERATOR SCRIPT
24
25"""
26
27from sans.models.BaseComponent import BaseComponent
28from sans_extension.c_models import CEllipticalCylinderModel
29import copy   
30
31def create_EllipticalCylinderModel():
32    obj = EllipticalCylinderModel()
33    #CEllipticalCylinderModel.__init__(obj) is called by EllipticalCylinderModel constructor
34    return obj
35
36class EllipticalCylinderModel(CEllipticalCylinderModel, BaseComponent):
37    """
38    Class that evaluates a EllipticalCylinderModel model.
39    This file was auto-generated from ..\c_extensions\elliptical_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         r_minor         = 20.0 [A]
45         r_ratio         = 1.5
46         length          = 400.0 [A]
47         sldCyl          = 4e-006 [1/A^(2)]
48         sldSolv         = 1e-006 [1/A^(2)]
49         background      = 0.0 [1/cm]
50         cyl_theta       = 90.0 [deg]
51         cyl_phi         = 0.0 [deg]
52         cyl_psi         = 0.0 [deg]
53
54    """
55       
56    def __init__(self):
57        """ Initialization """
58       
59        # Initialize BaseComponent first, then sphere
60        BaseComponent.__init__(self)
61        #apply(CEllipticalCylinderModel.__init__, (self,))
62        CEllipticalCylinderModel.__init__(self)
63       
64        ## Name of the model
65        self.name = "EllipticalCylinderModel"
66        ## Model description
67        self.description =""" Model parameters: r_minor = the radius of minor axis of the cross section
68                r_ratio = the ratio of (r_major /r_minor >= 1)
69                length = the length of the cylinder
70                sldCyl = SLD of the cylinder
71                sldSolv = SLD of solvent -
72                background = incoherent background"""
73       
74        ## Parameter details [units, min, max]
75        self.details = {}
76        self.details['scale'] = ['', None, None]
77        self.details['r_minor'] = ['[A]', None, None]
78        self.details['r_ratio'] = ['', None, None]
79        self.details['length'] = ['[A]', None, None]
80        self.details['sldCyl'] = ['[1/A^(2)]', None, None]
81        self.details['sldSolv'] = ['[1/A^(2)]', None, None]
82        self.details['background'] = ['[1/cm]', None, None]
83        self.details['cyl_theta'] = ['[deg]', None, None]
84        self.details['cyl_phi'] = ['[deg]', None, None]
85        self.details['cyl_psi'] = ['[deg]', None, None]
86
87        ## fittable parameters
88        self.fixed=['cyl_phi.width', 'cyl_theta.width', 'cyl_psi.width', 'length.width', 'r_minor.width', 'r_ratio.width']
89       
90        ## non-fittable parameters
91        self.non_fittable = []
92       
93        ## parameters with orientation
94        self.orientation_params = ['cyl_phi', 'cyl_theta', 'cyl_psi', 'cyl_phi.width', 'cyl_theta.width', 'cyl_psi.width']
95   
96    def __reduce_ex__(self, proto):
97        """
98        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
99        c model.
100        """
101        return (create_EllipticalCylinderModel,tuple())
102       
103    def clone(self):
104        """ Return a identical copy of self """
105        return self._clone(EllipticalCylinderModel())   
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 CEllipticalCylinderModel.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 CEllipticalCylinderModel.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 CEllipticalCylinderModel.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 CEllipticalCylinderModel.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 CEllipticalCylinderModel.set_dispersion(self, parameter, dispersion.cdisp)
161       
162   
163# End of file
Note: See TracBrowser for help on using the repository browser.