source: sasview/sansmodels/src/sans/models/LamellarPSHGModel.py @ d8f3cd8

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

commit wrap model

  • Property mode set to 100644
File size: 6.1 KB
RevLine 
[27a0771]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##############################################################################
[27a0771]16
17
[79ac6f8]18"""
19Provide functionality for a C extension model
[27a0771]20
[79ac6f8]21:WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
22         DO NOT MODIFY THIS FILE, MODIFY ..\c_extensions\lamellarPS_HG.h
23         AND RE-RUN THE GENERATOR SCRIPT
[27a0771]24
25"""
26
27from sans.models.BaseComponent import BaseComponent
[92df66f8]28from sans.models.sans_extension.c_models import CLamellarPSHGModel
[27a0771]29import copy   
[96656e3]30
31def create_LamellarPSHGModel():
32    obj = LamellarPSHGModel()
33    #CLamellarPSHGModel.__init__(obj) is called by LamellarPSHGModel constructor
34    return obj
35
[27a0771]36class LamellarPSHGModel(CLamellarPSHGModel, BaseComponent):
[79ac6f8]37    """
38    Class that evaluates a LamellarPSHGModel model.
39    This file was auto-generated from ..\c_extensions\lamellarPS_HG.h.
40    Refer to that file and the structure it contains
41    for details of the model.
42    List of default parameters:
[27a0771]43         scale           = 1.0
44         spacing         = 40.0 [A]
45         deltaT          = 10.0 [A]
46         deltaH          = 2.0 [A]
[92df66f8]47         sld_tail        = 4e-07 [1/A^(2)]
48         sld_head        = 2e-06 [1/A^(2)]
49         sld_solvent     = 6e-06 [1/A^(2)]
[27a0771]50         n_plates        = 30.0
51         caille          = 0.001
52         background      = 0.001 [1/cm]
53
54    """
55       
56    def __init__(self):
57        """ Initialization """
58       
59        # Initialize BaseComponent first, then sphere
60        BaseComponent.__init__(self)
[96656e3]61        #apply(CLamellarPSHGModel.__init__, (self,))
[27a0771]62        CLamellarPSHGModel.__init__(self)
63       
64        ## Name of the model
65        self.name = "LamellarPSHGModel"
66        ## Model description
[9188cc1]67        self.description ="""[Concentrated Lamellar (head+tail) Form Factor]: Calculates the
68                intensity from a lyotropic lamellar phase.
69                The intensity (form factor and structure factor)
70                calculated is for lamellae of two-layer scattering
71                length density that are randomly distributed in
72                solution (a powder average). The scattering
73                length density of the tail region, headgroup
74                region, and solvent are taken to be different.
75                The model can also be applied to large,
76                multi-lamellar vesicles.
77                No resolution smeared version is included
78                in the structure factor of this model.
79                *Parameters: spacing = repeat spacing,
80                deltaT = tail length,
81                deltaH = headgroup thickness,
82                n_plates = # of Lamellar plates
83                caille = Caille parameter (<0.8 or <1)
84                background = incoherent bgd
85                scale = scale factor ..."""
[27a0771]86       
[fe9c19b4]87        ## Parameter details [units, min, max]
[27a0771]88        self.details = {}
89        self.details['scale'] = ['', None, None]
90        self.details['spacing'] = ['[A]', None, None]
91        self.details['deltaT'] = ['[A]', None, None]
92        self.details['deltaH'] = ['[A]', None, None]
[27972c1d]93        self.details['sld_tail'] = ['[1/A^(2)]', None, None]
94        self.details['sld_head'] = ['[1/A^(2)]', None, None]
95        self.details['sld_solvent'] = ['[1/A^(2)]', None, None]
[27a0771]96        self.details['n_plates'] = ['', None, None]
97        self.details['caille'] = ['', None, None]
98        self.details['background'] = ['[1/cm]', None, None]
99
[fe9c19b4]100        ## fittable parameters
[9188cc1]101        self.fixed=['deltaT.width', 'deltaH.width', 'spacing.width']
[27a0771]102       
[35aface]103        ## non-fittable parameters
[96656e3]104        self.non_fittable = []
[35aface]105       
[27a0771]106        ## parameters with orientation
[96656e3]107        self.orientation_params = []
[c7a7e1b]108
109    def __setstate__(self, state):
110        """
111        restore the state of a model from pickle
112        """
113        self.__dict__, self.params, self.dispersion = state
114       
[96656e3]115    def __reduce_ex__(self, proto):
[79ac6f8]116        """
[96656e3]117        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
118        c model.
[79ac6f8]119        """
[c7a7e1b]120        state = (self.__dict__, self.params, self.dispersion)
121        return (create_LamellarPSHGModel,tuple(), state, None, None)
[fe9c19b4]122       
[96656e3]123    def clone(self):
124        """ Return a identical copy of self """
125        return self._clone(LamellarPSHGModel())   
[fe9c19b4]126       
[27a0771]127   
[79ac6f8]128    def run(self, x=0.0):
129        """
130        Evaluate the model
131       
132        :param x: input q, or [q,phi]
133       
134        :return: scattering function P(q)
135       
[27a0771]136        """
137       
138        return CLamellarPSHGModel.run(self, x)
139   
[79ac6f8]140    def runXY(self, x=0.0):
141        """
142        Evaluate the model in cartesian coordinates
143       
144        :param x: input q, or [qx, qy]
145       
146        :return: scattering function P(q)
147       
[27a0771]148        """
149       
150        return CLamellarPSHGModel.runXY(self, x)
151       
[79ac6f8]152    def evalDistribution(self, x=[]):
153        """
154        Evaluate the model in cartesian coordinates
155       
156        :param x: input q[], or [qx[], qy[]]
157       
158        :return: scattering function P(q[])
159       
[870f131]160        """
[f9a1279]161        return CLamellarPSHGModel.evalDistribution(self, x)
[870f131]162       
[5eb9154]163    def calculate_ER(self):
[79ac6f8]164        """
165        Calculate the effective radius for P(q)*S(q)
166       
167        :return: the value of the effective radius
168       
[5eb9154]169        """       
170        return CLamellarPSHGModel.calculate_ER(self)
171       
[27a0771]172    def set_dispersion(self, parameter, dispersion):
173        """
[79ac6f8]174        Set the dispersion object for a model parameter
175       
176        :param parameter: name of the parameter [string]
177        :param dispersion: dispersion object of type DispersionModel
178       
[27a0771]179        """
180        return CLamellarPSHGModel.set_dispersion(self, parameter, dispersion.cdisp)
181       
182   
183# End of file
Note: See TracBrowser for help on using the repository browser.