[af03ddd] | 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 | ############################################################################## |
---|
[af03ddd] | 16 | |
---|
| 17 | |
---|
[79ac6f8] | 18 | """ |
---|
| 19 | Provide functionality for a C extension model |
---|
[af03ddd] | 20 | |
---|
[79ac6f8] | 21 | :WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY |
---|
| 22 | DO NOT MODIFY THIS FILE, MODIFY [INCLUDE_FILE] |
---|
| 23 | AND RE-RUN THE GENERATOR SCRIPT |
---|
[af03ddd] | 24 | |
---|
| 25 | """ |
---|
| 26 | |
---|
| 27 | from sans.models.BaseComponent import BaseComponent |
---|
| 28 | from sans_extension.c_models import [CPYTHONCLASS] |
---|
| 29 | import copy |
---|
| 30 | |
---|
| 31 | class [PYTHONCLASS]([CPYTHONCLASS], BaseComponent): |
---|
[79ac6f8] | 32 | """ |
---|
| 33 | Class that evaluates a [PYTHONCLASS] model. |
---|
| 34 | This file was auto-generated from [INCLUDE_FILE]. |
---|
| 35 | Refer to that file and the structure it contains |
---|
| 36 | for details of the model. |
---|
| 37 | [DEFAULT_LIST] |
---|
[af03ddd] | 38 | """ |
---|
| 39 | |
---|
| 40 | def __init__(self): |
---|
| 41 | """ Initialization """ |
---|
| 42 | |
---|
| 43 | # Initialize BaseComponent first, then sphere |
---|
| 44 | BaseComponent.__init__(self) |
---|
| 45 | [CPYTHONCLASS].__init__(self) |
---|
| 46 | |
---|
| 47 | ## Name of the model |
---|
| 48 | self.name = "[PYTHONCLASS]" |
---|
[836fe6e] | 49 | ## Model description |
---|
[9316609] | 50 | self.description ="""[DESCRIPTION]""" |
---|
[836fe6e] | 51 | |
---|
[fe9c19b4] | 52 | [PAR_DETAILS] |
---|
| 53 | ## fittable parameters |
---|
[836fe6e] | 54 | self.fixed=[FIXED] |
---|
[25a608f5] | 55 | |
---|
[35aface] | 56 | ## non-fittable parameters |
---|
| 57 | self.non_fittable=[NON_FITTABLE_PARAMS] |
---|
| 58 | |
---|
[25a608f5] | 59 | ## parameters with orientation |
---|
| 60 | self.orientation_params =[ORIENTATION_PARAMS] |
---|
[af03ddd] | 61 | |
---|
| 62 | def clone(self): |
---|
| 63 | """ Return a identical copy of self """ |
---|
[8809e48] | 64 | return self._clone([PYTHONCLASS]()) |
---|
[fe9c19b4] | 65 | |
---|
| 66 | def __getstate__(self): |
---|
[79ac6f8] | 67 | """ |
---|
| 68 | return object state for pickling and copying |
---|
| 69 | """ |
---|
[fe9c19b4] | 70 | model_state = {'params': self.params, 'dispersion': self.dispersion, 'log': self.log} |
---|
| 71 | |
---|
| 72 | return self.__dict__, model_state |
---|
| 73 | |
---|
| 74 | def __setstate__(self, state): |
---|
[79ac6f8] | 75 | """ |
---|
| 76 | create object from pickled state |
---|
| 77 | |
---|
| 78 | :param state: the state of the current model |
---|
| 79 | |
---|
| 80 | """ |
---|
[fe9c19b4] | 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 | |
---|
[af03ddd] | 87 | |
---|
[79ac6f8] | 88 | def run(self, x=0.0): |
---|
| 89 | """ |
---|
| 90 | Evaluate the model |
---|
| 91 | |
---|
| 92 | :param x: input q, or [q,phi] |
---|
| 93 | |
---|
| 94 | :return: scattering function P(q) |
---|
| 95 | |
---|
[af03ddd] | 96 | """ |
---|
| 97 | |
---|
| 98 | return [CPYTHONCLASS].run(self, x) |
---|
| 99 | |
---|
[79ac6f8] | 100 | def runXY(self, x=0.0): |
---|
| 101 | """ |
---|
| 102 | Evaluate the model in cartesian coordinates |
---|
| 103 | |
---|
| 104 | :param x: input q, or [qx, qy] |
---|
| 105 | |
---|
| 106 | :return: scattering function P(q) |
---|
| 107 | |
---|
[af03ddd] | 108 | """ |
---|
| 109 | |
---|
| 110 | return [CPYTHONCLASS].runXY(self, x) |
---|
| 111 | |
---|
[79ac6f8] | 112 | def evalDistribution(self, x=[]): |
---|
| 113 | """ |
---|
| 114 | Evaluate the model in cartesian coordinates |
---|
| 115 | |
---|
| 116 | :param x: input q[], or [qx[], qy[]] |
---|
| 117 | |
---|
| 118 | :return: scattering function P(q[]) |
---|
| 119 | |
---|
[5b56b7a] | 120 | """ |
---|
[f9a1279] | 121 | return [CPYTHONCLASS].evalDistribution(self, x) |
---|
[5b56b7a] | 122 | |
---|
[5eb9154] | 123 | def calculate_ER(self): |
---|
[79ac6f8] | 124 | """ |
---|
| 125 | Calculate the effective radius for P(q)*S(q) |
---|
| 126 | |
---|
| 127 | :return: the value of the effective radius |
---|
| 128 | |
---|
[5eb9154] | 129 | """ |
---|
| 130 | return [CPYTHONCLASS].calculate_ER(self) |
---|
| 131 | |
---|
[af03ddd] | 132 | def set_dispersion(self, parameter, dispersion): |
---|
| 133 | """ |
---|
[79ac6f8] | 134 | Set the dispersion object for a model parameter |
---|
| 135 | |
---|
| 136 | :param parameter: name of the parameter [string] |
---|
| 137 | :param dispersion: dispersion object of type DispersionModel |
---|
| 138 | |
---|
[af03ddd] | 139 | """ |
---|
| 140 | return [CPYTHONCLASS].set_dispersion(self, parameter, dispersion.cdisp) |
---|
| 141 | |
---|
| 142 | |
---|
| 143 | # End of file |
---|