[40945a3] | 1 | #!/usr/bin/env python |
---|
| 2 | |
---|
[79ac6f8] | 3 | ############################################################################## |
---|
| 4 | # This software was developed by the University of Tennessee as part of the |
---|
| 5 | # Distributed Data Analysis of Neutron Scattering Experiments (DANSE) |
---|
| 6 | # project funded by the US National Science Foundation. |
---|
| 7 | # |
---|
| 8 | # If you use DANSE applications to do scientific research that leads to |
---|
| 9 | # publication, we ask that you acknowledge the use of the software with the |
---|
| 10 | # following sentence: |
---|
| 11 | # |
---|
| 12 | # "This work benefited from DANSE software developed under NSF award DMR-0520547." |
---|
| 13 | # |
---|
| 14 | # copyright 2008, University of Tennessee |
---|
| 15 | ############################################################################## |
---|
[40945a3] | 16 | |
---|
| 17 | |
---|
[79ac6f8] | 18 | """ |
---|
| 19 | Provide functionality for a C extension model |
---|
[40945a3] | 20 | |
---|
[79ac6f8] | 21 | :WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY |
---|
| 22 | DO NOT MODIFY THIS FILE, MODIFY ..\c_extensions\DiamCyl.h |
---|
| 23 | AND RE-RUN THE GENERATOR SCRIPT |
---|
[40945a3] | 24 | |
---|
| 25 | """ |
---|
| 26 | |
---|
| 27 | from sans.models.BaseComponent import BaseComponent |
---|
| 28 | from sans_extension.c_models import CDiamCylFunc |
---|
| 29 | import copy |
---|
| 30 | |
---|
| 31 | class DiamCylFunc(CDiamCylFunc, BaseComponent): |
---|
[79ac6f8] | 32 | """ |
---|
| 33 | Class that evaluates a DiamCylFunc model. |
---|
| 34 | This file was auto-generated from ..\c_extensions\DiamCyl.h. |
---|
| 35 | Refer to that file and the structure it contains |
---|
| 36 | for details of the model. |
---|
| 37 | List of default parameters: |
---|
[40945a3] | 38 | radius = 20.0 A |
---|
| 39 | length = 400.0 A |
---|
| 40 | |
---|
| 41 | """ |
---|
| 42 | |
---|
| 43 | def __init__(self): |
---|
| 44 | """ Initialization """ |
---|
| 45 | |
---|
| 46 | # Initialize BaseComponent first, then sphere |
---|
| 47 | BaseComponent.__init__(self) |
---|
| 48 | CDiamCylFunc.__init__(self) |
---|
| 49 | |
---|
| 50 | ## Name of the model |
---|
| 51 | self.name = "DiamCylFunc" |
---|
| 52 | ## Model description |
---|
| 53 | self.description ="""To calculate the 2nd virial coefficient for |
---|
| 54 | the non-spherical object, then find the |
---|
| 55 | radius of sphere that has this value of |
---|
| 56 | virial coefficient.""" |
---|
| 57 | |
---|
[fe9c19b4] | 58 | ## Parameter details [units, min, max] |
---|
[40945a3] | 59 | self.details = {} |
---|
| 60 | self.details['radius'] = ['A', None, None] |
---|
| 61 | self.details['length'] = ['A', None, None] |
---|
| 62 | |
---|
[fe9c19b4] | 63 | ## fittable parameters |
---|
[40945a3] | 64 | self.fixed=['radius.width', 'length.width'] |
---|
[0824909] | 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(DiamCylFunc()) |
---|
[fe9c19b4] | 72 | |
---|
| 73 | def __getstate__(self): |
---|
[79ac6f8] | 74 | """ |
---|
| 75 | return object state for pickling and copying |
---|
| 76 | """ |
---|
[fe9c19b4] | 77 | model_state = {'params': self.params, 'dispersion': self.dispersion, 'log': self.log} |
---|
| 78 | |
---|
| 79 | return self.__dict__, model_state |
---|
| 80 | |
---|
| 81 | def __setstate__(self, state): |
---|
[79ac6f8] | 82 | """ |
---|
| 83 | create object from pickled state |
---|
| 84 | |
---|
| 85 | :param state: the state of the current model |
---|
| 86 | |
---|
| 87 | """ |
---|
[fe9c19b4] | 88 | |
---|
| 89 | self.__dict__, model_state = state |
---|
| 90 | self.params = model_state['params'] |
---|
| 91 | self.dispersion = model_state['dispersion'] |
---|
| 92 | self.log = model_state['log'] |
---|
| 93 | |
---|
[40945a3] | 94 | |
---|
[79ac6f8] | 95 | def run(self, x=0.0): |
---|
| 96 | """ |
---|
| 97 | Evaluate the model |
---|
| 98 | |
---|
| 99 | :param x: input q, or [q,phi] |
---|
| 100 | |
---|
| 101 | :return: scattering function P(q) |
---|
| 102 | |
---|
[40945a3] | 103 | """ |
---|
| 104 | |
---|
| 105 | return CDiamCylFunc.run(self, x) |
---|
| 106 | |
---|
[79ac6f8] | 107 | def runXY(self, x=0.0): |
---|
| 108 | """ |
---|
| 109 | Evaluate the model in cartesian coordinates |
---|
| 110 | |
---|
| 111 | :param x: input q, or [qx, qy] |
---|
| 112 | |
---|
| 113 | :return: scattering function P(q) |
---|
| 114 | |
---|
[40945a3] | 115 | """ |
---|
| 116 | |
---|
| 117 | return CDiamCylFunc.runXY(self, x) |
---|
| 118 | |
---|
[79ac6f8] | 119 | def evalDistribution(self, x=[]): |
---|
| 120 | """ |
---|
| 121 | Evaluate the model in cartesian coordinates |
---|
| 122 | |
---|
| 123 | :param x: input q[], or [qx[], qy[]] |
---|
| 124 | |
---|
| 125 | :return: scattering function P(q[]) |
---|
| 126 | |
---|
[9bd69098] | 127 | """ |
---|
[f9a1279] | 128 | return CDiamCylFunc.evalDistribution(self, x) |
---|
[9bd69098] | 129 | |
---|
[5eb9154] | 130 | def calculate_ER(self): |
---|
[79ac6f8] | 131 | """ |
---|
| 132 | Calculate the effective radius for P(q)*S(q) |
---|
| 133 | |
---|
| 134 | :return: the value of the effective radius |
---|
| 135 | |
---|
[5eb9154] | 136 | """ |
---|
| 137 | return CDiamCylFunc.calculate_ER(self) |
---|
| 138 | |
---|
[40945a3] | 139 | def set_dispersion(self, parameter, dispersion): |
---|
| 140 | """ |
---|
[79ac6f8] | 141 | Set the dispersion object for a model parameter |
---|
| 142 | |
---|
| 143 | :param parameter: name of the parameter [string] |
---|
| 144 | :param dispersion: dispersion object of type DispersionModel |
---|
| 145 | |
---|
[40945a3] | 146 | """ |
---|
| 147 | return CDiamCylFunc.set_dispersion(self, parameter, dispersion.cdisp) |
---|
| 148 | |
---|
| 149 | |
---|
| 150 | # End of file |
---|