[ae3ce4e] | 1 | #!/usr/bin/env python |
---|
[95986b5] | 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 | |
---|
[ae3ce4e] | 16 | """ Provide functionality for a C extension model |
---|
| 17 | |
---|
| 18 | WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY |
---|
[25a608f5] | 19 | DO NOT MODIFY THIS FILE, MODIFY ..\c_extensions\core_shell.h |
---|
[ae3ce4e] | 20 | AND RE-RUN THE GENERATOR SCRIPT |
---|
| 21 | |
---|
| 22 | """ |
---|
| 23 | |
---|
| 24 | from sans.models.BaseComponent import BaseComponent |
---|
| 25 | from sans_extension.c_models import CCoreShellModel |
---|
| 26 | import copy |
---|
| 27 | |
---|
| 28 | class CoreShellModel(CCoreShellModel, BaseComponent): |
---|
| 29 | """ Class that evaluates a CoreShellModel model. |
---|
[fe9c19b4] | 30 | This file was auto-generated from ..\c_extensions\core_shell.h. |
---|
| 31 | Refer to that file and the structure it contains |
---|
| 32 | for details of the model. |
---|
| 33 | List of default parameters: |
---|
[ae3ce4e] | 34 | scale = 1.0 |
---|
[1ed3834] | 35 | radius = 60.0 [A] |
---|
| 36 | thickness = 10.0 [A] |
---|
[27972c1d] | 37 | core_sld = 1e-006 [1/A^(2)] |
---|
| 38 | shell_sld = 2e-006 [1/A^(2)] |
---|
| 39 | solvent_sld = 3e-006 [1/A^(2)] |
---|
[0824909] | 40 | background = 0.0 [1/cm] |
---|
[ae3ce4e] | 41 | |
---|
| 42 | """ |
---|
| 43 | |
---|
| 44 | def __init__(self): |
---|
| 45 | """ Initialization """ |
---|
| 46 | |
---|
| 47 | # Initialize BaseComponent first, then sphere |
---|
| 48 | BaseComponent.__init__(self) |
---|
| 49 | CCoreShellModel.__init__(self) |
---|
| 50 | |
---|
| 51 | ## Name of the model |
---|
| 52 | self.name = "CoreShellModel" |
---|
[836fe6e] | 53 | ## Model description |
---|
[1ed3834] | 54 | self.description ="""Form factor for a monodisperse spherical particle with particle |
---|
| 55 | with a core-shell structure: |
---|
| 56 | |
---|
[369e492e] | 57 | The form factor is normalized by the |
---|
| 58 | total particle volume. |
---|
| 59 | |
---|
[1ed3834] | 60 | radius: core radius, thickness: shell thickness |
---|
[369e492e] | 61 | |
---|
| 62 | Ref: Guinier, A. and G. Fournet, |
---|
| 63 | John Wiley and Sons, New York, 1955.""" |
---|
[836fe6e] | 64 | |
---|
[fe9c19b4] | 65 | ## Parameter details [units, min, max] |
---|
[ae3ce4e] | 66 | self.details = {} |
---|
| 67 | self.details['scale'] = ['', None, None] |
---|
[1ed3834] | 68 | self.details['radius'] = ['[A]', None, None] |
---|
| 69 | self.details['thickness'] = ['[A]', None, None] |
---|
[27972c1d] | 70 | self.details['core_sld'] = ['[1/A^(2)]', None, None] |
---|
| 71 | self.details['shell_sld'] = ['[1/A^(2)]', None, None] |
---|
| 72 | self.details['solvent_sld'] = ['[1/A^(2)]', None, None] |
---|
[0824909] | 73 | self.details['background'] = ['[1/cm]', None, None] |
---|
[836fe6e] | 74 | |
---|
[fe9c19b4] | 75 | ## fittable parameters |
---|
[836fe6e] | 76 | self.fixed=['thickness.width', 'radius.width'] |
---|
[25a608f5] | 77 | |
---|
| 78 | ## parameters with orientation |
---|
| 79 | self.orientation_params =[] |
---|
[ae3ce4e] | 80 | |
---|
| 81 | def clone(self): |
---|
| 82 | """ Return a identical copy of self """ |
---|
[95986b5] | 83 | return self._clone(CoreShellModel()) |
---|
[fe9c19b4] | 84 | |
---|
| 85 | def __getstate__(self): |
---|
| 86 | """ return object state for pickling and copying """ |
---|
| 87 | model_state = {'params': self.params, 'dispersion': self.dispersion, 'log': self.log} |
---|
| 88 | |
---|
| 89 | return self.__dict__, model_state |
---|
| 90 | |
---|
| 91 | def __setstate__(self, state): |
---|
| 92 | """ create object from pickled state """ |
---|
| 93 | |
---|
| 94 | self.__dict__, model_state = state |
---|
| 95 | self.params = model_state['params'] |
---|
| 96 | self.dispersion = model_state['dispersion'] |
---|
| 97 | self.log = model_state['log'] |
---|
| 98 | |
---|
[ae3ce4e] | 99 | |
---|
| 100 | def run(self, x = 0.0): |
---|
| 101 | """ Evaluate the model |
---|
| 102 | @param x: input q, or [q,phi] |
---|
| 103 | @return: scattering function P(q) |
---|
| 104 | """ |
---|
| 105 | |
---|
| 106 | return CCoreShellModel.run(self, x) |
---|
| 107 | |
---|
| 108 | def runXY(self, x = 0.0): |
---|
| 109 | """ Evaluate the model in cartesian coordinates |
---|
| 110 | @param x: input q, or [qx, qy] |
---|
| 111 | @return: scattering function P(q) |
---|
| 112 | """ |
---|
| 113 | |
---|
| 114 | return CCoreShellModel.runXY(self, x) |
---|
[95986b5] | 115 | |
---|
[9bd69098] | 116 | def evalDistribition(self, x = []): |
---|
| 117 | """ Evaluate the model in cartesian coordinates |
---|
| 118 | @param x: input q[], or [qx[], qy[]] |
---|
| 119 | @return: scattering function P(q[]) |
---|
| 120 | """ |
---|
| 121 | return CCoreShellModel.evalDistribition(self, x) |
---|
| 122 | |
---|
[5eb9154] | 123 | def calculate_ER(self): |
---|
| 124 | """ Calculate the effective radius for P(q)*S(q) |
---|
| 125 | @return: the value of the effective radius |
---|
| 126 | """ |
---|
| 127 | return CCoreShellModel.calculate_ER(self) |
---|
| 128 | |
---|
[95986b5] | 129 | def set_dispersion(self, parameter, dispersion): |
---|
| 130 | """ |
---|
| 131 | Set the dispersion object for a model parameter |
---|
| 132 | @param parameter: name of the parameter [string] |
---|
| 133 | @dispersion: dispersion object of type DispersionModel |
---|
| 134 | """ |
---|
| 135 | return CCoreShellModel.set_dispersion(self, parameter, dispersion.cdisp) |
---|
| 136 | |
---|
[ae3ce4e] | 137 | |
---|
| 138 | # End of file |
---|