source: sasview/sansmodels/src/sans/models/EllipsoidModel.py @ 98bfd10

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 98bfd10 was 988130c6, checked in by Gervaise Alina <gervyh@…>, 16 years ago

self.fixed field added in models but need to change wrapper generator

  • Property mode set to 100644
File size: 3.9 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/ellipsoid.h
20                 AND RE-RUN THE GENERATOR SCRIPT
21
22"""
23
24from sans.models.BaseComponent import BaseComponent
25from sans_extension.c_models import CEllipsoidModel
26import copy   
27   
28class EllipsoidModel(CEllipsoidModel, BaseComponent):
29    """ Class that evaluates a EllipsoidModel model.
30        This file was auto-generated from ../c_extensions/ellipsoid.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         radius_a        = 20.0 A
36         radius_b        = 400.0 A
37         contrast        = 3e-006 A-2
38         background      = 0.0 cm-1
39         axis_theta      = 1.57 rad
40         axis_phi        = 0.0 rad
41
42    """
43       
44    def __init__(self):
45        """ Initialization """
46       
47        # Initialize BaseComponent first, then sphere
48        BaseComponent.__init__(self)
49        CEllipsoidModel.__init__(self)
50       
51        ## Name of the model
52        self.name = "EllipsoidModel"
53        self.description =""""P(q.alpha)= scale*f(q)^(2)+ bkg\n\
54                f(q)= 3*(scatter_sld- scatter_solvent)*V*[sin(q*r(Ra,Rb,alpha)) - q*r*cos(qr(Ra,Rb,alpha))]
55                /[qr(Ra,Rb,alpha)]^(3)"
56                r(Ra,Rb,alpha)= [Rb^(2)*(sin(alpha))^(2) + Ra^(2)*(cos(alpha))^(2)]^(1/2)
57                scatter_sld: scattering length density of the scatter
58                solvent_sld: scattering length density of the solvent
59                V: volune of the Eliipsoid
60                Ra: radius along the rotation axis of the Ellipsoid
61                Rb: radius perpendicular to the rotation axis of the ellipsoid"""
62                ## Parameter details [units, min, max]
63        self.details = {}
64        self.details['scale'] = ['', None, None]
65        self.details['radius_a'] = ['A', None, None]
66        self.details['radius_b'] = ['A', None, None]
67        self.details['contrast'] = ['A-2', None, None]
68        self.details['background'] = ['cm-1', None, None]
69        self.details['axis_theta'] = ['rad', None, None]
70        self.details['axis_phi'] = ['rad', None, None]
71        # fixed paramaters
72        self.fixed=['axis_phi.npts','axis_phi.nsigmas',
73                                    'axis_theta.npts','axis_theta.nsigmas',
74                                    'radius_a.npts','radius_a.nsigmas',
75                                    'radius_b.npts','radius_b.nsigmas' ]
76   
77    def clone(self):
78        """ Return a identical copy of self """
79        return self._clone(EllipsoidModel())   
80   
81    def run(self, x = 0.0):
82        """ Evaluate the model
83            @param x: input q, or [q,phi]
84            @return: scattering function P(q)
85        """
86       
87        return CEllipsoidModel.run(self, x)
88   
89    def runXY(self, x = 0.0):
90        """ Evaluate the model in cartesian coordinates
91            @param x: input q, or [qx, qy]
92            @return: scattering function P(q)
93        """
94       
95        return CEllipsoidModel.runXY(self, x)
96       
97    def set_dispersion(self, parameter, dispersion):
98        """
99            Set the dispersion object for a model parameter
100            @param parameter: name of the parameter [string]
101            @dispersion: dispersion object of type DispersionModel
102        """
103        return CEllipsoidModel.set_dispersion(self, parameter, dispersion.cdisp)
104       
105   
106# End of file
Note: See TracBrowser for help on using the repository browser.