Ignore:
Timestamp:
Jun 4, 2010 5:04:49 PM (14 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:
5062bbf
Parents:
7116b6e0
Message:

working on documentation

File:
1 edited

Legend:

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

    rf9a1279 r79ac6f8  
    11#!/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. 
    62 
    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: 
     3############################################################################## 
     4#       This software was developed by the University of Tennessee as part of the 
     5#       Distributed Data Analysis of Neutron Scattering Experiments (DANSE) 
     6#       project funded by the US National Science Foundation. 
     7# 
     8#       If you use DANSE applications to do scientific research that leads to 
     9#       publication, we ask that you acknowledge the use of the software with the 
     10#       following sentence: 
     11# 
     12#       "This work benefited from DANSE software developed under NSF award DMR-0520547." 
     13# 
     14#       copyright 2008, University of Tennessee 
     15############################################################################## 
    1016 
    11         "This work benefited from DANSE software developed under NSF award DMR-0520547." 
    1217 
    13         copyright 2008, University of Tennessee 
    14 """ 
     18"""  
     19Provide functionality for a C extension model 
    1520 
    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\lamellarFF_HG.h 
    20                  AND RE-RUN THE GENERATOR SCRIPT 
     21:WARNING: THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY 
     22         DO NOT MODIFY THIS FILE, MODIFY ..\c_extensions\lamellarFF_HG.h 
     23         AND RE-RUN THE GENERATOR SCRIPT 
    2124 
    2225""" 
     
    2730     
    2831class LamellarFFHGModel(CLamellarFFHGModel, BaseComponent): 
    29     """ Class that evaluates a LamellarFFHGModel model.  
    30         This file was auto-generated from ..\c_extensions\lamellarFF_HG.h. 
    31         Refer to that file and the structure it contains 
    32         for details of the model. 
    33         List of default parameters: 
     32    """  
     33    Class that evaluates a LamellarFFHGModel model.  
     34    This file was auto-generated from ..\c_extensions\lamellarFF_HG.h. 
     35    Refer to that file and the structure it contains 
     36    for details of the model. 
     37    List of default parameters: 
    3438         scale           = 1.0  
    3539         t_length        = 15.0 [A] 
     
    8286         
    8387    def __getstate__(self): 
    84         """ return object state for pickling and copying """ 
     88        """ 
     89        return object state for pickling and copying 
     90        """ 
    8591        model_state = {'params': self.params, 'dispersion': self.dispersion, 'log': self.log} 
    8692         
     
    8894         
    8995    def __setstate__(self, state): 
    90         """ create object from pickled state """ 
     96        """ 
     97        create object from pickled state 
     98         
     99        :param state: the state of the current model 
     100         
     101        """ 
    91102         
    92103        self.__dict__, model_state = state 
     
    96107         
    97108    
    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) 
     109    def run(self, x=0.0): 
     110        """  
     111        Evaluate the model 
     112         
     113        :param x: input q, or [q,phi] 
     114         
     115        :return: scattering function P(q) 
     116         
    102117        """ 
    103118         
    104119        return CLamellarFFHGModel.run(self, x) 
    105120    
    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) 
     121    def runXY(self, x=0.0): 
     122        """  
     123        Evaluate the model in cartesian coordinates 
     124         
     125        :param x: input q, or [qx, qy] 
     126         
     127        :return: scattering function P(q) 
     128         
    110129        """ 
    111130         
    112131        return CLamellarFFHGModel.runXY(self, x) 
    113132         
    114     def evalDistribution(self, x = []): 
    115         """ Evaluate the model in cartesian coordinates 
    116             @param x: input q[], or [qx[], qy[]] 
    117             @return: scattering function P(q[]) 
     133    def evalDistribution(self, x=[]): 
     134        """  
     135        Evaluate the model in cartesian coordinates 
     136         
     137        :param x: input q[], or [qx[], qy[]] 
     138         
     139        :return: scattering function P(q[]) 
     140         
    118141        """ 
    119142        return CLamellarFFHGModel.evalDistribution(self, x) 
    120143         
    121144    def calculate_ER(self): 
    122         """ Calculate the effective radius for P(q)*S(q) 
    123             @return: the value of the effective radius 
     145        """  
     146        Calculate the effective radius for P(q)*S(q) 
     147         
     148        :return: the value of the effective radius 
     149         
    124150        """        
    125151        return CLamellarFFHGModel.calculate_ER(self) 
     
    127153    def set_dispersion(self, parameter, dispersion): 
    128154        """ 
    129             Set the dispersion object for a model parameter 
    130             @param parameter: name of the parameter [string] 
    131             @dispersion: dispersion object of type DispersionModel 
     155        Set the dispersion object for a model parameter 
     156         
     157        :param parameter: name of the parameter [string] 
     158        :param dispersion: dispersion object of type DispersionModel 
     159         
    132160        """ 
    133161        return CLamellarFFHGModel.set_dispersion(self, parameter, dispersion.cdisp) 
Note: See TracChangeset for help on using the changeset viewer.