source: sasview/sansmodels/src/sans/models/HollowCylinderModel.py @ 14ecd871

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 14ecd871 was 92df66f8, checked in by Gervaise Alina <gervyh@…>, 13 years ago

commit wrap model

  • Property mode set to 100644
File size: 5.6 KB
RevLine 
[793c988]1#!/usr/bin/env python
2
[79ac6f8]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##############################################################################
[793c988]16
17
[79ac6f8]18"""
19Provide functionality for a C extension model
[793c988]20
[79ac6f8]21:WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
22         DO NOT MODIFY THIS FILE, MODIFY ..\c_extensions\hollow_cylinder.h
23         AND RE-RUN THE GENERATOR SCRIPT
[793c988]24
25"""
26
27from sans.models.BaseComponent import BaseComponent
[92df66f8]28from sans.models.sans_extension.c_models import CHollowCylinderModel
[793c988]29import copy   
[96656e3]30
31def create_HollowCylinderModel():
32    obj = HollowCylinderModel()
33    #CHollowCylinderModel.__init__(obj) is called by HollowCylinderModel constructor
34    return obj
35
[793c988]36class HollowCylinderModel(CHollowCylinderModel, BaseComponent):
[79ac6f8]37    """
38    Class that evaluates a HollowCylinderModel model.
39    This file was auto-generated from ..\c_extensions\hollow_cylinder.h.
40    Refer to that file and the structure it contains
41    for details of the model.
42    List of default parameters:
[793c988]43         scale           = 1.0
44         core_radius     = 20.0 [A]
[e2afadf]45         radius          = 30.0 [A]
[793c988]46         length          = 400.0 [A]
[92df66f8]47         sldCyl          = 6.3e-06 [1/A^(2)]
48         sldSolv         = 1e-06 [1/A^(2)]
[793c988]49         background      = 0.01 [1/cm]
[4628e31]50         axis_theta      = 90.0 [deg]
51         axis_phi        = 0.0 [deg]
[793c988]52
53    """
54       
55    def __init__(self):
56        """ Initialization """
57       
58        # Initialize BaseComponent first, then sphere
59        BaseComponent.__init__(self)
[96656e3]60        #apply(CHollowCylinderModel.__init__, (self,))
[793c988]61        CHollowCylinderModel.__init__(self)
62       
63        ## Name of the model
64        self.name = "HollowCylinderModel"
65        ## Model description
[7ad9887]66        self.description =""" P(q) = scale*<f*f>/Vol + bkg, where f is the scattering amplitude.
67                core_radius = the radius of core
68                radius = the radius of shell
69                length = the total length of the cylinder
[f10063e]70                sldCyl = SLD of the shell
71                sldSolv = SLD of the solvent
[7ad9887]72                background = incoherent background"""
[793c988]73       
[fe9c19b4]74        ## Parameter details [units, min, max]
[793c988]75        self.details = {}
76        self.details['scale'] = ['', None, None]
77        self.details['core_radius'] = ['[A]', None, None]
[e2afadf]78        self.details['radius'] = ['[A]', None, None]
[793c988]79        self.details['length'] = ['[A]', None, None]
[f10063e]80        self.details['sldCyl'] = ['[1/A^(2)]', None, None]
81        self.details['sldSolv'] = ['[1/A^(2)]', None, None]
[793c988]82        self.details['background'] = ['[1/cm]', None, None]
[4628e31]83        self.details['axis_theta'] = ['[deg]', None, None]
84        self.details['axis_phi'] = ['[deg]', None, None]
[793c988]85
[fe9c19b4]86        ## fittable parameters
[e2afadf]87        self.fixed=['axis_phi.width', 'axis_theta.width', 'length.width', 'core_radius.width', 'radius']
[793c988]88       
[35aface]89        ## non-fittable parameters
[96656e3]90        self.non_fittable = []
[35aface]91       
[793c988]92        ## parameters with orientation
[96656e3]93        self.orientation_params = ['axis_phi', 'axis_theta', 'axis_phi.width', 'axis_theta.width']
[c7a7e1b]94
95    def __setstate__(self, state):
96        """
97        restore the state of a model from pickle
98        """
99        self.__dict__, self.params, self.dispersion = state
100       
[96656e3]101    def __reduce_ex__(self, proto):
[79ac6f8]102        """
[96656e3]103        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
104        c model.
[79ac6f8]105        """
[c7a7e1b]106        state = (self.__dict__, self.params, self.dispersion)
107        return (create_HollowCylinderModel,tuple(), state, None, None)
[fe9c19b4]108       
[96656e3]109    def clone(self):
110        """ Return a identical copy of self """
111        return self._clone(HollowCylinderModel())   
[fe9c19b4]112       
[793c988]113   
[79ac6f8]114    def run(self, x=0.0):
115        """
116        Evaluate the model
117       
118        :param x: input q, or [q,phi]
119       
120        :return: scattering function P(q)
121       
[793c988]122        """
123       
124        return CHollowCylinderModel.run(self, x)
125   
[79ac6f8]126    def runXY(self, x=0.0):
127        """
128        Evaluate the model in cartesian coordinates
129       
130        :param x: input q, or [qx, qy]
131       
132        :return: scattering function P(q)
133       
[793c988]134        """
135       
136        return CHollowCylinderModel.runXY(self, x)
137       
[79ac6f8]138    def evalDistribution(self, x=[]):
139        """
140        Evaluate the model in cartesian coordinates
141       
142        :param x: input q[], or [qx[], qy[]]
143       
144        :return: scattering function P(q[])
145       
[9bd69098]146        """
[f9a1279]147        return CHollowCylinderModel.evalDistribution(self, x)
[9bd69098]148       
[5eb9154]149    def calculate_ER(self):
[79ac6f8]150        """
151        Calculate the effective radius for P(q)*S(q)
152       
153        :return: the value of the effective radius
154       
[5eb9154]155        """       
156        return CHollowCylinderModel.calculate_ER(self)
157       
[793c988]158    def set_dispersion(self, parameter, dispersion):
159        """
[79ac6f8]160        Set the dispersion object for a model parameter
161       
162        :param parameter: name of the parameter [string]
163        :param dispersion: dispersion object of type DispersionModel
164       
[793c988]165        """
166        return CHollowCylinderModel.set_dispersion(self, parameter, dispersion.cdisp)
167       
168   
169# End of file
Note: See TracBrowser for help on using the repository browser.