Changeset ecc58e72 in sasview for sansmodels/src/sans

Timestamp:

Aug 7, 2009 9:17:18 PM (15 years ago)

Author:

Mathieu Doucet <doucetm@…>

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:

d9dc518

Parents:

26e4a24

Message:

sansmodels: changed BaseComponent?.evalDistribution to match the C API. Documented the API. Added unit tests to test the output against the existing methods.

Location:

sansmodels/src/sans/models

Files:

• BaseComponent.py (modified) (1 diff)
• test/utest_evaldist.py (added)

sansmodels/src/sans/models/BaseComponent.py

@@ -60 +60 @@
         """
             Evaluate a distribution of q-values.
-            A list of either scale q-values or [qx,qy] doublets
-            are assumed. The allowed data types for the doublets are 
-            the same as for run() and runXY().
-            
-            Since the difference between scale and vector q-values
-            are dealt with in runXY(), we pass along the values
-            as-is.
-            
-            @param qdist: list of scalar q-values or list of [qx,qy] doublets 
-        """
-        q_array = numpy.asarray(qdist)
-        iq_array = numpy.zeros(len(q_array))
-        for i in xrange(len(q_array)):
-            iq_array[i] = self.runXY(q_array[i])
-            
-        return iq_array
+            
+            * 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].
+            
+            For the following matrix of q_values [qx,qy], we will have:
+                      +--------+--------+--------+
+            qy[2]     |        |        |        | 
+                      +--------+--------+--------+
+            qy[1]     |        |        |        |
+                      +--------+--------+--------+            
+            qy[0]     |        |        |        | 
+                      +--------+--------+--------+
+                        qx[0]    qx[1]    qx[2]
+
+
+            The q-values must be stored in numpy arrays.
+            The qxprime and qyprime are 2D arrays. From the two lists of q-values 
+            above, numpy arrays must be created the following way:
+
+            qx_prime = numpy.reshape(qx, [3,1])
+            qy_prime = numpy.reshape(qy, [1,3])
+            
+            The method is then called the following way:
+            
+            evalDistribution([qx_prime, qy_prime])
+            
+            @param qdist: ndarray of scalar q-values or list [qx,qy] where qx,qy are 2D ndarrays 
+        """
+        if qdist.__class__.__name__ == 'list':
+            # Check whether we have a list of ndarrays [qx,qy]
+            if len(qdist)!=2 or \
+                qdist[0].__class__.__name__ != 'ndarray' or \
+                qdist[1].__class__.__name__ != 'ndarray':
+                    raise RuntimeError, "evalDistribution expects a list of 2 ndarrays"
+                
+            # Extract qx and qy for code clarity
+            qx = qdist[0]
+            qy = qdist[1]
+            
+            # Create output array
+            iq_array = numpy.zeros([qx.shape[0], qy.shape[1]])
+             
+            for i in range(qx.shape[0]):
+                for j in range(qy.shape[1]):
+                    iq_array[i][j] = self.runXY([qx[i][0],qy[0][j]])
+            return iq_array
+                
+        elif qdist.__class__.__name__ == 'ndarray':
+                # We have a simple 1D distribution of q-values
+                iq_array = numpy.zeros(len(qdist))
+                for i in range(len(qdist)):
+                    iq_array[i] = self.runXY(qdist[i])
+                return iq_array
+            
+        else:
+            mesg = "evalDistribution is expecting an ndarray of scalar q-values"
+            mesg += " or a list [qx,qy] where qx,qy are 2D ndarrays."
+            raise RuntimeError, mesg
     
     def clone(self):