[multi_tag] Add docstrings and test and fix bugs for sort np.array

Author: hkchekc

nixworks/multi_tag.py

@@ -39,14 +39,22 @@ def _in_range(point, start, end):
 
 
 def _sorting(starts, ends):  # li is the start values
+    starts = starts.tolist()
+    ends = ends.tolist()
     sort = [i for i in sorted(enumerate(starts), key=lambda s: s[1])]
     sorted_starts = np.array([s[1] for s in sort])
     sorted_ends = np.array([ends[s[0]] for s in sort])
     return sorted_starts, sorted_ends
 
 
 def union(ref, multi_tags):
-    # now the simple case of 2 tags
+    """
+    Function to return the (non-overlapping) union of area tagged by multiple Tags
+    or MultiTags of a specified DataArray.
+    :param ref: the referenced array
+    :param multi_tags: Tags or MultiTags that point to the tagged data
+    :return: a list of DataViews
+    """
     _check_valid(multi_tags, ref)
     if not isinstance(ref, nix.DataArray):
         ref = multi_tags[0].references[ref]
@@ -56,7 +64,7 @@ def union(ref, multi_tags):
     end_list = []
     for i, st in enumerate(starts):  # check if any duplicate
         covered = False
-        for ti, tmp_st, tmp_ed in enumerate(zip(start_list, end_list)):
+        for ti, (tmp_st, tmp_ed) in enumerate(zip(start_list, end_list)):
             if _in_range(st, tmp_st, tmp_ed) or _in_range(ends[i], tmp_st, tmp_ed):
                 covered = True
                 if not _in_range(ends[i], tmp_st, tmp_ed):  # ends[i] > tmp_ed
@@ -75,6 +83,12 @@ def union(ref, multi_tags):
 
 
 def intersection(ref, multi_tags):
+    """
+    Function to return the overlapping area in a specified DataArray tagged by multiple Tags/MultiTags.
+    :param ref: the referenced array
+    :param multi_tags: Tags or MultiTags that point to the tagged data
+    :return: a DataView
+    """
     _check_valid(multi_tags, ref)
     if not isinstance(ref, nix.DataArray):
         ref = multi_tags[0].references[ref]

nixworks/test/test_multi_tag.py

@@ -37,16 +37,21 @@ def test_two_1d(self):
         t2.extent = [5]
         i = intersection(self.ref1d, [t1,t2])
         assert i is None
+        u = union(self.ref1d, [t1,t2])
+        np.testing.assert_array_equal(u[0], self.arr1d[0:6])
+        np.testing.assert_array_equal(u[1], self.arr1d[10:16])
         # intersected
         t1.extent = [12]
         i = intersection(self.ref1d, [t1,t2])
         np.testing.assert_array_almost_equal(np.array(i), self.arr1d[10:13])
+        u = union(self.ref1d, [t1,t2])
+        np.testing.assert_array_equal(u[0], self.arr1d[0:16])
         # covered
         t1.extent = [30]
         i = intersection(self.ref1d, [t1,t2])
         np.testing.assert_array_almost_equal(np.array(i), t2.tagged_data(0)[:])
-        # union
-        # u = union(self.ref1d, [t1,t2])
+        u = union(self.ref1d, [t1,t2])
+        np.testing.assert_array_equal(u[0], t1.tagged_data(0)[:])
 
     def test_multi_nd(self):
         d = np.zeros((2, 3))
@@ -68,5 +73,7 @@ def test_multi_nd(self):
         i = intersection(self.ref3d, [t1,t2])
         np.testing.assert_array_almost_equal(i[:], self.arr3d[3,3,3])
         # union
-        # u = union(self.ref3d, [t1])
-
+        u = union(self.ref3d, [t1])
+        np.testing.assert_array_almost_equal(u[0][:], self.arr3d[0:5, 0:5, 0:5])
+        u = union(self.ref3d, [t1, t2])
+        np.testing.assert_array_almost_equal(u[0][:], self.arr3d[0:6, 0:6, 0:6])