Changeset 51f14603 in sasview for src/sans/models/BaseComponent.py

Timestamp:

Apr 3, 2014 11:37:53 AM (11 years ago)

Author:

Peter Parker

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:

2f2d9d0

Parents:

eea3ffa

Message:

Refs #202 - Fix Sphinx build errors (not including park-1.2.1/). Most warnings remain.

File:

• src/sans/models/BaseComponent.py (modified) (1 diff)

src/sans/models/BaseComponent.py

@@ -96 +96 @@
         Evaluate a distribution of q-values.
         
-        * For 1D, a numpy array is expected as input:
+        * For 1D, a numpy array is expected as input: ::
         
             evalDistribution(q)
             
+          where q is a numpy array.
+        
+        
+        * For 2D, a list of numpy arrays are expected: [qx_prime,qy_prime],
+          where 1D arrays, ::
+        
+              qx_prime = [ qx[0], qx[1], qx[2], ....]
+
+          and ::
+
+              qy_prime = [ qy[0], qy[1], qy[2], ....] 
+        
+        Then get ::
+
+            q = numpy.sqrt(qx_prime^2+qy_prime^2)
+        
+        that is a qr in 1D array; ::
+
+            q = [q[0], q[1], q[2], ....] 
+        
+        ..note::
+          Due to 2D speed issue, no anisotropic scattering 
+          is supported for python models, thus C-models should have
+          their own evalDistribution methods.
+        
+        The method is then called the following way: ::
+        
+            evalDistribution(q)
+
         where q is a numpy array.
         
-        
-        * For 2D, a list of numpy arrays are expected: [qx_prime,qy_prime],
-          where 1D arrays,
-        
-        qx_prime = [ qx[0], qx[1], qx[2], ....]
-        and
-        qy_prime = [ qy[0], qy[1], qy[2], ....] 
-        
-        Then get
-        q = numpy.sqrt(qx_prime^2+qy_prime^2)
-        
-        that is a qr in 1D array;
-        q = [q[0], q[1], q[2], ....] 
-        
-        :Note: Due to 2D speed issue, no anisotropic scattering 
-            is supported for python models, thus C-models should have
-             their own evalDistribution methods.
-        
-        The method is then called the following way:
-        
-        evalDistribution(q)
-        where q is a numpy array.
-        
-        :param qdist: ndarray of scalar q-values or list [qx,qy] 
-                    where qx,qy are 1D ndarrays 
-        
+        :param qdist: ndarray of scalar q-values or list [qx,qy] where qx,qy are 1D ndarrays
         """
         if qdist.__class__.__name__ == 'list':