source: sasview/sansmodels/src/sans/models/TriaxialEllipsoidModel.py @ 2ca00c4

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 2ca00c4 was 96656e3, checked in by Jae Cho <jhjcho@…>, 14 years ago

update models due to changes of template

  • Property mode set to 100644
File size: 5.4 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 ..\c_extensions\triaxial_ellipsoid.h
23         AND RE-RUN THE GENERATOR SCRIPT
24
25"""
26
27from sans.models.BaseComponent import BaseComponent
28from sans_extension.c_models import CTriaxialEllipsoidModel
29import copy   
30
31def create_TriaxialEllipsoidModel():
32    obj = TriaxialEllipsoidModel()
33    #CTriaxialEllipsoidModel.__init__(obj) is called by TriaxialEllipsoidModel constructor
34    return obj
35
36class TriaxialEllipsoidModel(CTriaxialEllipsoidModel, BaseComponent):
37    """
38    Class that evaluates a TriaxialEllipsoidModel model.
39    This file was auto-generated from ..\c_extensions\triaxial_ellipsoid.h.
40    Refer to that file and the structure it contains
41    for details of the model.
42    List of default parameters:
43         scale           = 1.0
44         semi_axisA      = 35.0 [A]
45         semi_axisB      = 100.0 [A]
46         semi_axisC      = 400.0 [A]
47         sldEll          = 1e-006 [1/A^(2)]
48         sldSolv         = 6.3e-006 [1/A^(2)]
49         background      = 0.0 [1/cm]
50         axis_theta      = 57.325 [deg]
51         axis_phi        = 57.325 [deg]
52         axis_psi        = 0.0 [deg]
53
54    """
55       
56    def __init__(self):
57        """ Initialization """
58       
59        # Initialize BaseComponent first, then sphere
60        BaseComponent.__init__(self)
61        #apply(CTriaxialEllipsoidModel.__init__, (self,))
62        CTriaxialEllipsoidModel.__init__(self)
63       
64        ## Name of the model
65        self.name = "TriaxialEllipsoidModel"
66        ## Model description
67        self.description ="""Note: During fitting ensure that the inequality A<B<C is not
68                violated. Otherwise the calculation will
69                not be correct."""
70       
71        ## Parameter details [units, min, max]
72        self.details = {}
73        self.details['scale'] = ['', None, None]
74        self.details['semi_axisA'] = ['[A]', None, None]
75        self.details['semi_axisB'] = ['[A]', None, None]
76        self.details['semi_axisC'] = ['[A]', None, None]
77        self.details['sldEll'] = ['[1/A^(2)]', None, None]
78        self.details['sldSolv'] = ['[1/A^(2)]', None, None]
79        self.details['background'] = ['[1/cm]', None, None]
80        self.details['axis_theta'] = ['[deg]', None, None]
81        self.details['axis_phi'] = ['[deg]', None, None]
82        self.details['axis_psi'] = ['[deg]', None, None]
83
84        ## fittable parameters
85        self.fixed=['axis_psi.width', 'axis_phi.width', 'axis_theta.width', 'semi_axisA.width', 'semi_axisB.width', 'semi_axisC.width']
86       
87        ## non-fittable parameters
88        self.non_fittable = []
89       
90        ## parameters with orientation
91        self.orientation_params = ['axis_psi', 'axis_phi', 'axis_theta', 'axis_psi.width', 'axis_phi.width', 'axis_theta.width']
92   
93    def __reduce_ex__(self, proto):
94        """
95        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
96        c model.
97        """
98        return (create_TriaxialEllipsoidModel,tuple())
99       
100    def clone(self):
101        """ Return a identical copy of self """
102        return self._clone(TriaxialEllipsoidModel())   
103       
104   
105    def run(self, x=0.0):
106        """
107        Evaluate the model
108       
109        :param x: input q, or [q,phi]
110       
111        :return: scattering function P(q)
112       
113        """
114       
115        return CTriaxialEllipsoidModel.run(self, x)
116   
117    def runXY(self, x=0.0):
118        """
119        Evaluate the model in cartesian coordinates
120       
121        :param x: input q, or [qx, qy]
122       
123        :return: scattering function P(q)
124       
125        """
126       
127        return CTriaxialEllipsoidModel.runXY(self, x)
128       
129    def evalDistribution(self, x=[]):
130        """
131        Evaluate the model in cartesian coordinates
132       
133        :param x: input q[], or [qx[], qy[]]
134       
135        :return: scattering function P(q[])
136       
137        """
138        return CTriaxialEllipsoidModel.evalDistribution(self, x)
139       
140    def calculate_ER(self):
141        """
142        Calculate the effective radius for P(q)*S(q)
143       
144        :return: the value of the effective radius
145       
146        """       
147        return CTriaxialEllipsoidModel.calculate_ER(self)
148       
149    def set_dispersion(self, parameter, dispersion):
150        """
151        Set the dispersion object for a model parameter
152       
153        :param parameter: name of the parameter [string]
154        :param dispersion: dispersion object of type DispersionModel
155       
156        """
157        return CTriaxialEllipsoidModel.set_dispersion(self, parameter, dispersion.cdisp)
158       
159   
160# End of file
Note: See TracBrowser for help on using the repository browser.