source: sasview/sansmodels/src/sans/models/NewCylinderModel.py @ 2c63e80e

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 2c63e80e was 988130c6, checked in by Gervaise Alina <gervyh@…>, 16 years ago

self.fixed field added in models but need to change wrapper generator

  • 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/cylinder.h
20                 AND RE-RUN THE GENERATOR SCRIPT
21
22"""
23
24from sans.models.BaseModel import BaseModel, Parameter, ParameterProperty
25from sans_extension.c_models import CCylinderModel
26import copy   
27   
28class CylinderModel(CCylinderModel, BaseModel):
29    """ Class that evaluates a CylinderModel model.
30        This file was auto-generated from ../c_extensions/cylinder.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         radius          = 20.0 A
36         length          = 400.0 A
37         contrast        = 3e-006 A-2
38         background      = 0.0 cm-1
39         cyl_theta       = 1.0 rad
40         cyl_phi         = 1.0 rad
41
42    """
43    scale      = ParameterProperty('scale')
44    radius     = ParameterProperty('radius')
45    length     = ParameterProperty('length')
46    contrast   = ParameterProperty('contrast')
47    background = ParameterProperty('background')
48    cyl_theta  = ParameterProperty('cyl_theta')
49    cyl_phi    = ParameterProperty('cyl_phi')
50       
51    def __init__(self):
52        """ Initialization """
53       
54        # Initialize BaseComponent first, then sphere
55        CCylinderModel.__init__(self)
56        BaseModel.__init__(self)
57       
58        ## Name of the model
59        self.name = "CylinderModel"
60
61                ## Parameter details [units, min, max]
62        self.details = {}
63        self.details['scale'] = ['', None, None]
64        self.details['radius'] = ['A', None, None]
65        self.details['length'] = ['A', None, None]
66        self.details['contrast'] = ['A-2', None, None]
67        self.details['background'] = ['cm-1', None, None]
68        self.details['cyl_theta'] = ['rad', None, None]
69        self.details['cyl_phi'] = ['rad', None, None]
70        #list of parameter that cannot be fitted
71        self.fixed= []
72        # The C models have a self.params dictionary
73        for item in self.params:
74            self.parameters[item] = Parameter(item, self.params[item])
75
76    def clone(self):
77        """ Return a identical copy of self """
78        obj = CylinderModel()
79        obj.params = copy.deepcopy(self.params)
80        return obj   
81   
82    def run(self, x = 0.0):
83        """ Evaluate the model
84            @param x: input q, or [q,phi]
85            @return: scattering function P(q)
86        """
87       
88        return CCylinderModel.run(self, x)
89   
90    def runXY(self, x = 0.0):
91        """ Evaluate the model in cartesian coordinates
92            @param x: input q, or [qx, qy]
93            @return: scattering function P(q)
94        """
95       
96        return CCylinderModel.runXY(self, x)
97       
98    def set_dispersion(self, parameter, dispersion):
99        """
100            Set the dispersion object for a model parameter
101            @param parameter: name of the parameter [string]
102            @dispersion: dispersion object of type DispersionModel
103        """
104        return CCylinderModel.set_dispersion(self, parameter, dispersion.cdisp)
105       
106   
Note: See TracBrowser for help on using the repository browser.