source: sasview/sansmodels/src/sans/models/LamellarFFHGModel.py @ 96b59384

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 96b59384 was b4679de, checked in by Jae Cho <jhjcho@…>, 15 years ago

added 2d and model descpt + correction on polydisp. para.

  • Property mode set to 100644
File size: 3.7 KB
Line 
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\lamellarFF_HG.h
20                 AND RE-RUN THE GENERATOR SCRIPT
21
22"""
23
24from sans.models.BaseComponent import BaseComponent
25from sans_extension.c_models import CLamellarFFHGModel
26import copy   
27   
28class LamellarFFHGModel(CLamellarFFHGModel, BaseComponent):
29    """ Class that evaluates a LamellarFFHGModel model.
30        This file was auto-generated from ..\c_extensions\lamellarFF_HG.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         t_length        = 15.0 [A]
36         h_thickness     = 10.0 [A]
37         sld_tail        = 4e-007 [1/A²]
38         sld_head        = 3e-006 [1/A²]
39         sld_solvent     = 6e-006 [1/A²]
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        CLamellarFFHGModel.__init__(self)
50       
51        ## Name of the model
52        self.name = "LamellarFFHGModel"
53        ## Model description
54        self.description =""" Parameters: t_length = tail length, h_thickness = head thickness,
55                scale = Scale factor,
56                background = incoherent Background
57                sld_tail = tail scattering length density ,
58                sld_solvent = solvent scattering length density.
59                NOTE: The total bilayer thickness
60                = 2(h_thickness+ t_length).
61                """
62       
63                ## Parameter details [units, min, max]
64        self.details = {}
65        self.details['scale'] = ['', None, None]
66        self.details['t_length'] = ['[A]', None, None]
67        self.details['h_thickness'] = ['[A]', None, None]
68        self.details['sld_tail'] = ['[1/A²]', None, None]
69        self.details['sld_head'] = ['[1/A²]', None, None]
70        self.details['sld_solvent'] = ['[1/A²]', None, None]
71        self.details['background'] = ['[1/cm]', None, None]
72
73                ## fittable parameters
74        self.fixed=['t_length.width', 'h_thickness.width']
75       
76        ## parameters with orientation
77        self.orientation_params =[]
78   
79    def clone(self):
80        """ Return a identical copy of self """
81        return self._clone(LamellarFFHGModel())   
82   
83    def run(self, x = 0.0):
84        """ Evaluate the model
85            @param x: input q, or [q,phi]
86            @return: scattering function P(q)
87        """
88       
89        return CLamellarFFHGModel.run(self, x)
90   
91    def runXY(self, x = 0.0):
92        """ Evaluate the model in cartesian coordinates
93            @param x: input q, or [qx, qy]
94            @return: scattering function P(q)
95        """
96       
97        return CLamellarFFHGModel.runXY(self, x)
98       
99    def set_dispersion(self, parameter, dispersion):
100        """
101            Set the dispersion object for a model parameter
102            @param parameter: name of the parameter [string]
103            @dispersion: dispersion object of type DispersionModel
104        """
105        return CLamellarFFHGModel.set_dispersion(self, parameter, dispersion.cdisp)
106       
107   
108# End of file
Note: See TracBrowser for help on using the repository browser.