Changeset 6970e51 in sasview for src/sas/sascalc


Ignore:
Timestamp:
Jul 11, 2016 4:36:55 AM (8 years ago)
Author:
lewis
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, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
dc72638
Parents:
54a0989
git-author:
Lewis O'Driscoll <lewis.o'driscoll@…> (07/07/16 12:05:12)
git-committer:
Lewis O'Driscoll <lewis.o'driscoll@…> (07/11/16 04:36:55)
Message:

Add some docstrings

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/sas/sascalc/corfunc/corfunc_calculator.py

    r911dbe4 r6970e51  
    109109 
    110110    def compute_extrapolation(self): 
     111        """ 
     112        Extrapolate and interpolate scattering data 
     113 
     114        :return: The extrapolated data 
     115        """ 
    111116        q = self._data.x 
    112117        iq = self._data.y 
     
    123128        """ 
    124129        Transform an extrapolated scattering curve into a correlation function. 
     130 
     131        :param extrapolation: The extrapolated data 
     132        :param background: The background value (if not provided, previously 
     133            calculated value will be used) 
     134        :return: The transformed data 
    125135        """ 
    126136        qs = extrapolation.x 
     
    154164 
    155165    def _fit_data(self, q, iq): 
    156         """Given a data set, extrapolate out to large q with Porod 
    157         and to q=0 with Guinier""" 
     166        """ 
     167        Given a data set, extrapolate out to large q with Porod and 
     168        to q=0 with Guinier 
     169        """ 
    158170        mask = np.logical_and(q > self.upperq[0], q < self.upperq[1]) 
    159171 
Note: See TracChangeset for help on using the changeset viewer.