Changeset 7ad9887 in sasview for sansmodels


Ignore:
Timestamp:
Sep 14, 2009 6:14:03 PM (15 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
Files:
10 edited

Legend:

Unmodified
Added
Removed
  • sansmodels/src/sans/models/EllipticalCylinderModel.py

    rf9bf661 r7ad9887  
    5454        self.name = "EllipticalCylinderModel" 
    5555        ## Model description 
    56         self.description ="""Please see details...""" 
     56        self.description =""" Model parameters: r_minor = the radius of minor axis of the cross section 
     57                r_ratio = the ratio of (r_major /r_minor >= 1) 
     58                length = the length of the cylinder 
     59                contrast = SLD of solvent - SLD of the cylinder 
     60                background = incoherent background""" 
    5761        
    5862                ## Parameter details [units, min, max] 
  • sansmodels/src/sans/models/HollowCylinderModel.py

    rf9bf661 r7ad9887  
    5353        self.name = "HollowCylinderModel" 
    5454        ## Model description 
    55         self.description ="""""" 
     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""" 
    5661        
    5762                ## Parameter details [units, min, max] 
  • sansmodels/src/sans/models/StackedDisksModel.py

    rf9bf661 r7ad9887  
    5757        self.name = "StackedDisksModel" 
    5858        ## Model description 
    59         self.description ="""""" 
     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""" 
    6068        
    6169                ## Parameter details [units, min, max] 
  • sansmodels/src/sans/models/TriaxialEllipsoidModel.py

    rf9bf661 r7ad9887  
    5454        self.name = "TriaxialEllipsoidModel" 
    5555        ## Model description 
    56         self.description =""" Note: 
    57                 Constraints must be applied during fitting to ensure that the inequality a<b<c is not 
    58                 violated. The calculation will not report an error, but the results will not be correct.""" 
     56        self.description ="""Note: During fitting ensure that the inequality A<B<C is not 
     57                violated. Otherwise the calculation will 
     58                not be correct.""" 
    5959        
    6060                ## Parameter details [units, min, max] 
  • sansmodels/src/sans/models/VesicleModel.py

    rf9bf661 r7ad9887  
    5151        self.name = "VesicleModel" 
    5252        ## Model description 
    53         self.description ="""Model parameters:  radius : core radius of the vesicle 
    54                 thickness: shell thickness 
    55                 core_sld: core scattering length density 
    56                 shell_sld: shell scattering length density 
     53        self.description ="""Model parameters:    radius : the core radius of the vesicle 
     54                thickness: the shell thickness 
     55                core_sld: the core SLD 
     56                shell_sld: the shell SLD 
    5757                background: incoherent background 
    5858                scale : scale factor""" 
  • sansmodels/src/sans/models/c_extensions/elliptical_cylinder.h

    r26e4a24 r7ad9887  
    55 * [PYTHONCLASS] = EllipticalCylinderModel 
    66 * [DISP_PARAMS] = r_minor, r_ratio, length, cyl_theta, cyl_phi, cyl_psi 
    7  * [DESCRIPTION] = Please see details... 
     7 * [DESCRIPTION] = <text> Model parameters: r_minor = the radius of minor axis of the cross section 
     8r_ratio = the ratio of (r_major /r_minor >= 1) 
     9length = the length of the cylinder 
     10contrast = SLD of solvent - SLD of the cylinder 
     11background = incoherent background 
     12  *</text> 
    813 * [FIXED]= <text> cyl_phi.width; 
    9  * cyl_theta.width; cyl_psi.width; length.width; r_minor.width; r_ratio.width  
     14 * cyl_theta.width; cyl_psi.width; length.width; r_minor.width; r_ratio.width 
    1015 *</text> 
    1116 * [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

    re2afadf r7ad9887  
    77 //[PYTHONCLASS] = HollowCylinderModel 
    88 //[DISP_PARAMS] = core_radius, radius, length, axis_theta, axis_phi 
    9  //[DESCRIPTION] = <text></text> 
     9 //[DESCRIPTION] = <text> P(q) = scale*<f*f>/Vol + bkg, where f is the scattering amplitude. 
     10 //                                     core_radius = the radius of core 
     11 //                             radius = the radius of shell 
     12 //                     length = the total length of the cylinder 
     13 //                             contrast = SLD of solvent - SLD of shell 
     14 //                             background = incoherent background 
     15 //     </text> 
    1016 //[FIXED]= <text> axis_phi.width; axis_theta.width; length.width;core_radius.width; radius</text> 
    1117 //[ORIENTATION_PARAMS]= axis_phi; axis_theta;axis_phi.width; axis_theta.width 
  • sansmodels/src/sans/models/c_extensions/stacked_disks.h

    r975ec8e r7ad9887  
    88 * [PYTHONCLASS] = StackedDisksModel 
    99 * [DISP_PARAMS] = core_thick, layer_thick, radius, axis_theta, axis_phi 
    10    [DESCRIPTION] = <text> 
     10   [DESCRIPTION] = <text> One layer of disk consists of a core, a top layer, and a bottom layer. 
     11                radius =  the radius of the disk 
     12                core_thick = thickness of the core 
     13                layer_thick = thickness of a layer 
     14                core_sld = the SLD of the core 
     15                layer_sld = the SLD of the layers 
     16                n_stacking = the number of the disks 
     17                sigma_d =  Gaussian STD of d-spacing 
     18                solvent_sld = the SLD of the solvent 
    1119                </text> 
    1220        [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

    r3c102d4 r7ad9887  
    44 * [PYTHONCLASS] = TriaxialEllipsoidModel 
    55 * [DISP_PARAMS] = axis_theta, axis_phi, axis_psi 
    6    [DESCRIPTION] = <text> Note: 
    7                                         Constraints must be applied during fitting to ensure that the inequality a<b<c is not 
    8                                                   violated. The calculation will not report an error, but the results will not be correct. 
    9                                    </text> 
     6        [DESCRIPTION] = <text>Note: During fitting ensure that the inequality A<B<C is not 
     7        violated. Otherwise the calculation will 
     8        not be correct. 
     9        </text> 
    1010        [FIXED]= <text>axis_psi.width; axis_phi.width; axis_theta.width; semi_axisA.width; semi_axisB.width; semi_axisC.width </text> 
    1111        [ORIENTATION_PARAMS]= <text>axis_psi; axis_phi; axis_theta; axis_psi.width; axis_phi.width; axis_theta.width</text> 
    12  
    13  
    1412 **/ 
    1513typedef struct { 
  • sansmodels/src/sans/models/c_extensions/vesicle.h

    re2afadf r7ad9887  
    66[PYTHONCLASS] = VesicleModel 
    77[DISP_PARAMS] = radius,thickness 
    8 [DESCRIPTION] =<text>Model parameters:  radius : core radius of the vesicle 
    9                 thickness: shell thickness 
    10                 core_sld: core scattering length density 
    11                 shell_sld: shell scattering length density 
     8[DESCRIPTION] =<text>Model parameters:    radius : the core radius of the vesicle 
     9                thickness: the shell thickness 
     10                core_sld: the core SLD 
     11                shell_sld: the shell SLD 
    1212                background: incoherent background 
    1313                scale : scale factor 
Note: See TracChangeset for help on using the changeset viewer.