source: sasview/sansmodels/src/sans/models/FlexCylEllipXModel.py @ fb071900

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 fb071900 was ec658c85, checked in by Jae Cho <jhjcho@…>, 15 years ago

python files of new models and unit tests

  • Property mode set to 100644
File size: 4.8 KB
Line 
1#!/usr/bin/env python
2"""
3        This software was developed by the University of Tennessee as part of the
4        Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
5        project funded by the US National Science Foundation.
6
7        If you use DANSE applications to do scientific research that leads to
8        publication, we ask that you acknowledge the use of the software with the
9        following sentence:
10
11        "This work benefited from DANSE software developed under NSF award DMR-0520547."
12
13        copyright 2008, University of Tennessee
14"""
15
16""" Provide functionality for a C extension model
17
18        WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
19                 DO NOT MODIFY THIS FILE, MODIFY ..\c_extensions\flexcyl_ellipX.h
20                 AND RE-RUN THE GENERATOR SCRIPT
21
22"""
23
24from sans.models.BaseComponent import BaseComponent
25from sans_extension.c_models import CFlexCylEllipXModel
26import copy   
27   
28class FlexCylEllipXModel(CFlexCylEllipXModel, BaseComponent):
29    """ Class that evaluates a FlexCylEllipXModel model.
30        This file was auto-generated from ..\c_extensions\flexcyl_ellipX.h.
31        Refer to that file and the structure it contains
32        for details of the model.
33        List of default parameters:
34         scale           = 1.0
35         length          = 1000.0 [A]
36         kuhn_length     = 100.0 [A]
37         radius          = 20.0 [A]
38         axis_ratio      = 1.5
39         sldCyl          = 1e-006 [1/A^(2)]
40         sldSolv         = 6.3e-006 [1/A^(2)]
41         background      = 0.0001 [1/cm]
42
43    """
44       
45    def __init__(self):
46        """ Initialization """
47       
48        # Initialize BaseComponent first, then sphere
49        BaseComponent.__init__(self)
50        CFlexCylEllipXModel.__init__(self)
51       
52        ## Name of the model
53        self.name = "FlexCylEllipXModel"
54        ## Model description
55        self.description =""" Note : scale and contrast=sldCyl-sldSolv are both multiplicative factors in the
56                model and are perfectly correlated. One or
57                both of these parameters must be held fixed
58                during model fitting."""
59       
60        ## Parameter details [units, min, max]
61        self.details = {}
62        self.details['scale'] = ['', None, None]
63        self.details['length'] = ['[A]', None, None]
64        self.details['kuhn_length'] = ['[A]', None, None]
65        self.details['radius'] = ['[A]', None, None]
66        self.details['axis_ratio'] = ['', None, None]
67        self.details['sldCyl'] = ['[1/A^(2)]', None, None]
68        self.details['sldSolv'] = ['[1/A^(2)]', None, None]
69        self.details['background'] = ['[1/cm]', None, None]
70
71        ## fittable parameters
72        self.fixed=['length.width', 'kuhn_length.width', 'radius.width', 'axis_ratio.width']
73       
74        ## parameters with orientation
75        self.orientation_params =[]
76   
77    def clone(self):
78        """ Return a identical copy of self """
79        return self._clone(FlexCylEllipXModel())   
80       
81    def __getstate__(self):
82        """ return object state for pickling and copying """
83        model_state = {'params': self.params, 'dispersion': self.dispersion, 'log': self.log}
84       
85        return self.__dict__, model_state
86       
87    def __setstate__(self, state):
88        """ create object from pickled state """
89       
90        self.__dict__, model_state = state
91        self.params = model_state['params']
92        self.dispersion = model_state['dispersion']
93        self.log = model_state['log']
94       
95   
96    def run(self, x = 0.0):
97        """ Evaluate the model
98            @param x: input q, or [q,phi]
99            @return: scattering function P(q)
100        """
101       
102        return CFlexCylEllipXModel.run(self, x)
103   
104    def runXY(self, x = 0.0):
105        """ Evaluate the model in cartesian coordinates
106            @param x: input q, or [qx, qy]
107            @return: scattering function P(q)
108        """
109       
110        return CFlexCylEllipXModel.runXY(self, x)
111       
112    def evalDistribution(self, x = []):
113        """ Evaluate the model in cartesian coordinates
114            @param x: input q[], or [qx[], qy[]]
115            @return: scattering function P(q[])
116        """
117        return CFlexCylEllipXModel.evalDistribution(self, x)
118       
119    def calculate_ER(self):
120        """ Calculate the effective radius for P(q)*S(q)
121            @return: the value of the effective radius
122        """       
123        return CFlexCylEllipXModel.calculate_ER(self)
124       
125    def set_dispersion(self, parameter, dispersion):
126        """
127            Set the dispersion object for a model parameter
128            @param parameter: name of the parameter [string]
129            @dispersion: dispersion object of type DispersionModel
130        """
131        return CFlexCylEllipXModel.set_dispersion(self, parameter, dispersion.cdisp)
132       
133   
134# End of file
Note: See TracBrowser for help on using the repository browser.