source: sasview/sansmodels/src/sans/models/DiamEllipFunc.py @ f82fe3c

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 f82fe3c was c7a7e1b, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on model pickle

  • Property mode set to 100644
File size: 4.7 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\DiamEllip.h
23         AND RE-RUN THE GENERATOR SCRIPT
24
25"""
26
27from sans.models.BaseComponent import BaseComponent
28from sans_extension.c_models import CDiamEllipFunc
29import copy   
30
31def create_DiamEllipFunc():
32    obj = DiamEllipFunc()
33    #CDiamEllipFunc.__init__(obj) is called by DiamEllipFunc constructor
34    return obj
35
36class DiamEllipFunc(CDiamEllipFunc, BaseComponent):
37    """
38    Class that evaluates a DiamEllipFunc model.
39    This file was auto-generated from ..\c_extensions\DiamEllip.h.
40    Refer to that file and the structure it contains
41    for details of the model.
42    List of default parameters:
43         radius_a        = 20.0 A
44         radius_b        = 400.0 A
45
46    """
47       
48    def __init__(self):
49        """ Initialization """
50       
51        # Initialize BaseComponent first, then sphere
52        BaseComponent.__init__(self)
53        #apply(CDiamEllipFunc.__init__, (self,))
54        CDiamEllipFunc.__init__(self)
55       
56        ## Name of the model
57        self.name = "DiamEllipFunc"
58        ## Model description
59        self.description ="""To calculate the 2nd virial coefficient for
60                the non-spherical object, then find the
61                radius of sphere that has this value of
62                virial coefficient:
63                radius_a = polar radius,
64                radius_b = equatorial radius;
65                radius_a > radius_b: Prolate spheroid,
66                radius_a < radius_b: Oblate spheroid."""
67       
68        ## Parameter details [units, min, max]
69        self.details = {}
70        self.details['radius_a'] = ['A', None, None]
71        self.details['radius_b'] = ['A', None, None]
72
73        ## fittable parameters
74        self.fixed=['radius_a.width', 'radius_b.width']
75       
76        ## non-fittable parameters
77        self.non_fittable = []
78       
79        ## parameters with orientation
80        self.orientation_params = []
81
82    def __setstate__(self, state):
83        """
84        restore the state of a model from pickle
85        """
86        self.__dict__, self.params, self.dispersion = state
87       
88    def __reduce_ex__(self, proto):
89        """
90        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
91        c model.
92        """
93        state = (self.__dict__, self.params, self.dispersion)
94        return (create_DiamEllipFunc,tuple(), state, None, None)
95       
96    def clone(self):
97        """ Return a identical copy of self """
98        return self._clone(DiamEllipFunc())   
99       
100   
101    def run(self, x=0.0):
102        """
103        Evaluate the model
104       
105        :param x: input q, or [q,phi]
106       
107        :return: scattering function P(q)
108       
109        """
110       
111        return CDiamEllipFunc.run(self, x)
112   
113    def runXY(self, x=0.0):
114        """
115        Evaluate the model in cartesian coordinates
116       
117        :param x: input q, or [qx, qy]
118       
119        :return: scattering function P(q)
120       
121        """
122       
123        return CDiamEllipFunc.runXY(self, x)
124       
125    def evalDistribution(self, x=[]):
126        """
127        Evaluate the model in cartesian coordinates
128       
129        :param x: input q[], or [qx[], qy[]]
130       
131        :return: scattering function P(q[])
132       
133        """
134        return CDiamEllipFunc.evalDistribution(self, x)
135       
136    def calculate_ER(self):
137        """
138        Calculate the effective radius for P(q)*S(q)
139       
140        :return: the value of the effective radius
141       
142        """       
143        return CDiamEllipFunc.calculate_ER(self)
144       
145    def set_dispersion(self, parameter, dispersion):
146        """
147        Set the dispersion object for a model parameter
148       
149        :param parameter: name of the parameter [string]
150        :param dispersion: dispersion object of type DispersionModel
151       
152        """
153        return CDiamEllipFunc.set_dispersion(self, parameter, dispersion.cdisp)
154       
155   
156# End of file
Note: See TracBrowser for help on using the repository browser.