Changeset 4e2f6ef8 in sasview for sansmodels

Timestamp:

Oct 23, 2008 11:13:59 AM (16 years ago)

Author:

Gervaise Alina <gervyh@…>

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:

753552d

Parents:

f6cc57c

Message:

add description

Location:

sansmodels/src/sans/models

Files:

• DABModel.py (modified) (1 diff)
• LorentzModel.py (modified) (1 diff)
• c_extensions/core_shell_cylinder.h (modified) (1 diff)
• c_extensions/cylinder.h (modified) (2 diffs)
• c_models/WrapperGenerator.py (modified) (2 diffs)

sansmodels/src/sans/models/DABModel.py

@@ -29 +29 @@
         ## Name of the model
         self.name = "DAB_Model"
-        self.description=" Name: DAB model.\n\
+        self.description=" DAB (Debye Anderson Brumberger) function.\n\
         F(x) = scale/( 1 + (x*L)^2 )^(2) + background\n\
         The model has three parameters:\n \

sansmodels/src/sans/models/LorentzModel.py

@@ -29 +29 @@
         ## Name of the model
         self.name = "Lorentz"
-        self.description=''
+        self.description="Lorentz (Ornstein-Zernicke) model.\n\
+        F(x) = scale/( 1 + (x*L)^2 ) + bkd\n\
+        The model has three parameters:\n \
+        L     =  screen Length\n\
+        scale  =  scale factor\n\
+        bkd    =  incoherent background"
         ## Define parameters
         self.params = {}

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

@@ -7 +7 @@
  //[PYTHONCLASS] = CoreShellCylinderModel
  //[DISP_PARAMS] = radius, thickness, length, axis_theta, axis_phi
+ //[DESCRIPTION] = ''
 typedef struct {
     /// Scale factor

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

@@ -1 +1 @@
 #if !defined(cylinder_h)
 #define cylinder_h
-
+#include string 
 /** Structure definition for cylinder parameters
  * [PYTHONCLASS] = CylinderModel
  * [DISP_PARAMS] = radius, length, cyl_theta, cyl_phi
+   [DESCRIPTION] = ''
+        
  * */
 typedef struct {
@@ -28 +30 @@
     //  [DEFAULT]=cyl_phi=1.0 rad
     double cyl_phi;
+        
 } CylinderParameters;
 

sansmodels/src/sans/models/c_models/WrapperGenerator.py

@@ -79 +79 @@
         ## List of dispersed parameters
         self.disp_params = []
+        #model description
+        self.description=''
         
     def __repr__(self):
@@ -330 +332 @@
             newline = self.replaceToken(newline, 
                                         "[PAR_DETAILS]", self.details)
+            # Parameter details
+            newline = self.replaceToken(newline, 
+                                        "[DESCRIPTION]", self.description)
 
             # Write new line to the wrapper .c file