source: sasview/sansmodels/src/sans/models/ParallelepipedModel.py @ 1d67243

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 1d67243 was 8e36cdd, checked in by Jae Cho <jhjcho@…>, 15 years ago

fixed and tested ppmodel 2d and cleaned it up.

  • Property mode set to 100644
File size: 4.4 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\parallelepiped.h
20                 AND RE-RUN THE GENERATOR SCRIPT
21
22"""
23
24from sans.models.BaseComponent import BaseComponent
25from sans_extension.c_models import CParallelepipedModel
26import copy   
27   
28class ParallelepipedModel(CParallelepipedModel, BaseComponent):
29    """ Class that evaluates a ParallelepipedModel model.
30        This file was auto-generated from ..\c_extensions\parallelepiped.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         short_a         = 35.0 [A]
36         short_b         = 75.0 [A]
37         long_c          = 400.0 [A]
38         contrast        = 5.3e-006 [1/A²]
39         background      = 0.0 [1/cm]
40         parallel_theta  = 0.0 [rad]
41         parallel_phi    = 0.0 [rad]
42         parallel_psi    = 0.0 [rad]
43
44    """
45       
46    def __init__(self):
47        """ Initialization """
48       
49        # Initialize BaseComponent first, then sphere
50        BaseComponent.__init__(self)
51        CParallelepipedModel.__init__(self)
52       
53        ## Name of the model
54        self.name = "ParallelepipedModel"
55        ## Model description
56        self.description =""" Form factor for a rectangular solid with uniform scattering length density.
57               
58                scale:Scale factor
59                short_a: length of short edge  [A]
60                short_b: length of another short edge [A]
61                long_c: length of long edge  of the parallelepiped [A]
62                contrast: particle_sld - solvent_sld
63                background:Incoherent Background [1/cm]"""
64       
65                ## Parameter details [units, min, max]
66        self.details = {}
67        self.details['scale'] = ['', None, None]
68        self.details['short_a'] = ['[A]', None, None]
69        self.details['short_b'] = ['[A]', None, None]
70        self.details['long_c'] = ['[A]', None, None]
71        self.details['contrast'] = ['[1/A²]', None, None]
72        self.details['background'] = ['[1/cm]', None, None]
73        self.details['parallel_theta'] = ['[rad]', None, None]
74        self.details['parallel_phi'] = ['[rad]', None, None]
75        self.details['parallel_psi'] = ['[rad]', None, None]
76
77                ## fittable parameters
78        self.fixed=['short_a.width', 'short_b.width', 'long_c.width', 'parallel_phi.width', 'parallel_psi.width', 'parallel_theta.width']
79       
80        ## parameters with orientation
81        self.orientation_params =['parallel_phi', 'parallel_psi', 'parallel_theta', 'parallel_phi.width', 'parallel_psi.width', 'parallel_theta.width']
82   
83    def clone(self):
84        """ Return a identical copy of self """
85        return self._clone(ParallelepipedModel())   
86   
87    def run(self, x = 0.0):
88        """ Evaluate the model
89            @param x: input q, or [q,phi]
90            @return: scattering function P(q)
91        """
92       
93        return CParallelepipedModel.run(self, x)
94   
95    def runXY(self, x = 0.0):
96        """ Evaluate the model in cartesian coordinates
97            @param x: input q, or [qx, qy]
98            @return: scattering function P(q)
99        """
100       
101        return CParallelepipedModel.runXY(self, x)
102       
103    def evalDistribition(self, x = []):
104        """ Evaluate the model in cartesian coordinates
105            @param x: input q[], or [qx[], qy[]]
106            @return: scattering function P(q[])
107        """
108        return CParallelepipedModel.evalDistribition(self, x)
109       
110    def set_dispersion(self, parameter, dispersion):
111        """
112            Set the dispersion object for a model parameter
113            @param parameter: name of the parameter [string]
114            @dispersion: dispersion object of type DispersionModel
115        """
116        return CParallelepipedModel.set_dispersion(self, parameter, dispersion.cdisp)
117       
118   
119# End of file
Note: See TracBrowser for help on using the repository browser.