source: sasview/sansmodels/src/sans/models/LamellarFFHGModel.py @ 916f5c0

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 916f5c0 was b1c3295, checked in by Mathieu Doucet <doucetm@…>, 13 years ago

Re #4 This should clean up a whole bunch of C++ warnings.

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