[ae3ce4e] | 1 | #!/usr/bin/env python |
---|
[95986b5] | 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 | |
---|
[ae3ce4e] | 16 | """ Provide functionality for a C extension model |
---|
| 17 | |
---|
| 18 | WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY |
---|
[836fe6e] | 19 | DO NOT MODIFY THIS FILE, MODIFY ..\c_extensions\ellipsoid.h |
---|
[ae3ce4e] | 20 | AND RE-RUN THE GENERATOR SCRIPT |
---|
| 21 | |
---|
| 22 | """ |
---|
| 23 | |
---|
| 24 | from sans.models.BaseComponent import BaseComponent |
---|
| 25 | from sans_extension.c_models import CEllipsoidModel |
---|
| 26 | import copy |
---|
| 27 | |
---|
| 28 | class EllipsoidModel(CEllipsoidModel, BaseComponent): |
---|
| 29 | """ Class that evaluates a EllipsoidModel model. |
---|
[836fe6e] | 30 | This file was auto-generated from ..\c_extensions\ellipsoid.h. |
---|
[ae3ce4e] | 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 |
---|
[1ed3834] | 35 | radius_a = 20.0 [A] |
---|
| 36 | radius_b = 400.0 [A] |
---|
| 37 | contrast = 3e-006 [1/A²] |
---|
[0824909] | 38 | background = 0.0 [1/cm] |
---|
| 39 | axis_theta = 1.57 [rad] |
---|
| 40 | axis_phi = 0.0 [rad] |
---|
[ae3ce4e] | 41 | |
---|
| 42 | """ |
---|
| 43 | |
---|
| 44 | def __init__(self): |
---|
| 45 | """ Initialization """ |
---|
| 46 | |
---|
| 47 | # Initialize BaseComponent first, then sphere |
---|
| 48 | BaseComponent.__init__(self) |
---|
| 49 | CEllipsoidModel.__init__(self) |
---|
| 50 | |
---|
| 51 | ## Name of the model |
---|
| 52 | self.name = "EllipsoidModel" |
---|
[836fe6e] | 53 | ## Model description |
---|
[1ed3834] | 54 | self.description =""""P(q.alpha)= scale*f(q)^(2)+ bkg, where f(q)= 3*(scatter_sld |
---|
| 55 | - scatter_solvent)*V*[sin(q*r(Ra,Rb,alpha)) |
---|
| 56 | -q*r*cos(qr(Ra,Rb,alpha))] |
---|
[9316609] | 57 | /[qr(Ra,Rb,alpha)]^(3)" |
---|
[1ed3834] | 58 | |
---|
[0824909] | 59 | r(Ra,Rb,alpha)= [Rb^(2)*(sin(alpha))^(2) |
---|
| 60 | + Ra^(2)*(cos(alpha))^(2)]^(1/2) |
---|
[1ed3834] | 61 | |
---|
| 62 | scatter_sld: SLD of the scatter |
---|
| 63 | solvent_sld: SLD of the solvent |
---|
| 64 | contrast: SLD difference between scatter |
---|
| 65 | and solvent |
---|
[9316609] | 66 | V: volune of the Eliipsoid |
---|
[1ed3834] | 67 | Ra: radius along the rotation axis |
---|
| 68 | of the Ellipsoid |
---|
| 69 | Rb: radius perpendicular to the |
---|
| 70 | rotation axis of the ellipsoid""" |
---|
[836fe6e] | 71 | |
---|
[ae3ce4e] | 72 | ## Parameter details [units, min, max] |
---|
| 73 | self.details = {} |
---|
| 74 | self.details['scale'] = ['', None, None] |
---|
[1ed3834] | 75 | self.details['radius_a'] = ['[A]', None, None] |
---|
| 76 | self.details['radius_b'] = ['[A]', None, None] |
---|
| 77 | self.details['contrast'] = ['[1/A²]', None, None] |
---|
[0824909] | 78 | self.details['background'] = ['[1/cm]', None, None] |
---|
| 79 | self.details['axis_theta'] = ['[rad]', None, None] |
---|
| 80 | self.details['axis_phi'] = ['[rad]', None, None] |
---|
[836fe6e] | 81 | |
---|
| 82 | ## fittable parameters |
---|
[25a608f5] | 83 | self.fixed=['axis_phi.width', 'axis_theta.width', 'radius_a.width', 'radius_b.width', 'length.width', 'r_minor.width'] |
---|
| 84 | |
---|
| 85 | ## parameters with orientation |
---|
| 86 | self.orientation_params =['axis_phi.width', 'axis_theta.width', 'axis_phi', 'axis_theta'] |
---|
[ae3ce4e] | 87 | |
---|
| 88 | def clone(self): |
---|
| 89 | """ Return a identical copy of self """ |
---|
[95986b5] | 90 | return self._clone(EllipsoidModel()) |
---|
[ae3ce4e] | 91 | |
---|
| 92 | def run(self, x = 0.0): |
---|
| 93 | """ Evaluate the model |
---|
| 94 | @param x: input q, or [q,phi] |
---|
| 95 | @return: scattering function P(q) |
---|
| 96 | """ |
---|
| 97 | |
---|
| 98 | return CEllipsoidModel.run(self, x) |
---|
| 99 | |
---|
| 100 | def runXY(self, x = 0.0): |
---|
| 101 | """ Evaluate the model in cartesian coordinates |
---|
| 102 | @param x: input q, or [qx, qy] |
---|
| 103 | @return: scattering function P(q) |
---|
| 104 | """ |
---|
| 105 | |
---|
| 106 | return CEllipsoidModel.runXY(self, x) |
---|
[95986b5] | 107 | |
---|
[9bd69098] | 108 | def evalDistribition(self, x = []): |
---|
| 109 | """ Evaluate the model in cartesian coordinates |
---|
| 110 | @param x: input q[], or [qx[], qy[]] |
---|
| 111 | @return: scattering function P(q[]) |
---|
| 112 | """ |
---|
| 113 | return CEllipsoidModel.evalDistribition(self, x) |
---|
| 114 | |
---|
[5eb9154] | 115 | def calculate_ER(self): |
---|
| 116 | """ Calculate the effective radius for P(q)*S(q) |
---|
| 117 | @return: the value of the effective radius |
---|
| 118 | """ |
---|
| 119 | return CEllipsoidModel.calculate_ER(self) |
---|
| 120 | |
---|
[95986b5] | 121 | def set_dispersion(self, parameter, dispersion): |
---|
| 122 | """ |
---|
| 123 | Set the dispersion object for a model parameter |
---|
| 124 | @param parameter: name of the parameter [string] |
---|
| 125 | @dispersion: dispersion object of type DispersionModel |
---|
| 126 | """ |
---|
| 127 | return CEllipsoidModel.set_dispersion(self, parameter, dispersion.cdisp) |
---|
| 128 | |
---|
[ae3ce4e] | 129 | |
---|
| 130 | # End of file |
---|