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