source: sasview/sansmodels/src/python_wrapper/modelTemplate.txt @ 87f8971

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 87f8971 was 318b5bbb, checked in by Jae Cho <jhjcho@…>, 12 years ago

Added polarization and magnetic stuffs

  • Property mode set to 100644
File size: 4.7 KB
Line 
1##############################################################################
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.
5#
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:
9#
10# This work benefited from DANSE software developed under NSF award DMR-0520547
11#
12# Copyright 2008-2011, University of Tennessee
13##############################################################################
14
15"""
16Provide functionality for a C extension model
17
18:WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
19         DO NOT MODIFY THIS FILE, MODIFY
20            [INCLUDE_FILE]
21         AND RE-RUN THE GENERATOR SCRIPT
22"""
23
24from sans.models.BaseComponent import BaseComponent
25from sans.models.sans_extension.c_models import [CPYTHONCLASS]
26
27def create_[PYTHONCLASS]():
28    """
29       Create a model instance
30    """
31    obj = [PYTHONCLASS]()
32    # [CPYTHONCLASS].__init__(obj) is called by
33    # the [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, multfactor=1):
46        """ Initialization """
47        self.__dict__ = {}
48       
49        # Initialize BaseComponent first, then sphere
50        BaseComponent.__init__(self)
51        #apply([CPYTHONCLASS].__init__, (self,))
52
53        [CALL_CPYTHON_INIT]
54                       
55        ## Name of the model
56        self.name = "[PYTHONCLASS]"
57        ## Model description
58        self.description = """
59        [DESCRIPTION]
60        """
61       
62        [PAR_DETAILS]
63        ## fittable parameters
64        self.fixed = [FIXED]
65       
66        ## non-fittable parameters
67        self.non_fittable = [NON_FITTABLE_PARAMS]
68       
69        ## parameters with orientation
70        self.orientation_params = [ORIENTATION_PARAMS]
71
72        ## parameters with magnetism
73        self.magnetic_params = [MAGNETIC_PARAMS]
74
75        self.category = [CATEGORY]
76        self.multiplicity_info = [MULTIPLICITY_INFO]
77       
78    def __setstate__(self, state):
79        """
80        restore the state of a model from pickle
81        """
82        self.__dict__, self.params, self.dispersion = state
83       
84    def __reduce_ex__(self, proto):
85        """
86        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
87        c model.
88        """
89        state = (self.__dict__, self.params, self.dispersion)
90        return (create_[PYTHONCLASS], tuple(), state, None, None)
91       
92    def clone(self):
93        """ Return a identical copy of self """
94        return self._clone([PYTHONCLASS]())   
95       
96    def run(self, x=0.0):
97        """
98        Evaluate the model
99       
100        :param x: input q, or [q,phi]
101       
102        :return: scattering function P(q)
103       
104        """
105        return [CPYTHONCLASS].run(self, x)
106   
107    def runXY(self, x=0.0):
108        """
109        Evaluate the model in cartesian coordinates
110       
111        :param x: input q, or [qx, qy]
112       
113        :return: scattering function P(q)
114       
115        """
116        return [CPYTHONCLASS].runXY(self, x)
117       
118    def evalDistribution(self, x):
119        """
120        Evaluate the model in cartesian coordinates
121       
122        :param x: input q[], or [qx[], qy[]]
123       
124        :return: scattering function P(q[])
125       
126        """
127        return [CPYTHONCLASS].evalDistribution(self, x)
128       
129    def calculate_ER(self):
130        """
131        Calculate the effective radius for P(q)*S(q)
132       
133        :return: the value of the effective radius
134       
135        """       
136        return [CPYTHONCLASS].calculate_ER(self)
137       
138    def calculate_VR(self):
139        """
140        Calculate the volf ratio for P(q)*S(q)
141       
142        :return: the value of the volf ratio
143       
144        """       
145        return [CPYTHONCLASS].calculate_VR(self)
146             
147    def set_dispersion(self, parameter, dispersion):
148        """
149        Set the dispersion object for a model parameter
150       
151        :param parameter: name of the parameter [string]
152        :param dispersion: dispersion object of type DispersionModel
153       
154        """
155        return [CPYTHONCLASS].set_dispersion(self,
156               parameter, dispersion.cdisp)
157       
158   
159# End of file
Note: See TracBrowser for help on using the repository browser.