[793c988] | 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\hollow_cylinder.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 CHollowCylinderModel |
---|
| 26 | import copy |
---|
| 27 | |
---|
| 28 | class HollowCylinderModel(CHollowCylinderModel, BaseComponent): |
---|
| 29 | """ Class that evaluates a HollowCylinderModel model. |
---|
[fe9c19b4] | 30 | This file was auto-generated from ..\c_extensions\hollow_cylinder.h. |
---|
| 31 | Refer to that file and the structure it contains |
---|
| 32 | for details of the model. |
---|
| 33 | List of default parameters: |
---|
[793c988] | 34 | scale = 1.0 |
---|
| 35 | core_radius = 20.0 [A] |
---|
[e2afadf] | 36 | radius = 30.0 [A] |
---|
[793c988] | 37 | length = 400.0 [A] |
---|
[27972c1d] | 38 | contrast = 5.3e-006 [1/A^(2)] |
---|
[793c988] | 39 | background = 0.01 [1/cm] |
---|
| 40 | axis_theta = 1.57 [rad] |
---|
| 41 | axis_phi = 0.0 [rad] |
---|
| 42 | |
---|
| 43 | """ |
---|
| 44 | |
---|
| 45 | def __init__(self): |
---|
| 46 | """ Initialization """ |
---|
| 47 | |
---|
| 48 | # Initialize BaseComponent first, then sphere |
---|
| 49 | BaseComponent.__init__(self) |
---|
| 50 | CHollowCylinderModel.__init__(self) |
---|
| 51 | |
---|
| 52 | ## Name of the model |
---|
| 53 | self.name = "HollowCylinderModel" |
---|
| 54 | ## Model description |
---|
[7ad9887] | 55 | self.description =""" P(q) = scale*<f*f>/Vol + bkg, where f is the scattering amplitude. |
---|
| 56 | core_radius = the radius of core |
---|
| 57 | radius = the radius of shell |
---|
| 58 | length = the total length of the cylinder |
---|
| 59 | contrast = SLD of solvent - SLD of shell |
---|
| 60 | background = incoherent background""" |
---|
[793c988] | 61 | |
---|
[fe9c19b4] | 62 | ## Parameter details [units, min, max] |
---|
[793c988] | 63 | self.details = {} |
---|
| 64 | self.details['scale'] = ['', None, None] |
---|
| 65 | self.details['core_radius'] = ['[A]', None, None] |
---|
[e2afadf] | 66 | self.details['radius'] = ['[A]', None, None] |
---|
[793c988] | 67 | self.details['length'] = ['[A]', None, None] |
---|
[27972c1d] | 68 | self.details['contrast'] = ['[1/A^(2)]', None, None] |
---|
[793c988] | 69 | self.details['background'] = ['[1/cm]', None, None] |
---|
| 70 | self.details['axis_theta'] = ['[rad]', None, None] |
---|
| 71 | self.details['axis_phi'] = ['[rad]', None, None] |
---|
| 72 | |
---|
[fe9c19b4] | 73 | ## fittable parameters |
---|
[e2afadf] | 74 | self.fixed=['axis_phi.width', 'axis_theta.width', 'length.width', 'core_radius.width', 'radius'] |
---|
[793c988] | 75 | |
---|
| 76 | ## parameters with orientation |
---|
| 77 | self.orientation_params =['axis_phi', 'axis_theta', 'axis_phi.width', 'axis_theta.width'] |
---|
| 78 | |
---|
| 79 | def clone(self): |
---|
| 80 | """ Return a identical copy of self """ |
---|
| 81 | return self._clone(HollowCylinderModel()) |
---|
[fe9c19b4] | 82 | |
---|
| 83 | def __getstate__(self): |
---|
| 84 | """ return object state for pickling and copying """ |
---|
| 85 | model_state = {'params': self.params, 'dispersion': self.dispersion, 'log': self.log} |
---|
| 86 | |
---|
| 87 | return self.__dict__, model_state |
---|
| 88 | |
---|
| 89 | def __setstate__(self, state): |
---|
| 90 | """ create object from pickled state """ |
---|
| 91 | |
---|
| 92 | self.__dict__, model_state = state |
---|
| 93 | self.params = model_state['params'] |
---|
| 94 | self.dispersion = model_state['dispersion'] |
---|
| 95 | self.log = model_state['log'] |
---|
| 96 | |
---|
[793c988] | 97 | |
---|
| 98 | def run(self, x = 0.0): |
---|
| 99 | """ Evaluate the model |
---|
| 100 | @param x: input q, or [q,phi] |
---|
| 101 | @return: scattering function P(q) |
---|
| 102 | """ |
---|
| 103 | |
---|
| 104 | return CHollowCylinderModel.run(self, x) |
---|
| 105 | |
---|
| 106 | def runXY(self, x = 0.0): |
---|
| 107 | """ Evaluate the model in cartesian coordinates |
---|
| 108 | @param x: input q, or [qx, qy] |
---|
| 109 | @return: scattering function P(q) |
---|
| 110 | """ |
---|
| 111 | |
---|
| 112 | return CHollowCylinderModel.runXY(self, x) |
---|
| 113 | |
---|
[f9a1279] | 114 | def evalDistribution(self, x = []): |
---|
[9bd69098] | 115 | """ Evaluate the model in cartesian coordinates |
---|
| 116 | @param x: input q[], or [qx[], qy[]] |
---|
| 117 | @return: scattering function P(q[]) |
---|
| 118 | """ |
---|
[f9a1279] | 119 | return CHollowCylinderModel.evalDistribution(self, x) |
---|
[9bd69098] | 120 | |
---|
[5eb9154] | 121 | def calculate_ER(self): |
---|
| 122 | """ Calculate the effective radius for P(q)*S(q) |
---|
| 123 | @return: the value of the effective radius |
---|
| 124 | """ |
---|
| 125 | return CHollowCylinderModel.calculate_ER(self) |
---|
| 126 | |
---|
[793c988] | 127 | def set_dispersion(self, parameter, dispersion): |
---|
| 128 | """ |
---|
| 129 | Set the dispersion object for a model parameter |
---|
| 130 | @param parameter: name of the parameter [string] |
---|
| 131 | @dispersion: dispersion object of type DispersionModel |
---|
| 132 | """ |
---|
| 133 | return CHollowCylinderModel.set_dispersion(self, parameter, dispersion.cdisp) |
---|
| 134 | |
---|
| 135 | |
---|
| 136 | # End of file |
---|