source: sasview/sansmodels/src/sans/models/CoreShellModel.py @ d37ba31

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 d37ba31 was 1ed3834, checked in by Jae Cho <jhjcho@…>, 16 years ago

unit symbol Angst. back to A and re-organized model descriptions

  • Property mode set to 100644
File size: 3.7 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\core_shell.h
20                 AND RE-RUN THE GENERATOR SCRIPT
21
22"""
23
24from sans.models.BaseComponent import BaseComponent
25from sans_extension.c_models import CCoreShellModel
26import copy   
27   
28class CoreShellModel(CCoreShellModel, BaseComponent):
29    """ Class that evaluates a CoreShellModel model.
30        This file was auto-generated from ..\c_extensions\core_shell.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          = 60.0 [A]
36         thickness       = 10.0 [A]
37         core_sld        = 1e-006 [1/A²]
38         shell_sld       = 2e-006 [1/A²]
39         solvent_sld     = 3e-006 [1/A²]
40         background      = 0.0 [1/cm]
41
42    """
43       
44    def __init__(self):
45        """ Initialization """
46       
47        # Initialize BaseComponent first, then sphere
48        BaseComponent.__init__(self)
49        CCoreShellModel.__init__(self)
50       
51        ## Name of the model
52        self.name = "CoreShellModel"
53        ## Model description
54        self.description ="""Form factor for a monodisperse spherical particle with particle
55                with a core-shell structure:
56               
57                The form factor is normalized by the
58                total particle volume.
59               
60                radius: core radius, thickness: shell thickness
61               
62                Ref: Guinier, A. and G. Fournet,
63                John Wiley and Sons, New York, 1955."""
64       
65                ## Parameter details [units, min, max]
66        self.details = {}
67        self.details['scale'] = ['', None, None]
68        self.details['radius'] = ['[A]', None, None]
69        self.details['thickness'] = ['[A]', None, None]
70        self.details['core_sld'] = ['[1/A²]', None, None]
71        self.details['shell_sld'] = ['[1/A²]', None, None]
72        self.details['solvent_sld'] = ['[1/A²]', None, None]
73        self.details['background'] = ['[1/cm]', None, None]
74
75                ## fittable parameters
76        self.fixed=['thickness.width', 'radius.width']
77       
78        ## parameters with orientation
79        self.orientation_params =[]
80   
81    def clone(self):
82        """ Return a identical copy of self """
83        return self._clone(CoreShellModel())   
84   
85    def run(self, x = 0.0):
86        """ Evaluate the model
87            @param x: input q, or [q,phi]
88            @return: scattering function P(q)
89        """
90       
91        return CCoreShellModel.run(self, x)
92   
93    def runXY(self, x = 0.0):
94        """ Evaluate the model in cartesian coordinates
95            @param x: input q, or [qx, qy]
96            @return: scattering function P(q)
97        """
98       
99        return CCoreShellModel.runXY(self, x)
100       
101    def set_dispersion(self, parameter, dispersion):
102        """
103            Set the dispersion object for a model parameter
104            @param parameter: name of the parameter [string]
105            @dispersion: dispersion object of type DispersionModel
106        """
107        return CCoreShellModel.set_dispersion(self, parameter, dispersion.cdisp)
108       
109   
110# End of file
Note: See TracBrowser for help on using the repository browser.