[40945a3] | 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 |
---|
[870f131] | 19 | DO NOT MODIFY THIS FILE, MODIFY ..\c_extensions\DiamEllip.h |
---|
[40945a3] | 20 | AND RE-RUN THE GENERATOR SCRIPT |
---|
| 21 | |
---|
| 22 | """ |
---|
| 23 | |
---|
| 24 | from sans.models.BaseComponent import BaseComponent |
---|
| 25 | from sans_extension.c_models import CDiamEllipFunc |
---|
| 26 | import copy |
---|
| 27 | |
---|
| 28 | class DiamEllipFunc(CDiamEllipFunc, BaseComponent): |
---|
| 29 | """ Class that evaluates a DiamEllipFunc model. |
---|
[fe9c19b4] | 30 | This file was auto-generated from ..\c_extensions\DiamEllip.h. |
---|
| 31 | Refer to that file and the structure it contains |
---|
| 32 | for details of the model. |
---|
| 33 | List of default parameters: |
---|
[40945a3] | 34 | radius_a = 20.0 A |
---|
| 35 | radius_b = 400.0 A |
---|
| 36 | |
---|
| 37 | """ |
---|
| 38 | |
---|
| 39 | def __init__(self): |
---|
| 40 | """ Initialization """ |
---|
| 41 | |
---|
| 42 | # Initialize BaseComponent first, then sphere |
---|
| 43 | BaseComponent.__init__(self) |
---|
| 44 | CDiamEllipFunc.__init__(self) |
---|
| 45 | |
---|
| 46 | ## Name of the model |
---|
| 47 | self.name = "DiamEllipFunc" |
---|
| 48 | ## Model description |
---|
| 49 | self.description ="""To calculate the 2nd virial coefficient for |
---|
| 50 | the non-spherical object, then find the |
---|
| 51 | radius of sphere that has this value of |
---|
| 52 | virial coefficient: |
---|
| 53 | radius_a = polar radius, |
---|
| 54 | radius_b = equatorial radius; |
---|
| 55 | radius_a > radius_b: Prolate spheroid, |
---|
| 56 | radius_a < radius_b: Oblate spheroid.""" |
---|
| 57 | |
---|
[fe9c19b4] | 58 | ## Parameter details [units, min, max] |
---|
[40945a3] | 59 | self.details = {} |
---|
| 60 | self.details['radius_a'] = ['A', None, None] |
---|
| 61 | self.details['radius_b'] = ['A', None, None] |
---|
| 62 | |
---|
[fe9c19b4] | 63 | ## fittable parameters |
---|
[40945a3] | 64 | self.fixed=['radius_a.width', 'radius_b.width'] |
---|
[870f131] | 65 | |
---|
| 66 | ## parameters with orientation |
---|
| 67 | self.orientation_params =[] |
---|
[40945a3] | 68 | |
---|
| 69 | def clone(self): |
---|
| 70 | """ Return a identical copy of self """ |
---|
| 71 | return self._clone(DiamEllipFunc()) |
---|
[fe9c19b4] | 72 | |
---|
| 73 | def __getstate__(self): |
---|
| 74 | """ return object state for pickling and copying """ |
---|
| 75 | model_state = {'params': self.params, 'dispersion': self.dispersion, 'log': self.log} |
---|
| 76 | |
---|
| 77 | return self.__dict__, model_state |
---|
| 78 | |
---|
| 79 | def __setstate__(self, state): |
---|
| 80 | """ create object from pickled state """ |
---|
| 81 | |
---|
| 82 | self.__dict__, model_state = state |
---|
| 83 | self.params = model_state['params'] |
---|
| 84 | self.dispersion = model_state['dispersion'] |
---|
| 85 | self.log = model_state['log'] |
---|
| 86 | |
---|
[40945a3] | 87 | |
---|
| 88 | def run(self, x = 0.0): |
---|
| 89 | """ Evaluate the model |
---|
| 90 | @param x: input q, or [q,phi] |
---|
| 91 | @return: scattering function P(q) |
---|
| 92 | """ |
---|
| 93 | |
---|
| 94 | return CDiamEllipFunc.run(self, x) |
---|
| 95 | |
---|
| 96 | def runXY(self, x = 0.0): |
---|
| 97 | """ Evaluate the model in cartesian coordinates |
---|
| 98 | @param x: input q, or [qx, qy] |
---|
| 99 | @return: scattering function P(q) |
---|
| 100 | """ |
---|
| 101 | |
---|
| 102 | return CDiamEllipFunc.runXY(self, x) |
---|
| 103 | |
---|
[870f131] | 104 | def evalDistribition(self, x = []): |
---|
| 105 | """ Evaluate the model in cartesian coordinates |
---|
| 106 | @param x: input q[], or [qx[], qy[]] |
---|
| 107 | @return: scattering function P(q[]) |
---|
| 108 | """ |
---|
| 109 | return CDiamEllipFunc.evalDistribition(self, x) |
---|
| 110 | |
---|
[5eb9154] | 111 | def calculate_ER(self): |
---|
| 112 | """ Calculate the effective radius for P(q)*S(q) |
---|
| 113 | @return: the value of the effective radius |
---|
| 114 | """ |
---|
| 115 | return CDiamEllipFunc.calculate_ER(self) |
---|
| 116 | |
---|
[40945a3] | 117 | def set_dispersion(self, parameter, dispersion): |
---|
| 118 | """ |
---|
| 119 | Set the dispersion object for a model parameter |
---|
| 120 | @param parameter: name of the parameter [string] |
---|
| 121 | @dispersion: dispersion object of type DispersionModel |
---|
| 122 | """ |
---|
| 123 | return CDiamEllipFunc.set_dispersion(self, parameter, dispersion.cdisp) |
---|
| 124 | |
---|
| 125 | |
---|
| 126 | # End of file |
---|