[2c4b289] | 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 | ############################################################################## |
---|
[2c4b289] | 16 | |
---|
| 17 | |
---|
[79ac6f8] | 18 | """ |
---|
| 19 | Provide functionality for a C extension model |
---|
[2c4b289] | 20 | |
---|
[79ac6f8] | 21 | :WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY |
---|
| 22 | DO NOT MODIFY THIS FILE, MODIFY ..\c_extensions\binaryHS.h |
---|
| 23 | AND RE-RUN THE GENERATOR SCRIPT |
---|
[2c4b289] | 24 | |
---|
| 25 | """ |
---|
| 26 | |
---|
| 27 | from sans.models.BaseComponent import BaseComponent |
---|
| 28 | from sans_extension.c_models import CBinaryHSModel |
---|
| 29 | import copy |
---|
| 30 | |
---|
| 31 | class BinaryHSModel(CBinaryHSModel, BaseComponent): |
---|
[79ac6f8] | 32 | """ |
---|
| 33 | Class that evaluates a BinaryHSModel model. |
---|
| 34 | This file was auto-generated from ..\c_extensions\binaryHS.h. |
---|
| 35 | Refer to that file and the structure it contains |
---|
| 36 | for details of the model. |
---|
| 37 | List of default parameters: |
---|
[975ec8e] | 38 | l_radius = 100.0 [A] |
---|
[2c4b289] | 39 | s_radius = 25.0 [A] |
---|
[975ec8e] | 40 | vol_frac_ls = 0.1 |
---|
[2c4b289] | 41 | vol_frac_ss = 0.2 |
---|
[4cbaf35] | 42 | ls_sld = 3.5e-006 [1/A^(2)] |
---|
| 43 | ss_sld = 5e-007 [1/A^(2)] |
---|
| 44 | solvent_sld = 6.36e-006 [1/A^(2)] |
---|
| 45 | background = 0.001 [1/cm] |
---|
[2c4b289] | 46 | |
---|
| 47 | """ |
---|
| 48 | |
---|
| 49 | def __init__(self): |
---|
| 50 | """ Initialization """ |
---|
| 51 | |
---|
| 52 | # Initialize BaseComponent first, then sphere |
---|
| 53 | BaseComponent.__init__(self) |
---|
| 54 | CBinaryHSModel.__init__(self) |
---|
| 55 | |
---|
| 56 | ## Name of the model |
---|
| 57 | self.name = "BinaryHSModel" |
---|
| 58 | ## Model description |
---|
[975ec8e] | 59 | self.description =""" Model parameters: l_radius : large radius of binary hard sphere |
---|
| 60 | s_radius : small radius of binary hard sphere |
---|
[2c4b289] | 61 | vol_frac_ls : volume fraction of large spheres |
---|
| 62 | vol_frac_ss : volume fraction of small spheres |
---|
| 63 | ls_sld: large sphere scattering length density |
---|
| 64 | ss_sld: small sphere scattering length density |
---|
| 65 | solvent_sld: solvent scattering length density |
---|
| 66 | background: incoherent background""" |
---|
| 67 | |
---|
[fe9c19b4] | 68 | ## Parameter details [units, min, max] |
---|
[2c4b289] | 69 | self.details = {} |
---|
| 70 | self.details['l_radius'] = ['[A]', None, None] |
---|
| 71 | self.details['s_radius'] = ['[A]', None, None] |
---|
| 72 | self.details['vol_frac_ls'] = ['', None, None] |
---|
| 73 | self.details['vol_frac_ss'] = ['', None, None] |
---|
[4cbaf35] | 74 | self.details['ls_sld'] = ['[1/A^(2)]', None, None] |
---|
| 75 | self.details['ss_sld'] = ['[1/A^(2)]', None, None] |
---|
| 76 | self.details['solvent_sld'] = ['[1/A^(2)]', None, None] |
---|
| 77 | self.details['background'] = ['[1/cm]', None, None] |
---|
[2c4b289] | 78 | |
---|
[fe9c19b4] | 79 | ## fittable parameters |
---|
[2c4b289] | 80 | self.fixed=['l_radius.width', 's_radius.width'] |
---|
| 81 | |
---|
[35aface] | 82 | ## non-fittable parameters |
---|
| 83 | self.non_fittable=[] |
---|
| 84 | |
---|
[2c4b289] | 85 | ## parameters with orientation |
---|
| 86 | self.orientation_params =[] |
---|
| 87 | |
---|
| 88 | def clone(self): |
---|
| 89 | """ Return a identical copy of self """ |
---|
| 90 | return self._clone(BinaryHSModel()) |
---|
[fe9c19b4] | 91 | |
---|
| 92 | def __getstate__(self): |
---|
[79ac6f8] | 93 | """ |
---|
| 94 | return object state for pickling and copying |
---|
| 95 | """ |
---|
[fe9c19b4] | 96 | model_state = {'params': self.params, 'dispersion': self.dispersion, 'log': self.log} |
---|
| 97 | |
---|
| 98 | return self.__dict__, model_state |
---|
| 99 | |
---|
| 100 | def __setstate__(self, state): |
---|
[79ac6f8] | 101 | """ |
---|
| 102 | create object from pickled state |
---|
| 103 | |
---|
| 104 | :param state: the state of the current model |
---|
| 105 | |
---|
| 106 | """ |
---|
[fe9c19b4] | 107 | |
---|
| 108 | self.__dict__, model_state = state |
---|
| 109 | self.params = model_state['params'] |
---|
| 110 | self.dispersion = model_state['dispersion'] |
---|
| 111 | self.log = model_state['log'] |
---|
| 112 | |
---|
[2c4b289] | 113 | |
---|
[79ac6f8] | 114 | def run(self, x=0.0): |
---|
| 115 | """ |
---|
| 116 | Evaluate the model |
---|
| 117 | |
---|
| 118 | :param x: input q, or [q,phi] |
---|
| 119 | |
---|
| 120 | :return: scattering function P(q) |
---|
| 121 | |
---|
[2c4b289] | 122 | """ |
---|
| 123 | |
---|
| 124 | return CBinaryHSModel.run(self, x) |
---|
| 125 | |
---|
[79ac6f8] | 126 | def runXY(self, x=0.0): |
---|
| 127 | """ |
---|
| 128 | Evaluate the model in cartesian coordinates |
---|
| 129 | |
---|
| 130 | :param x: input q, or [qx, qy] |
---|
| 131 | |
---|
| 132 | :return: scattering function P(q) |
---|
| 133 | |
---|
[2c4b289] | 134 | """ |
---|
| 135 | |
---|
| 136 | return CBinaryHSModel.runXY(self, x) |
---|
| 137 | |
---|
[79ac6f8] | 138 | def evalDistribution(self, x=[]): |
---|
| 139 | """ |
---|
| 140 | Evaluate the model in cartesian coordinates |
---|
| 141 | |
---|
| 142 | :param x: input q[], or [qx[], qy[]] |
---|
| 143 | |
---|
| 144 | :return: scattering function P(q[]) |
---|
| 145 | |
---|
[9bd69098] | 146 | """ |
---|
[f9a1279] | 147 | return CBinaryHSModel.evalDistribution(self, x) |
---|
[9bd69098] | 148 | |
---|
[5eb9154] | 149 | def calculate_ER(self): |
---|
[79ac6f8] | 150 | """ |
---|
| 151 | Calculate the effective radius for P(q)*S(q) |
---|
| 152 | |
---|
| 153 | :return: the value of the effective radius |
---|
| 154 | |
---|
[5eb9154] | 155 | """ |
---|
| 156 | return CBinaryHSModel.calculate_ER(self) |
---|
| 157 | |
---|
[2c4b289] | 158 | def set_dispersion(self, parameter, dispersion): |
---|
| 159 | """ |
---|
[79ac6f8] | 160 | Set the dispersion object for a model parameter |
---|
| 161 | |
---|
| 162 | :param parameter: name of the parameter [string] |
---|
| 163 | :param dispersion: dispersion object of type DispersionModel |
---|
| 164 | |
---|
[2c4b289] | 165 | """ |
---|
| 166 | return CBinaryHSModel.set_dispersion(self, parameter, dispersion.cdisp) |
---|
| 167 | |
---|
| 168 | |
---|
| 169 | # End of file |
---|