source: sasview/src/sans/models/PringlesModel.py @ 400155b

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 400155b was 400155b, checked in by gonzalezm, 9 years ago

Implementing request from ticket 261 - default number of bins in Annulus [Phi View] is now 36 and the first bin is now centered at 0 degrees

  • Property mode set to 100644
File size: 5.5 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::
19
20   THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
21   DO NOT MODIFY THIS FILE, MODIFY
22   src\sans\models\include\pringles.h
23   AND RE-RUN THE GENERATOR SCRIPT
24"""
25
26from sans.models.BaseComponent import BaseComponent
27from sans.models.sans_extension.c_models import CPringlesModel
28
29def create_PringlesModel():
30    """
31       Create a model instance
32    """
33    obj = PringlesModel()
34    # CPringlesModel.__init__(obj) is called by
35    # the PringlesModel constructor
36    return obj
37
38class PringlesModel(CPringlesModel, BaseComponent):
39    """
40    Class that evaluates a PringlesModel model.
41    This file was auto-generated from src\sans\models\include\pringles.h.
42    Refer to that file and the structure it contains
43    for details of the model.
44   
45    List of default parameters:
46
47    * scale           = 1.0
48    * radius          = 60.0 [A]
49    * thickness       = 10.0 [A]
50    * alpha           = 0.001 [rad]
51    * beta            = 0.02 [rad]
52    * sld_pringle     = 1e-06 [A^(-2)]
53    * sld_solvent     = 6.35e-06 [A^(-2)]
54    * background      = 0.0 [1/cm]
55
56    """
57       
58    def __init__(self, multfactor=1):
59        """ Initialization """
60        self.__dict__ = {}
61       
62        # Initialize BaseComponent first, then sphere
63        BaseComponent.__init__(self)
64        #apply(CPringlesModel.__init__, (self,))
65
66        CPringlesModel.__init__(self)
67        self.is_multifunc = False
68                       
69        ## Name of the model
70        self.name = "PringlesModel"
71        ## Model description
72        self.description = """
73         Pringles model for K Edler. Represents a disc that is bent in two directions.
74        """
75       
76        ## Parameter details [units, min, max]
77        self.details = {}
78        self.details['scale'] = ['', None, None]
79        self.details['radius'] = ['[A]', None, None]
80        self.details['thickness'] = ['[A]', None, None]
81        self.details['alpha'] = ['[rad]', None, None]
82        self.details['beta'] = ['[rad]', None, None]
83        self.details['sld_pringle'] = ['[A^(-2)]', None, None]
84        self.details['sld_solvent'] = ['[A^(-2)]', None, None]
85        self.details['background'] = ['[1/cm]', None, None]
86
87        ## fittable parameters
88        self.fixed = ['radius.width',
89                      'thickness.width',
90                      'alpha.width',
91                      'beta.width']
92       
93        ## non-fittable parameters
94        self.non_fittable = []
95       
96        ## parameters with orientation
97        self.orientation_params = []
98
99        ## parameters with magnetism
100        self.magnetic_params = []
101
102        self.category = None
103        self.multiplicity_info = None
104       
105    def __setstate__(self, state):
106        """
107        restore the state of a model from pickle
108        """
109        self.__dict__, self.params, self.dispersion = state
110       
111    def __reduce_ex__(self, proto):
112        """
113        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
114        c model.
115        """
116        state = (self.__dict__, self.params, self.dispersion)
117        return (create_PringlesModel, tuple(), state, None, None)
118       
119    def clone(self):
120        """ Return a identical copy of self """
121        return self._clone(PringlesModel())   
122       
123    def run(self, x=0.0):
124        """
125        Evaluate the model
126       
127        :param x: input q, or [q,phi]
128       
129        :return: scattering function P(q)
130       
131        """
132        return CPringlesModel.run(self, x)
133   
134    def runXY(self, x=0.0):
135        """
136        Evaluate the model in cartesian coordinates
137       
138        :param x: input q, or [qx, qy]
139       
140        :return: scattering function P(q)
141       
142        """
143        return CPringlesModel.runXY(self, x)
144       
145    def evalDistribution(self, x):
146        """
147        Evaluate the model in cartesian coordinates
148       
149        :param x: input q[], or [qx[], qy[]]
150       
151        :return: scattering function P(q[])
152       
153        """
154        return CPringlesModel.evalDistribution(self, x)
155       
156    def calculate_ER(self):
157        """
158        Calculate the effective radius for P(q)*S(q)
159       
160        :return: the value of the effective radius
161       
162        """       
163        return CPringlesModel.calculate_ER(self)
164       
165    def calculate_VR(self):
166        """
167        Calculate the volf ratio for P(q)*S(q)
168       
169        :return: the value of the volf ratio
170       
171        """       
172        return CPringlesModel.calculate_VR(self)
173             
174    def set_dispersion(self, parameter, dispersion):
175        """
176        Set the dispersion object for a model parameter
177       
178        :param parameter: name of the parameter [string]
179        :param dispersion: dispersion object of type DispersionModel
180       
181        """
182        return CPringlesModel.set_dispersion(self,
183               parameter, dispersion.cdisp)
184       
185   
186# End of file
187
Note: See TracBrowser for help on using the repository browser.