source: sasview/sansmodels/src/sans/models/Lorentzian.py @ 18695bf

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 18695bf was 96656e3, checked in by Jae Cho <jhjcho@…>, 14 years ago

update models due to changes of template

  • Property mode set to 100644
File size: 4.2 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\lorentzian.h
23         AND RE-RUN THE GENERATOR SCRIPT
24
25"""
26
27from sans.models.BaseComponent import BaseComponent
28from sans_extension.c_models import CLorentzian
29import copy   
30
31def create_Lorentzian():
32    obj = Lorentzian()
33    #CLorentzian.__init__(obj) is called by Lorentzian constructor
34    return obj
35
36class Lorentzian(CLorentzian, BaseComponent):
37    """
38    Class that evaluates a Lorentzian model.
39    This file was auto-generated from ..\c_extensions\lorentzian.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         gamma           = 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(CLorentzian.__init__, (self,))
55        CLorentzian.__init__(self)
56       
57        ## Name of the model
58        self.name = "Lorentzian"
59        ## Model description
60        self.description ="""f(x)=scale * 1/pi 0.5gamma / [ (x-x_0)^2 + (0.5gamma)^2 ]"""
61       
62        ## Parameter details [units, min, max]
63        self.details = {}
64        self.details['scale'] = ['', None, None]
65        self.details['gamma'] = ['', None, None]
66        self.details['center'] = ['', None, None]
67
68        ## fittable parameters
69        self.fixed=[]
70       
71        ## non-fittable parameters
72        self.non_fittable = []
73       
74        ## parameters with orientation
75        self.orientation_params = []
76   
77    def __reduce_ex__(self, proto):
78        """
79        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
80        c model.
81        """
82        return (create_Lorentzian,tuple())
83       
84    def clone(self):
85        """ Return a identical copy of self """
86        return self._clone(Lorentzian())   
87       
88   
89    def run(self, x=0.0):
90        """
91        Evaluate the model
92       
93        :param x: input q, or [q,phi]
94       
95        :return: scattering function P(q)
96       
97        """
98       
99        return CLorentzian.run(self, x)
100   
101    def runXY(self, x=0.0):
102        """
103        Evaluate the model in cartesian coordinates
104       
105        :param x: input q, or [qx, qy]
106       
107        :return: scattering function P(q)
108       
109        """
110       
111        return CLorentzian.runXY(self, x)
112       
113    def evalDistribution(self, x=[]):
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        return CLorentzian.evalDistribution(self, x)
123       
124    def calculate_ER(self):
125        """
126        Calculate the effective radius for P(q)*S(q)
127       
128        :return: the value of the effective radius
129       
130        """       
131        return CLorentzian.calculate_ER(self)
132       
133    def set_dispersion(self, parameter, dispersion):
134        """
135        Set the dispersion object for a model parameter
136       
137        :param parameter: name of the parameter [string]
138        :param dispersion: dispersion object of type DispersionModel
139       
140        """
141        return CLorentzian.set_dispersion(self, parameter, dispersion.cdisp)
142       
143   
144# End of file
Note: See TracBrowser for help on using the repository browser.