Changeset 7ad9887 in sasview for sansmodels/src/sans/models/c_extensions

Timestamp:

Sep 14, 2009 6:14:03 PM (16 years ago)

Author:

Jae Cho <jhjcho@…>

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

0ab485b

Parents:

15f52f8

Message:

Added model descrp.s

Location:

sansmodels/src/sans/models/c_extensions

Files:

• elliptical_cylinder.h (modified) (1 diff)
• hollow_cylinder.h (modified) (1 diff)
• stacked_disks.h (modified) (1 diff)
• triaxial_ellipsoid.h (modified) (1 diff)
• vesicle.h (modified) (1 diff)

sansmodels/src/sans/models/c_extensions/elliptical_cylinder.h

@@ -5 +5 @@
  * [PYTHONCLASS] = EllipticalCylinderModel
  * [DISP_PARAMS] = r_minor, r_ratio, length, cyl_theta, cyl_phi, cyl_psi
- * [DESCRIPTION] = Please see details...
+ * [DESCRIPTION] = <text> Model parameters: r_minor = the radius of minor axis of the cross section
+r_ratio = the ratio of (r_major /r_minor >= 1)
+length = the length of the cylinder
+contrast = SLD of solvent - SLD of the cylinder
+background = incoherent background
+  *</text>
  * [FIXED]= <text> cyl_phi.width;
- * cyl_theta.width; cyl_psi.width; length.width; r_minor.width; r_ratio.width 
+ * cyl_theta.width; cyl_psi.width; length.width; r_minor.width; r_ratio.width
  *</text>
  * [ORIENTATION_PARAMS]= cyl_phi; cyl_theta; cyl_psi;  cyl_phi.width; cyl_theta.width; cyl_psi.width

sansmodels/src/sans/models/c_extensions/hollow_cylinder.h

@@ -7 +7 @@
  //[PYTHONCLASS] = HollowCylinderModel
  //[DISP_PARAMS] = core_radius, radius, length, axis_theta, axis_phi
- //[DESCRIPTION] = <text></text>
+ //[DESCRIPTION] = <text> P(q) = scale*<f*f>/Vol + bkg, where f is the scattering amplitude.
+ //                                     core_radius = the radius of core
+ //                             radius = the radius of shell
+ //                     length = the total length of the cylinder
+ //                             contrast = SLD of solvent - SLD of shell
+ //                             background = incoherent background
+ //     </text>
  //[FIXED]= <text> axis_phi.width; axis_theta.width; length.width;core_radius.width; radius</text>
  //[ORIENTATION_PARAMS]= axis_phi; axis_theta;axis_phi.width; axis_theta.width

sansmodels/src/sans/models/c_extensions/stacked_disks.h

@@ -8 +8 @@
  * [PYTHONCLASS] = StackedDisksModel
  * [DISP_PARAMS] = core_thick, layer_thick, radius, axis_theta, axis_phi
-   [DESCRIPTION] = <text>
+   [DESCRIPTION] = <text> One layer of disk consists of a core, a top layer, and a bottom layer.
+                radius =  the radius of the disk
+                core_thick = thickness of the core
+                layer_thick = thickness of a layer
+                core_sld = the SLD of the core
+                layer_sld = the SLD of the layers
+                n_stacking = the number of the disks
+                sigma_d =  Gaussian STD of d-spacing
+                solvent_sld = the SLD of the solvent
                 </text>
         [FIXED]= <text>core_thick.width;layer_thick.width; radius.width; axis_theta.width; axis_phi.width</text>

sansmodels/src/sans/models/c_extensions/triaxial_ellipsoid.h

@@ -4 +4 @@
  * [PYTHONCLASS] = TriaxialEllipsoidModel
  * [DISP_PARAMS] = axis_theta, axis_phi, axis_psi
-   [DESCRIPTION] = <text> Note:
-                                        Constraints must be applied during fitting to ensure that the inequality a<b<c is not
-                                                  violated. The calculation will not report an error, but the results will not be correct.
-                                   </text>
+        [DESCRIPTION] = <text>Note: During fitting ensure that the inequality A<B<C is not
+        violated. Otherwise the calculation will
+        not be correct.
+        </text>
         [FIXED]= <text>axis_psi.width; axis_phi.width; axis_theta.width; semi_axisA.width; semi_axisB.width; semi_axisC.width </text>
         [ORIENTATION_PARAMS]= <text>axis_psi; axis_phi; axis_theta; axis_psi.width; axis_phi.width; axis_theta.width</text>
-
-
  **/
 typedef struct {

sansmodels/src/sans/models/c_extensions/vesicle.h

@@ -6 +6 @@
 [PYTHONCLASS] = VesicleModel
 [DISP_PARAMS] = radius,thickness
-[DESCRIPTION] =<text>Model parameters:  radius : core radius of the vesicle
-                thickness: shell thickness
-                core_sld: core scattering length density
-                shell_sld: shell scattering length density
+[DESCRIPTION] =<text>Model parameters:    radius : the core radius of the vesicle
+                thickness: the shell thickness
+                core_sld: the core SLD
+                shell_sld: the shell SLD
                 background: incoherent background
                 scale : scale factor