source: sasview/sansmodels/src/sans/models/DiamCylFunc.py @ da20018

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 da20018 was c7a7e1b, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on model pickle

  • Property mode set to 100644
File size: 4.5 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\DiamCyl.h
23         AND RE-RUN THE GENERATOR SCRIPT
24
25"""
26
27from sans.models.BaseComponent import BaseComponent
28from sans_extension.c_models import CDiamCylFunc
29import copy   
30
31def create_DiamCylFunc():
32    obj = DiamCylFunc()
33    #CDiamCylFunc.__init__(obj) is called by DiamCylFunc constructor
34    return obj
35
36class DiamCylFunc(CDiamCylFunc, BaseComponent):
37    """
38    Class that evaluates a DiamCylFunc model.
39    This file was auto-generated from ..\c_extensions\DiamCyl.h.
40    Refer to that file and the structure it contains
41    for details of the model.
42    List of default parameters:
43         radius          = 20.0 A
44         length          = 400.0 A
45
46    """
47       
48    def __init__(self):
49        """ Initialization """
50       
51        # Initialize BaseComponent first, then sphere
52        BaseComponent.__init__(self)
53        #apply(CDiamCylFunc.__init__, (self,))
54        CDiamCylFunc.__init__(self)
55       
56        ## Name of the model
57        self.name = "DiamCylFunc"
58        ## Model description
59        self.description ="""To calculate the 2nd virial coefficient for
60                the non-spherical object, then find the
61                radius of sphere that has this value of
62                virial coefficient."""
63       
64        ## Parameter details [units, min, max]
65        self.details = {}
66        self.details['radius'] = ['A', None, None]
67        self.details['length'] = ['A', None, None]
68
69        ## fittable parameters
70        self.fixed=['radius.width', 'length.width']
71       
72        ## non-fittable parameters
73        self.non_fittable = []
74       
75        ## parameters with orientation
76        self.orientation_params = []
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_DiamCylFunc,tuple(), state, None, None)
91       
92    def clone(self):
93        """ Return a identical copy of self """
94        return self._clone(DiamCylFunc())   
95       
96   
97    def run(self, x=0.0):
98        """
99        Evaluate the model
100       
101        :param x: input q, or [q,phi]
102       
103        :return: scattering function P(q)
104       
105        """
106       
107        return CDiamCylFunc.run(self, x)
108   
109    def runXY(self, x=0.0):
110        """
111        Evaluate the model in cartesian coordinates
112       
113        :param x: input q, or [qx, qy]
114       
115        :return: scattering function P(q)
116       
117        """
118       
119        return CDiamCylFunc.runXY(self, x)
120       
121    def evalDistribution(self, x=[]):
122        """
123        Evaluate the model in cartesian coordinates
124       
125        :param x: input q[], or [qx[], qy[]]
126       
127        :return: scattering function P(q[])
128       
129        """
130        return CDiamCylFunc.evalDistribution(self, x)
131       
132    def calculate_ER(self):
133        """
134        Calculate the effective radius for P(q)*S(q)
135       
136        :return: the value of the effective radius
137       
138        """       
139        return CDiamCylFunc.calculate_ER(self)
140       
141    def set_dispersion(self, parameter, dispersion):
142        """
143        Set the dispersion object for a model parameter
144       
145        :param parameter: name of the parameter [string]
146        :param dispersion: dispersion object of type DispersionModel
147       
148        """
149        return CDiamCylFunc.set_dispersion(self, parameter, dispersion.cdisp)
150       
151   
152# End of file
Note: See TracBrowser for help on using the repository browser.