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