source: sasview/sansmodels/src/sans/models/ParallelepipedModel.py @ 42f193a

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 42f193a was 5068697, checked in by Gervaise Alina <gervyh@…>, 15 years ago

add 1d models

  • Property mode set to 100644
File size: 4.1 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_edgeA     = 35.0 [A]
36         longer_edgeB    = 75.0 [A]
37         longuest_edgeC  = 400.0 [A]
38         contrast        = 5.3e-006 [1/A²]
39         background      = 0.0 [1/cm]
40         parallel_theta  = 1.0 [rad]
41         parallel_phi    = 1.0 [rad]
42
43    """
44       
45    def __init__(self):
46        """ Initialization """
47       
48        # Initialize BaseComponent first, then sphere
49        BaseComponent.__init__(self)
50        CParallelepipedModel.__init__(self)
51       
52        ## Name of the model
53        self.name = "ParallelepipedModel"
54        ## Model description
55        self.description =""" Calculates the form factor for a rectangular solid with uniform scattering length density.
56               
57                scale:Scale factor
58                short_edgeA: Shortest edge of the parallelepiped [A]
59                longer_edgeB: Longer edge of the parallelepiped [A]
60                longuest_edgeC: Longuest edge of the parallelepiped [A]
61                constrast: particle_sld - solvent_sld
62                background:Incoherent Background [1/cm]"""
63       
64                ## Parameter details [units, min, max]
65        self.details = {}
66        self.details['scale'] = ['', None, None]
67        self.details['short_edgeA'] = ['[A]', None, None]
68        self.details['longer_edgeB'] = ['[A]', None, None]
69        self.details['longuest_edgeC'] = ['[A]', None, None]
70        self.details['contrast'] = ['[1/A²]', None, None]
71        self.details['background'] = ['[1/cm]', None, None]
72        self.details['parallel_theta'] = ['[rad]', None, None]
73        self.details['parallel_phi'] = ['[rad]', None, None]
74
75                ## fittable parameters
76        self.fixed=['short_edgeA.width', 'longer_edgeB.width', 'longuest_edgeC.width', 'parallel_phi.width', 'parallel_theta.width']
77       
78        ## parameters with orientation
79        self.orientation_params =['parallel_phi', 'parallel_theta', 'parallel_phi.width', 'parallel_theta.width']
80   
81    def clone(self):
82        """ Return a identical copy of self """
83        return self._clone(ParallelepipedModel())   
84   
85    def run(self, x = 0.0):
86        """ Evaluate the model
87            @param x: input q, or [q,phi]
88            @return: scattering function P(q)
89        """
90       
91        return CParallelepipedModel.run(self, x)
92   
93    def runXY(self, x = 0.0):
94        """ Evaluate the model in cartesian coordinates
95            @param x: input q, or [qx, qy]
96            @return: scattering function P(q)
97        """
98       
99        return CParallelepipedModel.runXY(self, x)
100       
101    def set_dispersion(self, parameter, dispersion):
102        """
103            Set the dispersion object for a model parameter
104            @param parameter: name of the parameter [string]
105            @dispersion: dispersion object of type DispersionModel
106        """
107        return CParallelepipedModel.set_dispersion(self, parameter, dispersion.cdisp)
108       
109   
110# End of file
Note: See TracBrowser for help on using the repository browser.