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

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 c146f092 was 27972c1d, checked in by Jae Cho <jhjcho@…>, 15 years ago

removed all non asc font in the units

  • Property mode set to 100644
File size: 4.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.h
20                 AND RE-RUN THE GENERATOR SCRIPT
21
22"""
23
24from sans.models.BaseComponent import BaseComponent
25from sans_extension.c_models import CLamellarPSModel
26import copy   
27   
28class LamellarPSModel(CLamellarPSModel, BaseComponent):
29    """ Class that evaluates a LamellarPSModel model.
30        This file was auto-generated from ..\c_extensions\lamellarPS.h.
31        Refer to that file and the structure it contains
32        for details of the model.
33        List of default parameters:
34         scale           = 1.0
35         spacing         = 400.0 [A]
36         delta           = 30.0 [A]
[27972c1d]37         contrast        = 5.3e-006 [1/A^(2)]
[27a0771]38         n_plates        = 20.0
39         caille          = 0.1
40         background      = 0.0 [1/cm]
41
42    """
43       
44    def __init__(self):
45        """ Initialization """
46       
47        # Initialize BaseComponent first, then sphere
48        BaseComponent.__init__(self)
49        CLamellarPSModel.__init__(self)
50       
51        ## Name of the model
52        self.name = "LamellarPSModel"
53        ## Model description
[9188cc1]54        self.description ="""[Concentrated Lamellar Form Factor] Calculates the scattered
55                intensity from a lyotropic lamellar phase.
56                The intensity (form factor and structure
57                factor)calculated is for lamellae of
58                uniform scattering length density that
59                are randomly distributed in solution
60                (a powder average). The lamellae thickness
61                is polydisperse. The model can also
[fbe5d3e]62                be applied to large, multi-lamellar vesicles.
63                No resolution smeared version is included
64                in the structure factor of this model.
65                *Parameters: spacing = repeat spacing,
66                delta = bilayer thickness,
67                contrast = SLD_solvent - SLD_bilayer
68                n_plate = # of Lamellar plates
69                caille = Caille parameter (<0.8 or <1)
70                background = incoherent bgd
71                scale = scale factor"""
[27a0771]72       
73                ## Parameter details [units, min, max]
74        self.details = {}
75        self.details['scale'] = ['', None, None]
76        self.details['spacing'] = ['[A]', None, None]
77        self.details['delta'] = ['[A]', None, None]
[27972c1d]78        self.details['contrast'] = ['[1/A^(2)]', None, None]
[27a0771]79        self.details['n_plates'] = ['', None, None]
80        self.details['caille'] = ['', None, None]
81        self.details['background'] = ['[1/cm]', None, None]
82
83                ## fittable parameters
[c1c29b6]84        self.fixed=['delta.width', 'spacing.width']
[27a0771]85       
86        ## parameters with orientation
87        self.orientation_params =[]
88   
89    def clone(self):
90        """ Return a identical copy of self """
91        return self._clone(LamellarPSModel())   
92   
93    def run(self, x = 0.0):
94        """ Evaluate the model
95            @param x: input q, or [q,phi]
96            @return: scattering function P(q)
97        """
98       
99        return CLamellarPSModel.run(self, x)
100   
101    def runXY(self, x = 0.0):
102        """ Evaluate the model in cartesian coordinates
103            @param x: input q, or [qx, qy]
104            @return: scattering function P(q)
105        """
106       
107        return CLamellarPSModel.runXY(self, x)
108       
[9bd69098]109    def evalDistribition(self, x = []):
110        """ Evaluate the model in cartesian coordinates
111            @param x: input q[], or [qx[], qy[]]
112            @return: scattering function P(q[])
113        """
114        return CLamellarPSModel.evalDistribition(self, x)
115       
[5eb9154]116    def calculate_ER(self):
117        """ Calculate the effective radius for P(q)*S(q)
118            @return: the value of the effective radius
119        """       
120        return CLamellarPSModel.calculate_ER(self)
121       
[27a0771]122    def set_dispersion(self, parameter, dispersion):
123        """
124            Set the dispersion object for a model parameter
125            @param parameter: name of the parameter [string]
126            @dispersion: dispersion object of type DispersionModel
127        """
128        return CLamellarPSModel.set_dispersion(self, parameter, dispersion.cdisp)
129       
130   
131# End of file
Note: See TracBrowser for help on using the repository browser.