source: sasview/sansmodels/src/sans/models/LamellarPSModel.py @ 43aef76

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 43aef76 was c7a7e1b, checked in by Gervaise Alina <gervyh@…>, 13 years ago

working on model pickle

  • Property mode set to 100644
File size: 5.8 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.h
23         AND RE-RUN THE GENERATOR SCRIPT
[27a0771]24
25"""
26
27from sans.models.BaseComponent import BaseComponent
28from sans_extension.c_models import CLamellarPSModel
29import copy   
[96656e3]30
31def create_LamellarPSModel():
32    obj = LamellarPSModel()
33    #CLamellarPSModel.__init__(obj) is called by LamellarPSModel constructor
34    return obj
35
[27a0771]36class LamellarPSModel(CLamellarPSModel, BaseComponent):
[79ac6f8]37    """
38    Class that evaluates a LamellarPSModel model.
39    This file was auto-generated from ..\c_extensions\lamellarPS.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         = 400.0 [A]
45         delta           = 30.0 [A]
[f10063e]46         sld_bi          = 6.3e-006 [1/A^(2)]
47         sld_sol         = 1e-006 [1/A^(2)]
[27a0771]48         n_plates        = 20.0
49         caille          = 0.1
50         background      = 0.0 [1/cm]
51
52    """
53       
54    def __init__(self):
55        """ Initialization """
56       
57        # Initialize BaseComponent first, then sphere
58        BaseComponent.__init__(self)
[96656e3]59        #apply(CLamellarPSModel.__init__, (self,))
[27a0771]60        CLamellarPSModel.__init__(self)
61       
62        ## Name of the model
63        self.name = "LamellarPSModel"
64        ## Model description
[9188cc1]65        self.description ="""[Concentrated Lamellar Form Factor] Calculates the scattered
66                intensity from a lyotropic lamellar phase.
67                The intensity (form factor and structure
68                factor)calculated is for lamellae of
69                uniform scattering length density that
70                are randomly distributed in solution
71                (a powder average). The lamellae thickness
72                is polydisperse. The model can also
[fbe5d3e]73                be applied to large, multi-lamellar vesicles.
74                No resolution smeared version is included
75                in the structure factor of this model.
76                *Parameters: spacing = repeat spacing,
77                delta = bilayer thickness,
[f10063e]78                sld_bi = SLD_bilayer
79                sld_sol = SLD_solvent
[fbe5d3e]80                n_plate = # of Lamellar plates
81                caille = Caille parameter (<0.8 or <1)
82                background = incoherent bgd
83                scale = scale factor"""
[27a0771]84       
[fe9c19b4]85        ## Parameter details [units, min, max]
[27a0771]86        self.details = {}
87        self.details['scale'] = ['', None, None]
88        self.details['spacing'] = ['[A]', None, None]
89        self.details['delta'] = ['[A]', None, None]
[f10063e]90        self.details['sld_bi'] = ['[1/A^(2)]', None, None]
91        self.details['sld_sol'] = ['[1/A^(2)]', None, None]
[27a0771]92        self.details['n_plates'] = ['', None, None]
93        self.details['caille'] = ['', None, None]
94        self.details['background'] = ['[1/cm]', None, None]
95
[fe9c19b4]96        ## fittable parameters
[c1c29b6]97        self.fixed=['delta.width', 'spacing.width']
[27a0771]98       
[35aface]99        ## non-fittable parameters
[96656e3]100        self.non_fittable = []
[35aface]101       
[27a0771]102        ## parameters with orientation
[96656e3]103        self.orientation_params = []
[c7a7e1b]104
105    def __setstate__(self, state):
106        """
107        restore the state of a model from pickle
108        """
109        self.__dict__, self.params, self.dispersion = state
110       
[96656e3]111    def __reduce_ex__(self, proto):
[79ac6f8]112        """
[96656e3]113        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of
114        c model.
[79ac6f8]115        """
[c7a7e1b]116        state = (self.__dict__, self.params, self.dispersion)
117        return (create_LamellarPSModel,tuple(), state, None, None)
[fe9c19b4]118       
[96656e3]119    def clone(self):
120        """ Return a identical copy of self """
121        return self._clone(LamellarPSModel())   
[fe9c19b4]122       
[27a0771]123   
[79ac6f8]124    def run(self, x=0.0):
125        """
126        Evaluate the model
127       
128        :param x: input q, or [q,phi]
129       
130        :return: scattering function P(q)
131       
[27a0771]132        """
133       
134        return CLamellarPSModel.run(self, x)
135   
[79ac6f8]136    def runXY(self, x=0.0):
137        """
138        Evaluate the model in cartesian coordinates
139       
140        :param x: input q, or [qx, qy]
141       
142        :return: scattering function P(q)
143       
[27a0771]144        """
145       
146        return CLamellarPSModel.runXY(self, x)
147       
[79ac6f8]148    def evalDistribution(self, x=[]):
149        """
150        Evaluate the model in cartesian coordinates
151       
152        :param x: input q[], or [qx[], qy[]]
153       
154        :return: scattering function P(q[])
155       
[9bd69098]156        """
[f9a1279]157        return CLamellarPSModel.evalDistribution(self, x)
[9bd69098]158       
[5eb9154]159    def calculate_ER(self):
[79ac6f8]160        """
161        Calculate the effective radius for P(q)*S(q)
162       
163        :return: the value of the effective radius
164       
[5eb9154]165        """       
166        return CLamellarPSModel.calculate_ER(self)
167       
[27a0771]168    def set_dispersion(self, parameter, dispersion):
169        """
[79ac6f8]170        Set the dispersion object for a model parameter
171       
172        :param parameter: name of the parameter [string]
173        :param dispersion: dispersion object of type DispersionModel
174       
[27a0771]175        """
176        return CLamellarPSModel.set_dispersion(self, parameter, dispersion.cdisp)
177       
178   
179# End of file
Note: See TracBrowser for help on using the repository browser.