source: sasview/sansmodels/src/sans/models/MultiShellModel.py @ c25f1fa

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 c25f1fa was 92df66f8, checked in by Gervaise Alina <gervyh@…>, 13 years ago

commit wrap model

  • Property mode set to 100644
File size: 5.5 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\multishell.h
23         AND RE-RUN THE GENERATOR SCRIPT
24
25"""
26
27from sans.models.BaseComponent import BaseComponent
28from sans.models.sans_extension.c_models import CMultiShellModel
29import copy   
30
31def create_MultiShellModel():
32    obj = MultiShellModel()
33    #CMultiShellModel.__init__(obj) is called by MultiShellModel constructor
34    return obj
35
36class MultiShellModel(CMultiShellModel, BaseComponent):
37    """
38    Class that evaluates a MultiShellModel model.
39    This file was auto-generated from ..\c_extensions\multishell.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         core_radius     = 60.0 [A]
45         s_thickness     = 10.0 [A]
46         w_thickness     = 10.0 [A]
47         core_sld        = 6.4e-06 [1/A^(2)]
48         shell_sld       = 4e-07 [1/A^(2)]
49         n_pairs         = 2.0
50         background      = 0.0 [1/cm]
51
52    """
53       
54    def __init__(self):
55        """ Initialization """
56       
57        # Initialize BaseComponent first, then sphere
58        BaseComponent.__init__(self)
59        #apply(CMultiShellModel.__init__, (self,))
60        CMultiShellModel.__init__(self)
61       
62        ## Name of the model
63        self.name = "MultiShellModel"
64        ## Model description
65        self.description =""" MultiShell (Sphere) Model (or Multilamellar Vesicles): Model parameters;
66                scale : scale factor
67                core_radius : Core radius of the multishell
68                s_thickness: shell thickness
69                w_thickness: water thickness
70                core_sld: core scattering length density
71                shell_sld: shell scattering length density
72                n_pairs:number of pairs of water/shell
73                background: incoherent background"""
74       
75        ## Parameter details [units, min, max]
76        self.details = {}
77        self.details['scale'] = ['', None, None]
78        self.details['core_radius'] = ['[A]', None, None]
79        self.details['s_thickness'] = ['[A]', None, None]
80        self.details['w_thickness'] = ['[A]', None, None]
81        self.details['core_sld'] = ['[1/A^(2)]', None, None]
82        self.details['shell_sld'] = ['[1/A^(2)]', None, None]
83        self.details['n_pairs'] = ['', None, None]
84        self.details['background'] = ['[1/cm]', None, None]
85
86        ## fittable parameters
87        self.fixed=['core_radius.width', 's_thickness.width', 'w_thickness.width']
88       
89        ## non-fittable parameters
90        self.non_fittable = []
91       
92        ## parameters with orientation
93        self.orientation_params = []
94
95    def __setstate__(self, state):
96        """
97        restore the state of a model from pickle
98        """
99        self.__dict__, self.params, self.dispersion = state
100       
101    def __reduce_ex__(self, proto):
102        """
103        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
104        c model.
105        """
106        state = (self.__dict__, self.params, self.dispersion)
107        return (create_MultiShellModel,tuple(), state, None, None)
108       
109    def clone(self):
110        """ Return a identical copy of self """
111        return self._clone(MultiShellModel())   
112       
113   
114    def run(self, x=0.0):
115        """
116        Evaluate the model
117       
118        :param x: input q, or [q,phi]
119       
120        :return: scattering function P(q)
121       
122        """
123       
124        return CMultiShellModel.run(self, x)
125   
126    def runXY(self, x=0.0):
127        """
128        Evaluate the model in cartesian coordinates
129       
130        :param x: input q, or [qx, qy]
131       
132        :return: scattering function P(q)
133       
134        """
135       
136        return CMultiShellModel.runXY(self, x)
137       
138    def evalDistribution(self, x=[]):
139        """
140        Evaluate the model in cartesian coordinates
141       
142        :param x: input q[], or [qx[], qy[]]
143       
144        :return: scattering function P(q[])
145       
146        """
147        return CMultiShellModel.evalDistribution(self, x)
148       
149    def calculate_ER(self):
150        """
151        Calculate the effective radius for P(q)*S(q)
152       
153        :return: the value of the effective radius
154       
155        """       
156        return CMultiShellModel.calculate_ER(self)
157       
158    def set_dispersion(self, parameter, dispersion):
159        """
160        Set the dispersion object for a model parameter
161       
162        :param parameter: name of the parameter [string]
163        :param dispersion: dispersion object of type DispersionModel
164       
165        """
166        return CMultiShellModel.set_dispersion(self, parameter, dispersion.cdisp)
167       
168   
169# End of file
Note: See TracBrowser for help on using the repository browser.