source: sasview/sansmodels/src/sans/models/StackedDisksModel.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.9 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\stacked_disks.h
23         AND RE-RUN THE GENERATOR SCRIPT
24
25"""
26
27from sans.models.BaseComponent import BaseComponent
28from sans_extension.c_models import CStackedDisksModel
29import copy   
30   
31class StackedDisksModel(CStackedDisksModel, BaseComponent):
32    """
33    Class that evaluates a StackedDisksModel model.
34    This file was auto-generated from ..\c_extensions\stacked_disks.h.
35    Refer to that file and the structure it contains
36    for details of the model.
37    List of default parameters:
38         scale           = 0.01
39         radius          = 3000.0 [A]
40         core_thick      = 10.0 [A]
41         layer_thick     = 15.0 [A]
42         core_sld        = 4e-006 [1/A^(2)]
43         layer_sld       = -4e-007 [1/A^(2)]
44         solvent_sld     = 5e-006 [1/A^(2)]
45         n_stacking      = 1.0
46         sigma_d         = 0.0
47         background      = 0.001 [1/cm]
48         axis_theta      = 0.0 [rad]
49         axis_phi        = 0.0 [rad]
50
51    """
52       
53    def __init__(self):
54        """ Initialization """
55       
56        # Initialize BaseComponent first, then sphere
57        BaseComponent.__init__(self)
58        CStackedDisksModel.__init__(self)
59       
60        ## Name of the model
61        self.name = "StackedDisksModel"
62        ## Model description
63        self.description =""" One layer of disk consists of a core, a top layer, and a bottom layer.
64                radius =  the radius of the disk
65                core_thick = thickness of the core
66                layer_thick = thickness of a layer
67                core_sld = the SLD of the core
68                layer_sld = the SLD of the layers
69                n_stacking = the number of the disks
70                sigma_d =  Gaussian STD of d-spacing
71                solvent_sld = the SLD of the solvent"""
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['core_thick'] = ['[A]', None, None]
78        self.details['layer_thick'] = ['[A]', None, None]
79        self.details['core_sld'] = ['[1/A^(2)]', None, None]
80        self.details['layer_sld'] = ['[1/A^(2)]', None, None]
81        self.details['solvent_sld'] = ['[1/A^(2)]', None, None]
82        self.details['n_stacking'] = ['', None, None]
83        self.details['sigma_d'] = ['', None, None]
84        self.details['background'] = ['[1/cm]', None, None]
85        self.details['axis_theta'] = ['[rad]', None, None]
86        self.details['axis_phi'] = ['[rad]', None, None]
87
88        ## fittable parameters
89        self.fixed=['core_thick.width', 'layer_thick.width', 'radius.width', 'axis_theta.width', 'axis_phi.width']
90       
91        ## non-fittable parameters
92        self.non_fittable=[]
93       
94        ## parameters with orientation
95        self.orientation_params =['axis_phi', 'axis_theta', 'axis_phi.width', 'axis_theta.width']
96   
97    def clone(self):
98        """ Return a identical copy of self """
99        return self._clone(StackedDisksModel())   
100       
101    def __getstate__(self):
102        """
103        return object state for pickling and copying
104        """
105        model_state = {'params': self.params, 'dispersion': self.dispersion, 'log': self.log}
106       
107        return self.__dict__, model_state
108       
109    def __setstate__(self, state):
110        """
111        create object from pickled state
112       
113        :param state: the state of the current model
114       
115        """
116       
117        self.__dict__, model_state = state
118        self.params = model_state['params']
119        self.dispersion = model_state['dispersion']
120        self.log = model_state['log']
121       
122   
123    def run(self, x=0.0):
124        """
125        Evaluate the model
126       
127        :param x: input q, or [q,phi]
128       
129        :return: scattering function P(q)
130       
131        """
132       
133        return CStackedDisksModel.run(self, x)
134   
135    def runXY(self, x=0.0):
136        """
137        Evaluate the model in cartesian coordinates
138       
139        :param x: input q, or [qx, qy]
140       
141        :return: scattering function P(q)
142       
143        """
144       
145        return CStackedDisksModel.runXY(self, x)
146       
147    def evalDistribution(self, x=[]):
148        """
149        Evaluate the model in cartesian coordinates
150       
151        :param x: input q[], or [qx[], qy[]]
152       
153        :return: scattering function P(q[])
154       
155        """
156        return CStackedDisksModel.evalDistribution(self, x)
157       
158    def calculate_ER(self):
159        """
160        Calculate the effective radius for P(q)*S(q)
161       
162        :return: the value of the effective radius
163       
164        """       
165        return CStackedDisksModel.calculate_ER(self)
166       
167    def set_dispersion(self, parameter, dispersion):
168        """
169        Set the dispersion object for a model parameter
170       
171        :param parameter: name of the parameter [string]
172        :param dispersion: dispersion object of type DispersionModel
173       
174        """
175        return CStackedDisksModel.set_dispersion(self, parameter, dispersion.cdisp)
176       
177   
178# End of file
Note: See TracBrowser for help on using the repository browser.