[5068697] | 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\stacked_disks.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 CStackedDisksModel |
---|
| 26 | import copy |
---|
| 27 | |
---|
| 28 | class StackedDisksModel(CStackedDisksModel, BaseComponent): |
---|
| 29 | """ Class that evaluates a StackedDisksModel model. |
---|
[fe9c19b4] | 30 | This file was auto-generated from ..\c_extensions\stacked_disks.h. |
---|
| 31 | Refer to that file and the structure it contains |
---|
| 32 | for details of the model. |
---|
| 33 | List of default parameters: |
---|
[5068697] | 34 | scale = 0.01 |
---|
| 35 | radius = 3000.0 [A] |
---|
[975ec8e] | 36 | core_thick = 10.0 [A] |
---|
| 37 | layer_thick = 15.0 [A] |
---|
[27972c1d] | 38 | core_sld = 4e-006 [1/A^(2)] |
---|
| 39 | layer_sld = -4e-007 [1/A^(2)] |
---|
| 40 | solvent_sld = 5e-006 [1/A^(2)] |
---|
[975ec8e] | 41 | n_stacking = 1.0 |
---|
| 42 | sigma_d = 0.0 |
---|
[5068697] | 43 | background = 0.001 [1/cm] |
---|
[975ec8e] | 44 | axis_theta = 0.0 [rad] |
---|
| 45 | axis_phi = 0.0 [rad] |
---|
[5068697] | 46 | |
---|
| 47 | """ |
---|
| 48 | |
---|
| 49 | def __init__(self): |
---|
| 50 | """ Initialization """ |
---|
| 51 | |
---|
| 52 | # Initialize BaseComponent first, then sphere |
---|
| 53 | BaseComponent.__init__(self) |
---|
| 54 | CStackedDisksModel.__init__(self) |
---|
| 55 | |
---|
| 56 | ## Name of the model |
---|
| 57 | self.name = "StackedDisksModel" |
---|
| 58 | ## Model description |
---|
[7ad9887] | 59 | self.description =""" One layer of disk consists of a core, a top layer, and a bottom layer. |
---|
| 60 | radius = the radius of the disk |
---|
| 61 | core_thick = thickness of the core |
---|
| 62 | layer_thick = thickness of a layer |
---|
| 63 | core_sld = the SLD of the core |
---|
| 64 | layer_sld = the SLD of the layers |
---|
| 65 | n_stacking = the number of the disks |
---|
| 66 | sigma_d = Gaussian STD of d-spacing |
---|
| 67 | solvent_sld = the SLD of the solvent""" |
---|
[5068697] | 68 | |
---|
[fe9c19b4] | 69 | ## Parameter details [units, min, max] |
---|
[5068697] | 70 | self.details = {} |
---|
| 71 | self.details['scale'] = ['', None, None] |
---|
| 72 | self.details['radius'] = ['[A]', None, None] |
---|
[975ec8e] | 73 | self.details['core_thick'] = ['[A]', None, None] |
---|
| 74 | self.details['layer_thick'] = ['[A]', None, None] |
---|
[27972c1d] | 75 | self.details['core_sld'] = ['[1/A^(2)]', None, None] |
---|
| 76 | self.details['layer_sld'] = ['[1/A^(2)]', None, None] |
---|
| 77 | self.details['solvent_sld'] = ['[1/A^(2)]', None, None] |
---|
[975ec8e] | 78 | self.details['n_stacking'] = ['', None, None] |
---|
| 79 | self.details['sigma_d'] = ['', None, None] |
---|
[5068697] | 80 | self.details['background'] = ['[1/cm]', None, None] |
---|
| 81 | self.details['axis_theta'] = ['[rad]', None, None] |
---|
| 82 | self.details['axis_phi'] = ['[rad]', None, None] |
---|
| 83 | |
---|
[fe9c19b4] | 84 | ## fittable parameters |
---|
[975ec8e] | 85 | self.fixed=['core_thick.width', 'layer_thick.width', 'radius.width', 'axis_theta.width', 'axis_phi.width'] |
---|
[5068697] | 86 | |
---|
| 87 | ## parameters with orientation |
---|
| 88 | self.orientation_params =['axis_phi', 'axis_theta', 'axis_phi.width', 'axis_theta.width'] |
---|
| 89 | |
---|
| 90 | def clone(self): |
---|
| 91 | """ Return a identical copy of self """ |
---|
| 92 | return self._clone(StackedDisksModel()) |
---|
[fe9c19b4] | 93 | |
---|
| 94 | def __getstate__(self): |
---|
| 95 | """ return object state for pickling and copying """ |
---|
| 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): |
---|
| 101 | """ create object from pickled state """ |
---|
| 102 | |
---|
| 103 | self.__dict__, model_state = state |
---|
| 104 | self.params = model_state['params'] |
---|
| 105 | self.dispersion = model_state['dispersion'] |
---|
| 106 | self.log = model_state['log'] |
---|
| 107 | |
---|
[5068697] | 108 | |
---|
| 109 | def run(self, x = 0.0): |
---|
| 110 | """ Evaluate the model |
---|
| 111 | @param x: input q, or [q,phi] |
---|
| 112 | @return: scattering function P(q) |
---|
| 113 | """ |
---|
| 114 | |
---|
| 115 | return CStackedDisksModel.run(self, x) |
---|
| 116 | |
---|
| 117 | def runXY(self, x = 0.0): |
---|
| 118 | """ Evaluate the model in cartesian coordinates |
---|
| 119 | @param x: input q, or [qx, qy] |
---|
| 120 | @return: scattering function P(q) |
---|
| 121 | """ |
---|
| 122 | |
---|
| 123 | return CStackedDisksModel.runXY(self, x) |
---|
| 124 | |
---|
[9bd69098] | 125 | def evalDistribition(self, x = []): |
---|
| 126 | """ Evaluate the model in cartesian coordinates |
---|
| 127 | @param x: input q[], or [qx[], qy[]] |
---|
| 128 | @return: scattering function P(q[]) |
---|
| 129 | """ |
---|
| 130 | return CStackedDisksModel.evalDistribition(self, x) |
---|
| 131 | |
---|
[5eb9154] | 132 | def calculate_ER(self): |
---|
| 133 | """ Calculate the effective radius for P(q)*S(q) |
---|
| 134 | @return: the value of the effective radius |
---|
| 135 | """ |
---|
| 136 | return CStackedDisksModel.calculate_ER(self) |
---|
| 137 | |
---|
[5068697] | 138 | def set_dispersion(self, parameter, dispersion): |
---|
| 139 | """ |
---|
| 140 | Set the dispersion object for a model parameter |
---|
| 141 | @param parameter: name of the parameter [string] |
---|
| 142 | @dispersion: dispersion object of type DispersionModel |
---|
| 143 | """ |
---|
| 144 | return CStackedDisksModel.set_dispersion(self, parameter, dispersion.cdisp) |
---|
| 145 | |
---|
| 146 | |
---|
| 147 | # End of file |
---|