source: sasview/sansmodels/src/sans/models/LamellarFFHGModel.py @ 8622241

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 8622241 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.3 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\lamellarFF_HG.h
23         AND RE-RUN THE GENERATOR SCRIPT
24
25"""
26
27from sans.models.BaseComponent import BaseComponent
28from sans_extension.c_models import CLamellarFFHGModel
29import copy   
30   
31class LamellarFFHGModel(CLamellarFFHGModel, BaseComponent):
32    """
33    Class that evaluates a LamellarFFHGModel model.
34    This file was auto-generated from ..\c_extensions\lamellarFF_HG.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         t_length        = 15.0 [A]
40         h_thickness     = 10.0 [A]
41         sld_tail        = 4e-007 [1/A^(2)]
42         sld_head        = 3e-006 [1/A^(2)]
43         sld_solvent     = 6e-006 [1/A^(2)]
44         background      = 0.0 [1/cm]
45
46    """
47       
48    def __init__(self):
49        """ Initialization """
50       
51        # Initialize BaseComponent first, then sphere
52        BaseComponent.__init__(self)
53        CLamellarFFHGModel.__init__(self)
54       
55        ## Name of the model
56        self.name = "LamellarFFHGModel"
57        ## Model description
58        self.description =""" Parameters: t_length = tail length, h_thickness = head thickness,
59                scale = Scale factor,
60                background = incoherent Background
61                sld_tail = tail scattering length density ,
62                sld_solvent = solvent scattering length density.
63                NOTE: The total bilayer thickness
64                = 2(h_thickness+ t_length).
65                """
66       
67        ## Parameter details [units, min, max]
68        self.details = {}
69        self.details['scale'] = ['', None, None]
70        self.details['t_length'] = ['[A]', None, None]
71        self.details['h_thickness'] = ['[A]', None, None]
72        self.details['sld_tail'] = ['[1/A^(2)]', None, None]
73        self.details['sld_head'] = ['[1/A^(2)]', None, None]
74        self.details['sld_solvent'] = ['[1/A^(2)]', None, None]
75        self.details['background'] = ['[1/cm]', None, None]
76
77        ## fittable parameters
78        self.fixed=['t_length.width', 'h_thickness.width']
79       
80        ## non-fittable parameters
81        self.non_fittable=[]
82       
83        ## parameters with orientation
84        self.orientation_params =[]
85   
86    def clone(self):
87        """ Return a identical copy of self """
88        return self._clone(LamellarFFHGModel())   
89       
90    def __getstate__(self):
91        """
92        return object state for pickling and copying
93        """
94        model_state = {'params': self.params, 'dispersion': self.dispersion, 'log': self.log}
95       
96        return self.__dict__, model_state
97       
98    def __setstate__(self, state):
99        """
100        create object from pickled state
101       
102        :param state: the state of the current model
103       
104        """
105       
106        self.__dict__, model_state = state
107        self.params = model_state['params']
108        self.dispersion = model_state['dispersion']
109        self.log = model_state['log']
110       
111   
112    def run(self, x=0.0):
113        """
114        Evaluate the model
115       
116        :param x: input q, or [q,phi]
117       
118        :return: scattering function P(q)
119       
120        """
121       
122        return CLamellarFFHGModel.run(self, x)
123   
124    def runXY(self, x=0.0):
125        """
126        Evaluate the model in cartesian coordinates
127       
128        :param x: input q, or [qx, qy]
129       
130        :return: scattering function P(q)
131       
132        """
133       
134        return CLamellarFFHGModel.runXY(self, x)
135       
136    def evalDistribution(self, x=[]):
137        """
138        Evaluate the model in cartesian coordinates
139       
140        :param x: input q[], or [qx[], qy[]]
141       
142        :return: scattering function P(q[])
143       
144        """
145        return CLamellarFFHGModel.evalDistribution(self, x)
146       
147    def calculate_ER(self):
148        """
149        Calculate the effective radius for P(q)*S(q)
150       
151        :return: the value of the effective radius
152       
153        """       
154        return CLamellarFFHGModel.calculate_ER(self)
155       
156    def set_dispersion(self, parameter, dispersion):
157        """
158        Set the dispersion object for a model parameter
159       
160        :param parameter: name of the parameter [string]
161        :param dispersion: dispersion object of type DispersionModel
162       
163        """
164        return CLamellarFFHGModel.set_dispersion(self, parameter, dispersion.cdisp)
165       
166   
167# End of file
Note: See TracBrowser for help on using the repository browser.