source: sasview/sansmodels/src/sans/models/BarBellModel.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.6 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\barbell.h
23         AND RE-RUN THE GENERATOR SCRIPT
24
25"""
26
27from sans.models.BaseComponent import BaseComponent
28from sans_extension.c_models import CBarBellModel
29import copy   
30
31def create_BarBellModel():
32    obj = BarBellModel()
33    #CBarBellModel.__init__(obj) is called by BarBellModel constructor
34    return obj
35
36class BarBellModel(CBarBellModel, BaseComponent):
37    """
38    Class that evaluates a BarBellModel model.
39    This file was auto-generated from ..\c_extensions\barbell.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         rad_bar         = 20.0 [A]
45         len_bar         = 400.0 [A]
46         rad_bell        = 40.0 [A]
47         sld_barbell     = 1e-006 [1/A^(2)]
48         sld_solv        = 6.3e-006 [1/A^(2)]
49         background      = 0.0 [1/cm]
50         theta           = 0.0 [deg]
51         phi             = 0.0 [deg]
52
53    """
54       
55    def __init__(self):
56        """ Initialization """
57       
58        # Initialize BaseComponent first, then sphere
59        BaseComponent.__init__(self)
60        #apply(CBarBellModel.__init__, (self,))
61        CBarBellModel.__init__(self)
62       
63        ## Name of the model
64        self.name = "BarBellModel"
65        ## Model description
66        self.description ="""Calculates the scattering from a barbell-shaped cylinder. That is
67                a sphereocylinder with spherical end caps
68                that have a radius larger than that of
69                the cylinder and the center of the end cap
70                radius lies outside of the cylinder.
71                Note: As the length of cylinder(bar) -->0,
72                it becomes a dumbbell.
73                And when rad_bar = rad_bell,
74                it is a spherocylinder.
75                It must be that rad_bar <(=) rad_bell.
76                [Parameters];
77                scale: volume fraction of spheres,
78                background:incoherent background,
79                rad_bar: radius of the cylindrical bar,
80                len_bar: length of the cylindrical bar,
81                rad_bell: radius of the spherical bell,
82                sld_barbell: SLD of the barbell,
83                sld_solv: SLD of the solvent."""
84       
85        ## Parameter details [units, min, max]
86        self.details = {}
87        self.details['scale'] = ['', None, None]
88        self.details['rad_bar'] = ['[A]', None, None]
89        self.details['len_bar'] = ['[A]', None, None]
90        self.details['rad_bell'] = ['[A]', None, None]
91        self.details['sld_barbell'] = ['[1/A^(2)]', None, None]
92        self.details['sld_solv'] = ['[1/A^(2)]', None, None]
93        self.details['background'] = ['[1/cm]', None, None]
94        self.details['theta'] = ['[deg]', None, None]
95        self.details['phi'] = ['[deg]', None, None]
96
97        ## fittable parameters
98        self.fixed=['rad_bar.width', 'len_bar', 'rad_bell', 'phi.width', 'theta.width']
99       
100        ## non-fittable parameters
101        self.non_fittable = []
102       
103        ## parameters with orientation
104        self.orientation_params = ['phi', 'theta', 'phi.width', 'theta.width']
105   
106    def __reduce_ex__(self, proto):
107        """
108        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
109        c model.
110        """
111        return (create_BarBellModel,tuple())
112       
113    def clone(self):
114        """ Return a identical copy of self """
115        return self._clone(BarBellModel())   
116       
117   
118    def run(self, x=0.0):
119        """
120        Evaluate the model
121       
122        :param x: input q, or [q,phi]
123       
124        :return: scattering function P(q)
125       
126        """
127       
128        return CBarBellModel.run(self, x)
129   
130    def runXY(self, x=0.0):
131        """
132        Evaluate the model in cartesian coordinates
133       
134        :param x: input q, or [qx, qy]
135       
136        :return: scattering function P(q)
137       
138        """
139       
140        return CBarBellModel.runXY(self, x)
141       
142    def evalDistribution(self, x=[]):
143        """
144        Evaluate the model in cartesian coordinates
145       
146        :param x: input q[], or [qx[], qy[]]
147       
148        :return: scattering function P(q[])
149       
150        """
151        return CBarBellModel.evalDistribution(self, x)
152       
153    def calculate_ER(self):
154        """
155        Calculate the effective radius for P(q)*S(q)
156       
157        :return: the value of the effective radius
158       
159        """       
160        return CBarBellModel.calculate_ER(self)
161       
162    def set_dispersion(self, parameter, dispersion):
163        """
164        Set the dispersion object for a model parameter
165       
166        :param parameter: name of the parameter [string]
167        :param dispersion: dispersion object of type DispersionModel
168       
169        """
170        return CBarBellModel.set_dispersion(self, parameter, dispersion.cdisp)
171       
172   
173# End of file
Note: See TracBrowser for help on using the repository browser.