source: sasview/sansmodels/src/sans/models/Lorentzian.py @ 8a48713

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 8a48713 was 988130c6, checked in by Gervaise Alina <gervyh@…>, 16 years ago

self.fixed field added in models but need to change wrapper generator

  • Property mode set to 100644
File size: 2.9 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/lorentzian.h
20                 AND RE-RUN THE GENERATOR SCRIPT
21
22"""
23
24from sans.models.BaseComponent import BaseComponent
25from sans_extension.c_models import CLorentzian
26import copy   
27   
28class Lorentzian(CLorentzian, BaseComponent):
29    """ Class that evaluates a Lorentzian model.
30        This file was auto-generated from ../c_extensions/lorentzian.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         gamma           = 1.0
36         center          = 0.0
37
38    """
39       
40    def __init__(self):
41        """ Initialization """
42       
43        # Initialize BaseComponent first, then sphere
44        BaseComponent.__init__(self)
45        CLorentzian.__init__(self)
46       
47        ## Name of the model
48        self.name = "Lorentzian"
49        self.description ="""f(x)=scale * 1/pi 0.5gamma / [ (x-x_0)^2 + (0.5gamma)^2 ]"""
50                ## Parameter details [units, min, max]
51        self.details = {}
52        self.details['scale'] = ['', None, None]
53        self.details['gamma'] = ['', None, None]
54        self.details['center'] = ['', None, None]
55        #list of parameter that cannot be fitted
56        self.fixed= []
57   
58    def clone(self):
59        """ Return a identical copy of self """
60        return self._clone(Lorentzian())   
61   
62    def run(self, x = 0.0):
63        """ Evaluate the model
64            @param x: input q, or [q,phi]
65            @return: scattering function P(q)
66        """
67       
68        return CLorentzian.run(self, x)
69   
70    def runXY(self, x = 0.0):
71        """ Evaluate the model in cartesian coordinates
72            @param x: input q, or [qx, qy]
73            @return: scattering function P(q)
74        """
75       
76        return CLorentzian.runXY(self, x)
77       
78    def set_dispersion(self, parameter, dispersion):
79        """
80            Set the dispersion object for a model parameter
81            @param parameter: name of the parameter [string]
82            @dispersion: dispersion object of type DispersionModel
83        """
84        return CLorentzian.set_dispersion(self, parameter, dispersion.cdisp)
85       
86   
87# End of file
Note: See TracBrowser for help on using the repository browser.