source: sasview/sansmodels/src/python_wrapper/modelTemplate.txt @ 37805e9

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 37805e9 was 67424cd, checked in by Mathieu Doucet <doucetm@…>, 13 years ago

Reorganizing models in preparation of cpp cleanup

  • 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 [INCLUDE_FILE]
23         AND RE-RUN THE GENERATOR SCRIPT
24
25"""
26
27from sans.models.BaseComponent import BaseComponent
28from sans.models.sans_extension.c_models import [CPYTHONCLASS]
29import copy   
30
31def create_[PYTHONCLASS]():
32    obj = [PYTHONCLASS]()
33    #[CPYTHONCLASS].__init__(obj) is called by [PYTHONCLASS] constructor
34    return obj
35
36class [PYTHONCLASS]([CPYTHONCLASS], BaseComponent):
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]
43    """
44       
45    def __init__(self):
46        """ Initialization """
47       
48        # Initialize BaseComponent first, then sphere
49        BaseComponent.__init__(self)
50        #apply([CPYTHONCLASS].__init__, (self,))
51        [CPYTHONCLASS].__init__(self)
52       
53        ## Name of the model
54        self.name = "[PYTHONCLASS]"
55        ## Model description
56        self.description ="""[DESCRIPTION]"""
57       
58        [PAR_DETAILS]
59        ## fittable parameters
60        self.fixed=[FIXED]
61       
62        ## non-fittable parameters
63        self.non_fittable = [NON_FITTABLE_PARAMS]
64       
65        ## parameters with orientation
66        self.orientation_params = [ORIENTATION_PARAMS]
67
68    def __setstate__(self, state):
69        """
70        restore the state of a model from pickle
71        """
72        self.__dict__, self.params, self.dispersion = state
73       
74    def __reduce_ex__(self, proto):
75        """
76        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
77        c model.
78        """
79        state = (self.__dict__, self.params, self.dispersion)
80        return (create_[PYTHONCLASS],tuple(), state, None, None)
81       
82    def clone(self):
83        """ Return a identical copy of self """
84        return self._clone([PYTHONCLASS]())   
85       
86   
87    def run(self, x=0.0):
88        """
89        Evaluate the model
90       
91        :param x: input q, or [q,phi]
92       
93        :return: scattering function P(q)
94       
95        """
96       
97        return [CPYTHONCLASS].run(self, x)
98   
99    def runXY(self, x=0.0):
100        """
101        Evaluate the model in cartesian coordinates
102       
103        :param x: input q, or [qx, qy]
104       
105        :return: scattering function P(q)
106       
107        """
108       
109        return [CPYTHONCLASS].runXY(self, x)
110       
111    def evalDistribution(self, x=[]):
112        """
113        Evaluate the model in cartesian coordinates
114       
115        :param x: input q[], or [qx[], qy[]]
116       
117        :return: scattering function P(q[])
118       
119        """
120        return [CPYTHONCLASS].evalDistribution(self, x)
121       
122    def calculate_ER(self):
123        """
124        Calculate the effective radius for P(q)*S(q)
125       
126        :return: the value of the effective radius
127       
128        """       
129        return [CPYTHONCLASS].calculate_ER(self)
130       
131    def set_dispersion(self, parameter, dispersion):
132        """
133        Set the dispersion object for a model parameter
134       
135        :param parameter: name of the parameter [string]
136        :param dispersion: dispersion object of type DispersionModel
137       
138        """
139        return [CPYTHONCLASS].set_dispersion(self, parameter, dispersion.cdisp)
140       
141   
142# End of file
Note: See TracBrowser for help on using the repository browser.