source: sasview/sansmodels/src/sans/models/VesicleModel.py @ c451be9

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 c451be9 was c451be9, checked in by Jae Cho <jhjcho@…>, 15 years ago

corrections on the definition of polydispersity as suggested by steve K: should be normalized by average volume

  • Property mode set to 100644
File size: 4.5 KB
Line 
1#!/usr/bin/env python
2"""
3        This software was developed by the University of Tennessee as part of the
4        Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
5        project funded by the US National Science Foundation.
6
7        If you use DANSE applications to do scientific research that leads to
8        publication, we ask that you acknowledge the use of the software with the
9        following sentence:
10
11        "This work benefited from DANSE software developed under NSF award DMR-0520547."
12
13        copyright 2008, University of Tennessee
14"""
15
16""" Provide functionality for a C extension model
17
18        WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
19                 DO NOT MODIFY THIS FILE, MODIFY ..\c_extensions\vesicle.h
20                 AND RE-RUN THE GENERATOR SCRIPT
21
22"""
23
24from sans.models.BaseComponent import BaseComponent
25from sans_extension.c_models import CVesicleModel
26import copy   
27   
28class VesicleModel(CVesicleModel, BaseComponent):
29    """ Class that evaluates a VesicleModel model.
30        This file was auto-generated from ..\c_extensions\vesicle.h.
31        Refer to that file and the structure it contains
32        for details of the model.
33        List of default parameters:
34         scale           = 1.0
35         radius          = 100.0 [A]
36         thickness       = 30.0 [A]
37         core_sld        = 6.36e-006 [1/A^(2)]
38         shell_sld       = 5e-007 [1/A^(2)]
39         background      = 0.0 [1/cm]
40
41    """
42       
43    def __init__(self):
44        """ Initialization """
45       
46        # Initialize BaseComponent first, then sphere
47        BaseComponent.__init__(self)
48        CVesicleModel.__init__(self)
49       
50        ## Name of the model
51        self.name = "VesicleModel"
52        ## Model description
53        self.description ="""Model parameters:    radius : the core radius of the vesicle
54                thickness: the shell thickness
55                core_sld: the core SLD
56                shell_sld: the shell SLD
57                background: incoherent background
58                scale : scale factor"""
59       
60        ## Parameter details [units, min, max]
61        self.details = {}
62        self.details['scale'] = ['', None, None]
63        self.details['radius'] = ['[A]', None, None]
64        self.details['thickness'] = ['[A]', None, None]
65        self.details['core_sld'] = ['[1/A^(2)]', None, None]
66        self.details['shell_sld'] = ['[1/A^(2)]', None, None]
67        self.details['background'] = ['[1/cm]', None, None]
68
69        ## fittable parameters
70        self.fixed=['radius.width', 'thickness.width']
71       
72        ## parameters with orientation
73        self.orientation_params =[]
74   
75    def clone(self):
76        """ Return a identical copy of self """
77        return self._clone(VesicleModel())   
78       
79    def __getstate__(self):
80        """ return object state for pickling and copying """
81        model_state = {'params': self.params, 'dispersion': self.dispersion, 'log': self.log}
82       
83        return self.__dict__, model_state
84       
85    def __setstate__(self, state):
86        """ create object from pickled state """
87       
88        self.__dict__, model_state = state
89        self.params = model_state['params']
90        self.dispersion = model_state['dispersion']
91        self.log = model_state['log']
92       
93   
94    def run(self, x = 0.0):
95        """ Evaluate the model
96            @param x: input q, or [q,phi]
97            @return: scattering function P(q)
98        """
99       
100        return CVesicleModel.run(self, x)
101   
102    def runXY(self, x = 0.0):
103        """ Evaluate the model in cartesian coordinates
104            @param x: input q, or [qx, qy]
105            @return: scattering function P(q)
106        """
107       
108        return CVesicleModel.runXY(self, x)
109       
110    def evalDistribition(self, x = []):
111        """ Evaluate the model in cartesian coordinates
112            @param x: input q[], or [qx[], qy[]]
113            @return: scattering function P(q[])
114        """
115        return CVesicleModel.evalDistribition(self, x)
116       
117    def calculate_ER(self):
118        """ Calculate the effective radius for P(q)*S(q)
119            @return: the value of the effective radius
120        """       
121        return CVesicleModel.calculate_ER(self)
122       
123    def set_dispersion(self, parameter, dispersion):
124        """
125            Set the dispersion object for a model parameter
126            @param parameter: name of the parameter [string]
127            @dispersion: dispersion object of type DispersionModel
128        """
129        return CVesicleModel.set_dispersion(self, parameter, dispersion.cdisp)
130       
131   
132# End of file
Note: See TracBrowser for help on using the repository browser.