source: sasview/sansmodels/src/sans/models/LamellarModel.py @ d7b7156

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 d7b7156 was 35aface, checked in by Jae Cho <jhjcho@…>, 14 years ago

addede new models and attr. non_fittable

  • Property mode set to 100644
File size: 5.0 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   
31class LamellarModel(CLamellarModel, BaseComponent):
32    """
33    Class that evaluates a LamellarModel model.
34    This file was auto-generated from ..\c_extensions\lamellar.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         bi_thick        = 50.0 [A]
40         sld_bi          = 1e-006 [1/A^(2)]
41         sld_sol         = 6.3e-006 [1/A^(2)]
42         background      = 0.0 [1/cm]
43
44    """
45       
46    def __init__(self):
47        """ Initialization """
48       
49        # Initialize BaseComponent first, then sphere
50        BaseComponent.__init__(self)
51        CLamellarModel.__init__(self)
52       
53        ## Name of the model
54        self.name = "LamellarModel"
55        ## Model description
56        self.description ="""[Dilute Lamellar Form Factor](from a lyotropic lamellar phase)
57                I(q)= 2*pi*P(q)/(delta *q^(2)), where
58                P(q)=2*(contrast/q)^(2)*(1-cos(q*delta))^(2))
59                bi_thick = bilayer thickness
60                sld_bi = SLD of bilayer
61                sld_sol = SLD of solvent
62                background = Incoherent background
63                scale = scale factor
64                """
65       
66        ## Parameter details [units, min, max]
67        self.details = {}
68        self.details['scale'] = ['', None, None]
69        self.details['bi_thick'] = ['[A]', None, None]
70        self.details['sld_bi'] = ['[1/A^(2)]', None, None]
71        self.details['sld_sol'] = ['[1/A^(2)]', None, None]
72        self.details['background'] = ['[1/cm]', None, None]
73
74        ## fittable parameters
75        self.fixed=[]
76       
77        ## non-fittable parameters
78        self.non_fittable=[]
79       
80        ## parameters with orientation
81        self.orientation_params =[]
82   
83    def clone(self):
84        """ Return a identical copy of self """
85        return self._clone(LamellarModel())   
86       
87    def __getstate__(self):
88        """
89        return object state for pickling and copying
90        """
91        model_state = {'params': self.params, 'dispersion': self.dispersion, 'log': self.log}
92       
93        return self.__dict__, model_state
94       
95    def __setstate__(self, state):
96        """
97        create object from pickled state
98       
99        :param state: the state of the current model
100       
101        """
102       
103        self.__dict__, model_state = state
104        self.params = model_state['params']
105        self.dispersion = model_state['dispersion']
106        self.log = model_state['log']
107       
108   
109    def run(self, x=0.0):
110        """
111        Evaluate the model
112       
113        :param x: input q, or [q,phi]
114       
115        :return: scattering function P(q)
116       
117        """
118       
119        return CLamellarModel.run(self, x)
120   
121    def runXY(self, x=0.0):
122        """
123        Evaluate the model in cartesian coordinates
124       
125        :param x: input q, or [qx, qy]
126       
127        :return: scattering function P(q)
128       
129        """
130       
131        return CLamellarModel.runXY(self, x)
132       
133    def evalDistribution(self, x=[]):
134        """
135        Evaluate the model in cartesian coordinates
136       
137        :param x: input q[], or [qx[], qy[]]
138       
139        :return: scattering function P(q[])
140       
141        """
142        return CLamellarModel.evalDistribution(self, x)
143       
144    def calculate_ER(self):
145        """
146        Calculate the effective radius for P(q)*S(q)
147       
148        :return: the value of the effective radius
149       
150        """       
151        return CLamellarModel.calculate_ER(self)
152       
153    def set_dispersion(self, parameter, dispersion):
154        """
155        Set the dispersion object for a model parameter
156       
157        :param parameter: name of the parameter [string]
158        :param dispersion: dispersion object of type DispersionModel
159       
160        """
161        return CLamellarModel.set_dispersion(self, parameter, dispersion.cdisp)
162       
163   
164# End of file
Note: See TracBrowser for help on using the repository browser.