Update Rostock WFS array data (coordinates, weights), adding mgeier suggestions

-Old "university_rostock.csv" as of 2015 is "wfs_university_rostock_2015.csv"
now. New measurement data of december 2018 is stored in
"wfs_university_rostock_2018" and now includes absolute height (z coordinate,
KH120 logo) and weights of the 64 loudspeakers.

-also updated the examples/sound_field_synthesis.py to work with the new file

-also added WFS array example in array docu

Author: fs446

data/arrays/university_rostock.csv renamed to data/arrays/wfs_university_rostock_2015.csv

@@ -0,0 +1,64 @@
+1.8555,0.12942,1.6137,-1,0,0,0.1877
+1.8604,0.31567,1.6137,-1,0,0,0.2045
+1.8638,0.53832,1.6133,-1,0,0,0.22837
+1.8665,0.77237,1.6118,-1,0,0,0.24117
+1.8673,1.0206,1.6157,-1,0,0,0.24838
+1.8688,1.2691,1.6154,-1,0,0,0.23781
+1.8702,1.4962,1.6167,-1,0,0,0.20929
+1.8755,1.6876,1.6163,-1,0,0,0.22679
+1.6875,1.8702,1.6203,0,-1,0,0.22545
+1.4993,1.8843,1.6154,0,-1,0,0.21679
+1.2547,1.8749,1.6174,0,-1,0,0.23875
+1.022,1.8768,1.6184,0,-1,0,0.23992
+0.77488,1.8763,1.6175,0,-1,0,0.2349
+0.55221,1.8775,1.6177,0,-1,0,0.2327
+0.3095,1.8797,1.6157,0,-1,0,0.24573
+0.060789,1.882,1.6134,0,-1,0,0.21554
+-0.12151,1.8841,1.6101,0,-1,0,0.18685
+-0.31278,1.8791,1.613,0,-1,0,0.20506
+-0.53142,1.8855,1.6099,0,-1,0,0.22562
+-0.76382,1.8905,1.6061,0,-1,0,0.23945
+-1.0102,1.8888,1.6101,0,-1,0,0.25042
+-1.2646,1.8911,1.6086,0,-1,0,0.23947
+-1.4891,1.8936,1.607,0,-1,0,0.20807
+-1.6807,1.8964,1.6062,0,-1,0,0.22572
+-1.8625,1.7108,1.6075,1,0,0,0.22016
+-1.863,1.5303,1.6066,1,0,0,0.21877
+-1.8611,1.2733,1.6107,1,0,0,0.2448
+-1.8653,1.0408,1.6075,1,0,0,0.23885
+-1.8729,0.79578,1.6054,1,0,0,0.23437
+-1.8704,0.5722,1.6071,1,0,0,0.23219
+-1.881,0.33166,1.6053,1,0,0,0.24605
+-1.8783,0.080365,1.6075,1,0,0,0.21801
+-1.8781,-0.10434,1.6061,1,0,0,0.1852
+-1.8798,-0.28999,1.609,1,0,0,0.20278
+-1.8842,-0.50982,1.6095,1,0,0,0.22814
+-1.8911,-0.74608,1.6054,1,0,0,0.23945
+-1.8901,-0.98854,1.6102,1,0,0,0.24439
+-1.8928,-1.2348,1.6095,1,0,0,0.24209
+-1.8925,-1.4727,1.6117,1,0,0,0.21306
+-1.8939,-1.6609,1.6115,1,0,0,0.22209
+-1.7127,-1.8417,1.611,0,1,0,0.21959
+-1.5295,-1.8417,1.6129,0,1,0,0.21598
+-1.2809,-1.8485,1.6079,0,1,0,0.24212
+-1.0454,-1.8478,1.6094,0,1,0,0.2401
+-0.80072,-1.8512,1.609,0,1,0,0.23619
+-0.57305,-1.8524,1.6082,0,1,0,0.23437
+-0.33198,-1.8525,1.6074,0,1,0,0.24395
+-0.085164,-1.854,1.6085,0,1,0,0.21792
+0.10383,-1.8571,1.6082,0,1,0,0.18649
+0.28774,-1.8609,1.6061,0,1,0,0.20288
+0.50951,-1.8574,1.6049,0,1,0,0.22772
+0.74305,-1.8643,1.6034,0,1,0,0.23983
+0.989,-1.8695,1.6036,0,1,0,0.24802
+1.239,-1.8649,1.6041,0,1,0,0.24388
+1.4767,-1.8678,1.6054,0,1,0,0.20977
+1.6585,-1.8653,1.6059,0,1,0,0.22148
+1.8436,-1.6811,1.6054,-1,0,0,0.22264
+1.8563,-1.4974,1.6033,-1,0,0,0.21688
+1.8468,-1.248,1.6072,-1,0,0,0.24047
+1.85,-1.0167,1.6076,-1,0,0,0.23909
+1.8513,-0.76986,1.6101,-1,0,0,0.23739
+1.8585,-0.54207,1.6076,-1,0,0,0.23585
+1.8562,-0.29831,1.6107,-1,0,0,0.24122
+1.857,-0.059658,1.6121,-1,0,0,0.21387

data/arrays/wfs_university_rostock_2018.csv

@@ -33,7 +33,9 @@
 #x0, n0, a0 = sfs.array.linear_random(N, 0.2*dx, 5*dx)
 #x0, n0, a0 = sfs.array.rectangular(N, dx, orientation=sfs.util.direction_vector(0*np.pi/4, np.pi/2))
 #x0, n0, a0 = sfs.array.circular(N, R)
-x0, n0, a0 = sfs.array.load('../../data/arrays/university_rostock.csv')
+x0, n0, a0 = sfs.array.load('../../data/arrays/wfs_university_rostock_2018.csv')
+x0[:,2] = 0  # in wfs_university_rostock_2018.csv we encode absolute height
+# which is not used here, we also could set the grid coordinate to z=1.615 m
 
 #x0, n0, a0 = sfs.array.planar(N, dx, orientation=sfs.util.direction_vector(np.radians(0),np.radians(180)))
 #x0, n0, a0 = sfs.array.cube(N, dx, orientation=sfs.util.direction_vector(0, np.pi/2))

doc/examples/sound_field_synthesis.py

@@ -15,7 +15,7 @@
 
 
 class ArrayData(namedtuple('ArrayData', 'x n a')):
-    """Get named tuple returned by array functions.
+    """Named tuple returned by array functions.
 
     See `collections.namedtuple`.
 
@@ -43,7 +43,7 @@ def take(self, indices):
 
 
 def linear(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
-    """Get linear, equidistantly sampled secondary source distribution.
+    """Return linear, equidistantly sampled secondary source distribution.
 
     Parameters
     ----------
@@ -78,7 +78,7 @@ def linear(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
 
 
 def linear_diff(distances, center=[0, 0, 0], orientation=[1, 0, 0]):
-    """Get linear secondary source distribution from a list of distances.
+    """Return linear secondary source distribution from a list of distances.
 
     Parameters
     ----------
@@ -112,7 +112,7 @@ def linear_diff(distances, center=[0, 0, 0], orientation=[1, 0, 0]):
 
 def linear_random(N, min_spacing, max_spacing, center=[0, 0, 0],
                   orientation=[1, 0, 0], seed=None):
-    """Get randomly sampled linear array.
+    """Return randomly sampled linear array.
 
     Parameters
     ----------
@@ -136,11 +136,14 @@ def linear_random(N, min_spacing, max_spacing, center=[0, 0, 0],
     .. plot::
         :context: close-figs
 
-        x0, n0, a0 = sfs.array.linear_random(12, 0.15, 0.4, orientation=[0, -1, 0])
+        x0, n0, a0 = sfs.array.linear_random(
+            N=12,
+            min_spacing=0.15, max_spacing=0.4,
+            orientation=[0, -1, 0])
         sfs.plot.loudspeaker_2d(x0, n0, a0)
         plt.axis('equal')
         plt.xlabel('x / m')
-        plt.ylabel('y / m')        
+        plt.ylabel('y / m')
 
     """
     r = np.random.RandomState(seed)
@@ -149,7 +152,7 @@ def linear_random(N, min_spacing, max_spacing, center=[0, 0, 0],
 
 
 def circular(N, R, center=[0, 0, 0]):
-    """Get circular secondary source distribution parallel to the xy-plane.
+    """Return circular secondary source distribution parallel to the xy-plane.
 
     Parameters
     ----------
@@ -191,7 +194,7 @@ def circular(N, R, center=[0, 0, 0]):
 
 
 def rectangular(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
-    """Get rectangular secondary source distribution.
+    """Return rectangular secondary source distribution.
 
     Parameters
     ----------
@@ -239,7 +242,8 @@ def rectangular(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
 
 
 def rounded_edge(Nxy, Nr, dx, center=[0, 0, 0], orientation=[1, 0, 0]):
-    """Get secondary source distribution along the xy-axis with rounded edge at the origin.
+    """Return secondary source distribution along the xy-axis with rounded
+    edge at the origin.
 
     Parameters
     ----------
@@ -313,7 +317,8 @@ def rounded_edge(Nxy, Nr, dx, center=[0, 0, 0], orientation=[1, 0, 0]):
 
 
 def edge(Nxy, dx, center=[0, 0, 0], orientation=[1, 0, 0]):
-    """Get secondary source distribution along the xy-axis with sharp edge at the origin.
+    """Return secondary source distribution along the xy-axis with sharp
+    edge at the origin.
 
     Parameters
     ----------
@@ -365,7 +370,7 @@ def edge(Nxy, dx, center=[0, 0, 0], orientation=[1, 0, 0]):
 
 
 def planar(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
-    """Get planar secondary source distribtion.
+    """Return planar secondary source distribtion.
 
     Parameters
     ----------
@@ -389,7 +394,9 @@ def planar(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
     .. plot::
         :context: close-figs
 
-        x0, n0, a0 = sfs.array.planar((4,3), 0.5, center=[0, 0, 0], orientation=[0, 0, 1])
+        x0, n0, a0 = sfs.array.planar(
+            N=(4,3), spacing=0.5,
+            center=[0, 0, 0], orientation=[0, 0, 1])
         sfs.plot.loudspeaker_2d(x0, n0, a0)
         plt.axis('equal')
         plt.xlabel('x / m')
@@ -409,7 +416,7 @@ def planar(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
 
 
 def cube(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
-    """Get cube-shaped secondary source distribtion.
+    """Return cube-shaped secondary source distribtion.
 
     Parameters
     ----------
@@ -433,7 +440,9 @@ def cube(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
     .. plot::
         :context: close-figs
 
-        x0, n0, a0 = sfs.array.cube(2, 0.5, center=[0, 0, 0], orientation=[1, 0, 0])
+        x0, n0, a0 = sfs.array.cube(
+            N=2, spacing=0.5,
+            center=[0, 0, 0], orientation=[1, 0, 0])
         sfs.plot.loudspeaker_2d(x0, n0, a0)
         plt.axis('equal')
         plt.xlabel('x / m')
@@ -462,8 +471,8 @@ def cube(N, spacing, center=[0, 0, 0], orientation=[1, 0, 0]):
 def sphere_load(file, radius, center=[0, 0, 0]):
     """Load spherical secondary source distribution from file.
 
-    ASCII Format (see MATLAB SFS Toolbox) with 4 numbers (3 for the cartesian 
-    position vector, 1 for the integration weight) per secondary source located 
+    ASCII Format (see MATLAB SFS Toolbox) with 4 numbers (3 for the cartesian
+    position vector, 1 for the integration weight) per secondary source located
     on the unit circle which is resized by the given radius and shifted to the
     given center.
 
@@ -474,7 +483,7 @@ def sphere_load(file, radius, center=[0, 0, 0]):
 
     Examples
     --------
-    content of `example_array_6LS_3D.txt` 
+    content of example_array_6LS_3D.txt
     ::
         1 0 0 1
         -1 0 0 1
@@ -489,12 +498,15 @@ def sphere_load(file, radius, center=[0, 0, 0]):
     .. plot::
         :context: close-figs
 
-        x0, n0, a0 = sfs.array.sphere_load('../data/arrays/example_array_6LS_3D.txt', radius=2, center=[0, 0, 0])
+        x0, n0, a0 = sfs.array.sphere_load(
+            '../data/arrays/example_array_6LS_3D.txt',
+            radius=2,
+            center=[0, 0, 0])
         sfs.plot.loudspeaker_2d(x0, n0, a0, size=0.25)
         plt.axis('equal')
         plt.xlabel('x / m')
         plt.ylabel('y / m')
-        plt.title('view onto xy-plane')        
+        plt.title('view onto xy-plane')
 
     """
     data = np.loadtxt(file)
@@ -509,7 +521,7 @@ def load(file, center=[0, 0, 0], orientation=[1, 0, 0]):
     """Load secondary source distribution from file.
 
     Comma Separated Values (CSV) format with 7 values
-    (3 for the cartesian position vector, 3 for the cartesian inward normal 
+    (3 for the cartesian position vector, 3 for the cartesian inward normal
     vector, 1 for the integration weight) per secondary source.
 
     Returns
@@ -519,7 +531,7 @@ def load(file, center=[0, 0, 0], orientation=[1, 0, 0]):
 
     Examples
     --------
-    content of `example_array_4LS_2D.csv`
+    content of example_array_4LS_2D.csv
     ::
         1,0,0,-1,0,0,1
         0,1,0,0,-1,0,1
@@ -538,6 +550,17 @@ def load(file, center=[0, 0, 0], orientation=[1, 0, 0]):
         plt.xlabel('x / m')
         plt.ylabel('y / m')
 
+    .. plot::
+        :context: close-figs
+
+        x0, n0, a0 = sfs.array.load(
+            '../data/arrays/wfs_university_rostock_2018.csv')
+        sfs.plot.loudspeaker_2d(x0, n0, a0)
+        plt.axis('equal')
+        plt.xlabel('x / m')
+        plt.ylabel('y / m')
+        plt.title('top view of 64 channel WFS system at university of Rostock')
+
     """
     data = np.loadtxt(file, delimiter=',')
     positions, normals, weights = data[:, :3], data[:, 3:6], data[:, 6]
@@ -574,7 +597,7 @@ def weights_midpoint(positions, closed):
     >>> import sfs
     >>> x0, n0, a0 = sfs.array.circular(2**5, 1)
     >>> a = sfs.array.weights_midpoint(x0, closed=True)
-    >>> print(max(abs(a0-a)))
+    >>> max(abs(a0-a))
     0.0003152601902411123
 
     """
@@ -616,7 +639,8 @@ def concatenate(*arrays):
     Returns
     -------
     `ArrayData`
-        Positions, orientations and weights of the concatenated secondary sources.
+        Positions, orientations and weights
+        of the concatenated secondary sources.
 
     Examples
     --------