Changeset fb3f9af in sasview for src/sas/models


Ignore:
Timestamp:
Jul 26, 2015 6:28:26 PM (9 years ago)
Author:
butler
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:
ae2a197
Parents:
1f5f206
Message:

Fixes more sphinx doc build errors

Location:
src/sas/models
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • src/sas/models/MultiplicationModel.py

    rac7be54 rfb3f9af  
    1010        which will be calculated from P(Q) via calculate_ER(),  
    1111        and 2) 'scale' in P model which is synchronized w/ volfraction in S  
    12         then P*S is multiplied by a new param, 'scale_factor'. 
     12        then P*S is multiplied by a new parameter, 'scale_factor'. 
    1313        The polydispersion is applicable only to P(Q), not to S(Q). 
    14         Note: P(Q) refers to 'form factor' model while S(Q) does to 'structure factor'. 
     14 
     15        .. note:: P(Q) refers to 'form factor' model while S(Q) does to 'structure factor'. 
    1516    """ 
    1617    def __init__(self, p_model, s_model ): 
     
    8182    def _clone(self, obj): 
    8283        """ 
    83             Internal utility function to copy the internal 
    84             data members to a fresh copy. 
     84        Internal utility function to copy the internal data members to a 
     85        fresh copy. 
    8586        """ 
    8687        obj.params     = copy.deepcopy(self.params) 
     
    9697    def _set_dispersion(self): 
    9798        """ 
    98            combined the two models dispersions 
    99            Polydispersion should not be applied to s_model 
     99        combine the two models' dispersions. Polydispersity should not be 
     100        applied to s_model 
    100101        """ 
    101102        ##set dispersion only from p_model  
     
    107108        Get SLD profile of p_model if exists 
    108109         
    109         : return: (r, beta) where r is a list of radius of the transition points 
    110                 beta is a list of the corresponding SLD values  
    111         : Note: This works only for func_shell num = 2 (exp function). 
     110        :return: (r, beta) where r is a list of radius of the transition points\ 
     111                beta is a list of the corresponding SLD values 
     112 
     113        .. note:: This works only for func_shell num = 2 (exp function). 
    112114        """ 
    113115        try: 
     
    121123    def _set_params(self): 
    122124        """ 
    123             Concatenate the parameters of the two models to create 
    124             this model parameters  
     125        Concatenate the parameters of the two models to create 
     126        these model parameters  
    125127        """ 
    126128 
     
    141143    def _set_details(self): 
    142144        """ 
    143             Concatenate details of the two models to create 
    144             this model details  
     145        Concatenate details of the two models to create 
     146        this model's details  
    145147        """ 
    146148        for name, detail in self.p_model.details.iteritems(): 
     
    154156    def _set_scale_factor(self): 
    155157        """ 
    156             Set scale=volfraction to P model 
     158        Set scale=volfraction for P model 
    157159        """ 
    158160        value = self.params['volfraction'] 
     
    168170    def _set_effect_radius(self): 
    169171        """ 
    170             Set effective radius to S(Q) model 
     172        Set effective radius to S(Q) model 
    171173        """ 
    172174        if not 'effect_radius' in self.s_model.params.keys(): 
     
    206208    def _setParamHelper(self, name, value): 
    207209        """ 
    208             Helper function to setparam 
     210        Helper function to setparam 
    209211        """ 
    210212        # Look for dispersion parameters 
     
    229231    def _set_fixed_params(self): 
    230232        """ 
    231              fill the self.fixed list with the p_model fixed list 
     233        Fill the self.fixed list with the p_model fixed list 
    232234        """ 
    233235        for item in self.p_model.fixed: 
     
    240242        """  
    241243        Evaluate the model 
     244         
    242245        :param x: input q-value (float or [float, float] as [r, theta]) 
    243246        :return: (scattering function value) 
     
    250253 
    251254    def runXY(self, x = 0.0): 
    252         """ Evaluate the model 
    253             @param x: input q-value (float or [float, float] as [qx, qy]) 
    254             @return: scattering function value 
     255        """  
     256        Evaluate the model 
     257         
     258        :param x: input q-value (float or [float, float] as [qx, qy]) 
     259        :return: scattering function value 
    255260        """   
    256261        # set effective radius and scaling factor before run 
     
    266271        """  
    267272        Evaluate the model in cartesian coordinates 
     273         
    268274        :param x: input q[], or [qx[], qy[]] 
    269275        :return: scattering function P(q[]) 
     
    279285        """ 
    280286        Set the dispersion object for a model parameter 
     287         
    281288        :param parameter: name of the parameter [string] 
    282289        :dispersion: dispersion object of type DispersionModel 
     
    293300    def fill_description(self, p_model, s_model): 
    294301        """ 
    295             Fill the description for P(Q)*S(Q) 
     302        Fill the description for P(Q)*S(Q) 
    296303        """ 
    297304        description = "" 
  • src/sas/models/sas_extension/__init__.py

    r79492222 rfb3f9af  
     1""" 
     2This is an empty package - should probably delete 
     3""" 
Note: See TracChangeset for help on using the changeset viewer.