source: sasview/sansmodels/src/sans/models/Lorentzian.py @ 4e2f6ef8

#!/usr/bin/env python
""" Provide functionality for a C extension model

        WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
                 DO NOT MODIFY THIS FILE, MODIFY lorentzian.h
                 AND RE-RUN THE GENERATOR SCRIPT

    @author: Mathieu Doucet / UTK
    @contact: mathieu.doucet@nist.gov
"""

from sans.models.BaseComponent import BaseComponent
from sans_extension.c_models import CLorentzian
import copy    
    
class Lorentzian(CLorentzian, BaseComponent):
    """ Class that evaluates a Lorentzian model. 
        This file was auto-generated from lorentzian.h.
        Refer to that file and the structure it contains
        for details of the model.
        List of default parameters:
         scale           = 1.0 
         gamma           = 1.0 
         center          = 0.0 

    """
        
    def __init__(self):
        """ Initialization """
        
        # Initialize BaseComponent first, then sphere
        BaseComponent.__init__(self)
        CLorentzian.__init__(self)
        
        ## Name of the model
        self.name = "Lorentzian"
        self.description=''
                ## Parameter details [units, min, max]
        self.details = {}
        self.details['scale'] = ['', None, None]
        self.details['gamma'] = ['', None, None]
        self.details['center'] = ['', None, None]

   
    def clone(self):
        """ Return a identical copy of self """
        obj = Lorentzian()
        obj.params = copy.deepcopy(self.params)
        return obj   
   
    def run(self, x = 0.0):
        """ Evaluate the model
            @param x: input q, or [q,phi]
            @return: scattering function P(q)
        """
        
        return CLorentzian.run(self, x)
   
    def runXY(self, x = 0.0):
        """ Evaluate the model in cartesian coordinates
            @param x: input q, or [qx, qy]
            @return: scattering function P(q)
        """
        
        return CLorentzian.runXY(self, x)
   
# End of file