source: sasview/sansmodels/src/sans/models/Poly_GaussCoil.py @ 83a0940

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

working on model pickle

  • Property mode set to 100644
File size: 4.9 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\polygausscoil.h
23         AND RE-RUN THE GENERATOR SCRIPT
24
25"""
26
27from sans.models.BaseComponent import BaseComponent
28from sans_extension.c_models import CPoly_GaussCoil
29import copy   
30
31def create_Poly_GaussCoil():
32    obj = Poly_GaussCoil()
33    #CPoly_GaussCoil.__init__(obj) is called by Poly_GaussCoil constructor
34    return obj
35
36class Poly_GaussCoil(CPoly_GaussCoil, BaseComponent):
37    """
38    Class that evaluates a Poly_GaussCoil model.
39    This file was auto-generated from ..\c_extensions\polygausscoil.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         rg              = 60.0 [A]
45         poly_m          = 2.0 [Mw/Mn]
46         background      = 0.001 [1/cm]
47
48    """
49       
50    def __init__(self):
51        """ Initialization """
52       
53        # Initialize BaseComponent first, then sphere
54        BaseComponent.__init__(self)
55        #apply(CPoly_GaussCoil.__init__, (self,))
56        CPoly_GaussCoil.__init__(self)
57       
58        ## Name of the model
59        self.name = "Poly_GaussCoil"
60        ## Model description
61        self.description ="""I(q)=(scale)*2*[(1+U*x)^(-1/U)+x-1]/[(1+U)*x^2] + background
62                where x = [rg^2*q^2]
63                and the polydispersity is
64                U = [M_w/M_n]-1.
65                scale = scale factor * volume fraction
66                rg = radius of gyration
67                poly_m = polydispersity of molecular weight
68                background = incoherent background"""
69       
70        ## Parameter details [units, min, max]
71        self.details = {}
72        self.details['scale'] = ['', None, None]
73        self.details['rg'] = ['[A]', None, None]
74        self.details['poly_m'] = ['[Mw/Mn]', None, None]
75        self.details['background'] = ['[1/cm]', None, None]
76
77        ## fittable parameters
78        self.fixed=[]
79       
80        ## non-fittable parameters
81        self.non_fittable = []
82       
83        ## parameters with orientation
84        self.orientation_params = []
85
86    def __setstate__(self, state):
87        """
88        restore the state of a model from pickle
89        """
90        self.__dict__, self.params, self.dispersion = state
91       
92    def __reduce_ex__(self, proto):
93        """
94        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
95        c model.
96        """
97        state = (self.__dict__, self.params, self.dispersion)
98        return (create_Poly_GaussCoil,tuple(), state, None, None)
99       
100    def clone(self):
101        """ Return a identical copy of self """
102        return self._clone(Poly_GaussCoil())   
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 CPoly_GaussCoil.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 CPoly_GaussCoil.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 CPoly_GaussCoil.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 CPoly_GaussCoil.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 CPoly_GaussCoil.set_dispersion(self, parameter, dispersion.cdisp)
158       
159   
160# End of file
Note: See TracBrowser for help on using the repository browser.