source: sasview/sansmodels/src/sans/models/Schulz.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: 4.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\schulz.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 CSchulz
29import copy   
30
31def create_Schulz():
32    obj = Schulz()
33    #CSchulz.__init__(obj) is called by Schulz constructor
34    return obj
35
36class Schulz(CSchulz, BaseComponent):
37    """
38    Class that evaluates a Schulz model.
39    This file was auto-generated from ..\c_extensions\schulz.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         sigma           = 1.0
45         center          = 0.0
46
47    """
48       
49    def __init__(self):
50        """ Initialization """
51       
52        # Initialize BaseComponent first, then sphere
53        BaseComponent.__init__(self)
54        #apply(CSchulz.__init__, (self,))
55        CSchulz.__init__(self)
56       
57        ## Name of the model
58        self.name = "Schulz"
59        ## Model description
60        self.description =""" f(x)=scale * math.pow(z+1, z+1)*math.pow((R), z)*
61                math.exp(-R*(z+1))/(center*gamma(z+1)
62                z= math.pow[(1/(sigma/center),2]-1"""
63       
64        ## Parameter details [units, min, max]
65        self.details = {}
66        self.details['scale'] = ['', None, None]
67        self.details['sigma'] = ['', None, None]
68        self.details['center'] = ['', None, None]
69
70        ## fittable parameters
71        self.fixed=[]
72       
73        ## non-fittable parameters
74        self.non_fittable = []
75       
76        ## parameters with orientation
77        self.orientation_params = []
78
79    def __setstate__(self, state):
80        """
81        restore the state of a model from pickle
82        """
83        self.__dict__, self.params, self.dispersion = state
84       
85    def __reduce_ex__(self, proto):
86        """
87        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
88        c model.
89        """
90        state = (self.__dict__, self.params, self.dispersion)
91        return (create_Schulz,tuple(), state, None, None)
92       
93    def clone(self):
94        """ Return a identical copy of self """
95        return self._clone(Schulz())   
96       
97   
98    def run(self, x=0.0):
99        """
100        Evaluate the model
101       
102        :param x: input q, or [q,phi]
103       
104        :return: scattering function P(q)
105       
106        """
107       
108        return CSchulz.run(self, x)
109   
110    def runXY(self, x=0.0):
111        """
112        Evaluate the model in cartesian coordinates
113       
114        :param x: input q, or [qx, qy]
115       
116        :return: scattering function P(q)
117       
118        """
119       
120        return CSchulz.runXY(self, x)
121       
122    def evalDistribution(self, x=[]):
123        """
124        Evaluate the model in cartesian coordinates
125       
126        :param x: input q[], or [qx[], qy[]]
127       
128        :return: scattering function P(q[])
129       
130        """
131        return CSchulz.evalDistribution(self, x)
132       
133    def calculate_ER(self):
134        """
135        Calculate the effective radius for P(q)*S(q)
136       
137        :return: the value of the effective radius
138       
139        """       
140        return CSchulz.calculate_ER(self)
141       
142    def set_dispersion(self, parameter, dispersion):
143        """
144        Set the dispersion object for a model parameter
145       
146        :param parameter: name of the parameter [string]
147        :param dispersion: dispersion object of type DispersionModel
148       
149        """
150        return CSchulz.set_dispersion(self, parameter, dispersion.cdisp)
151       
152   
153# End of file
Note: See TracBrowser for help on using the repository browser.