source: sasview/sansmodels/src/sans/models/CylinderModel.py @ 6d48919

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 6d48919 was 79ac6f8, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on documentation

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