source: sasview/sansmodels/src/python_wrapper/modelTemplate.txt @ 9e91546

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 9e91546 was 43e8326, checked in by Mathieu Doucet <doucetm@…>, 13 years ago

Fixing code style problems

  • Property mode set to 100644
File size: 4.5 KB
RevLine 
[79ac6f8]1##############################################################################
[d47c349]2# This software was developed by the University of Tennessee as part of the
3# Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
4# project funded by the US National Science Foundation.
[79ac6f8]5#
[d47c349]6# If you use DANSE applications to do scientific research that leads to
7# publication, we ask that you acknowledge the use of the software with the
8# following sentence:
[79ac6f8]9#
[d47c349]10# This work benefited from DANSE software developed under NSF award DMR-0520547
[79ac6f8]11#
[d47c349]12# Copyright 2008-2011, University of Tennessee
[79ac6f8]13##############################################################################
[af03ddd]14
[79ac6f8]15"""
16Provide functionality for a C extension model
[af03ddd]17
[79ac6f8]18:WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
[79ba1fc]19         DO NOT MODIFY THIS FILE, MODIFY
20            [INCLUDE_FILE]
[79ac6f8]21         AND RE-RUN THE GENERATOR SCRIPT
[af03ddd]22"""
23
24from sans.models.BaseComponent import BaseComponent
[f578ad4]25from sans.models.sans_extension.c_models import [CPYTHONCLASS]
[5650ebf]26
27def create_[PYTHONCLASS]():
[411d8bf]28    """
29       Create a model instance
30    """
[5650ebf]31    obj = [PYTHONCLASS]()
[79ba1fc]32    # [CPYTHONCLASS].__init__(obj) is called by
33    # the [PYTHONCLASS] constructor
[5650ebf]34    return obj
35
[af03ddd]36class [PYTHONCLASS]([CPYTHONCLASS], BaseComponent):
[79ac6f8]37    """
38    Class that evaluates a [PYTHONCLASS] model.
39    This file was auto-generated from [INCLUDE_FILE].
40    Refer to that file and the structure it contains
41    for details of the model.
42    [DEFAULT_LIST]
[af03ddd]43    """
44       
45    def __init__(self):
46        """ Initialization """
[d47c349]47        self.__dict__ = {}
[af03ddd]48       
49        # Initialize BaseComponent first, then sphere
50        BaseComponent.__init__(self)
[5650ebf]51        #apply([CPYTHONCLASS].__init__, (self,))
[af03ddd]52        [CPYTHONCLASS].__init__(self)
53       
54        ## Name of the model
55        self.name = "[PYTHONCLASS]"
[836fe6e]56        ## Model description
[43e8326]57        self.description = """
58        [DESCRIPTION]
59        """
[836fe6e]60       
[fe9c19b4]61        [PAR_DETAILS]
62        ## fittable parameters
[411d8bf]63        self.fixed = [FIXED]
[25a608f5]64       
[8622241]65        ## non-fittable parameters
66        self.non_fittable = [NON_FITTABLE_PARAMS]
67       
[25a608f5]68        ## parameters with orientation
[8622241]69        self.orientation_params = [ORIENTATION_PARAMS]
[2360a7b]70
71    def __setstate__(self, state):
72        """
73        restore the state of a model from pickle
74        """
75        self.__dict__, self.params, self.dispersion = state
76       
[5650ebf]77    def __reduce_ex__(self, proto):
[79ac6f8]78        """
[5650ebf]79        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
80        c model.
[79ac6f8]81        """
[2360a7b]82        state = (self.__dict__, self.params, self.dispersion)
[411d8bf]83        return (create_[PYTHONCLASS], tuple(), state, None, None)
[fe9c19b4]84       
[5650ebf]85    def clone(self):
86        """ Return a identical copy of self """
87        return self._clone([PYTHONCLASS]())   
[fe9c19b4]88       
[af03ddd]89   
[79ac6f8]90    def run(self, x=0.0):
91        """
92        Evaluate the model
93       
94        :param x: input q, or [q,phi]
95       
96        :return: scattering function P(q)
97       
[af03ddd]98        """
99       
100        return [CPYTHONCLASS].run(self, x)
101   
[79ac6f8]102    def runXY(self, x=0.0):
103        """
104        Evaluate the model in cartesian coordinates
105       
106        :param x: input q, or [qx, qy]
107       
108        :return: scattering function P(q)
109       
[af03ddd]110        """
111       
112        return [CPYTHONCLASS].runXY(self, x)
113       
[d47c349]114    def evalDistribution(self, x):
[79ac6f8]115        """
116        Evaluate the model in cartesian coordinates
117       
118        :param x: input q[], or [qx[], qy[]]
119       
120        :return: scattering function P(q[])
121       
[5b56b7a]122        """
[f9a1279]123        return [CPYTHONCLASS].evalDistribution(self, x)
[5b56b7a]124       
[5eb9154]125    def calculate_ER(self):
[79ac6f8]126        """
127        Calculate the effective radius for P(q)*S(q)
128       
129        :return: the value of the effective radius
130       
[5eb9154]131        """       
132        return [CPYTHONCLASS].calculate_ER(self)
133       
[e08bd5b]134    def calculate_VR(self):
135        """
136        Calculate the volf ratio for P(q)*S(q)
137       
138        :return: the value of the volf ratio
139       
140        """       
141        return [CPYTHONCLASS].calculate_VR(self)
142             
[af03ddd]143    def set_dispersion(self, parameter, dispersion):
144        """
[79ac6f8]145        Set the dispersion object for a model parameter
146       
147        :param parameter: name of the parameter [string]
148        :param dispersion: dispersion object of type DispersionModel
149       
[af03ddd]150        """
[79ba1fc]151        return [CPYTHONCLASS].set_dispersion(self,
152               parameter, dispersion.cdisp)
[af03ddd]153       
154   
155# End of file
Note: See TracBrowser for help on using the repository browser.