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

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 3cd95c8 was f9a1279, checked in by Gervaise Alina <gervyh@…>, 15 years ago

correct typo for model.distribution

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