Added primitives count to the the Actor's polydata

fury/actor.py

@@ -22,7 +22,8 @@
                       PolyDataNormals, Assembly, LODActor, VTK_UNSIGNED_CHAR,
                       PolyDataMapper2D, ScalarBarActor, PolyVertex, CellArray,
                       UnstructuredGrid, DataSetMapper, ConeSource, ArrowSource,
-                      SphereSource, CylinderSource, DiskSource, TexturedSphereSource,
+                      SphereSource, CylinderSource, DiskSource,
+                      TexturedSphereSource,
                       Texture, FloatArray, VTK_TEXT_LEFT, VTK_TEXT_RIGHT,
                       VTK_TEXT_BOTTOM, VTK_TEXT_TOP, VTK_TEXT_CENTERED,
                       TexturedActor2D, TextureMapToPlane, TextActor3D,
@@ -32,7 +33,8 @@
                         set_polydata_vertices, set_polydata_triangles,
                         shallow_copy, rgb_to_vtk, numpy_to_vtk_matrix,
                         repeat_sources, get_actor_from_primitive,
-                        fix_winding_order, numpy_to_vtk_colors, color_check)
+                        fix_winding_order, numpy_to_vtk_colors, color_check,
+                        set_polydata_primitives_count)
 
 
 def slicer(data, affine=None, value_range=None, opacity=1.,
@@ -587,6 +589,10 @@ def streamtube(lines, colors=None, opacity=1, linewidth=0.1, tube_sides=9,
     poly_data, color_is_scalar = lines_to_vtk_polydata(lines, colors)
     next_input = poly_data
 
+    # set primitives count
+    prim_count = len(lines)
+    set_polydata_primitives_count(poly_data, prim_count)
+
     # Set Normals
     poly_normals = set_input(PolyDataNormals(), next_input)
     poly_normals.ComputeCellNormalsOn()
@@ -721,6 +727,10 @@ def line(lines, colors=None, opacity=1, linewidth=1,
     poly_data, color_is_scalar = lines_to_vtk_polydata(lines, colors)
     next_input = poly_data
 
+    # set primitives count
+    prim_count = len(lines)
+    set_polydata_primitives_count(poly_data, prim_count)
+
     # use spline interpolation
     if (spline_subdiv is not None) and (spline_subdiv > 0):
         spline_filter = set_input(SplineFilter(), next_input)
@@ -1028,9 +1038,6 @@ def _color_fa(fa, evecs):
     return np.abs(evecs[..., 0]) * np.clip(fa, 0, 1)[..., None]
 
 
-
-
-
 def tensor_slicer(evals, evecs, affine=None, mask=None, sphere=None, scale=2.2,
                   norm=True, opacity=1., scalar_colors=None):
     """Slice many tensors as ellipsoids in native or world coordinates.
@@ -1480,6 +1487,10 @@ def dot(points, colors=None, opacity=None, dot_size=5):
     polydata.SetVerts(vtk_faces)
     polydata.GetPointData().SetScalars(color_array)
 
+    # set primitives count
+    prim_count = len(points)
+    set_polydata_primitives_count(polydata, prim_count)
+
     # Visualize
     mapper = PolyDataMapper()
     mapper.SetInputData(polydata)
@@ -1603,8 +1614,9 @@ def sphere(centers, colors, radii=1., phi=16, theta=16,
                               directions=directions, centers=centers,
                               colors=colors, scales=scales)
     big_verts, big_faces, big_colors, _ = res
+    prim_count = len(centers)
     sphere_actor = get_actor_from_primitive(
-            big_verts, big_faces, big_colors)
+            big_verts, big_faces, big_colors, prim_count=prim_count)
     sphere_actor.GetProperty().SetOpacity(opacity)
     return sphere_actor
 
@@ -1772,7 +1784,9 @@ def square(centers, directions=(1, 0, 0), colors=(1, 0, 0), scales=1):
                               centers=centers, colors=colors, scales=scales)
 
     big_verts, big_faces, big_colors, _ = res
-    sq_actor = get_actor_from_primitive(big_verts, big_faces, big_colors)
+    prim_count = len(centers)
+    sq_actor = get_actor_from_primitive(big_verts, big_faces, big_colors,
+                                        prim_count=prim_count)
     sq_actor.GetProperty().BackfaceCullingOff()
     return sq_actor
 
@@ -1851,7 +1865,9 @@ def box(centers, directions=(1, 0, 0), colors=(1, 0, 0), scales=(1, 2, 3)):
                               centers=centers, colors=colors, scales=scales)
 
     big_verts, big_faces, big_colors, _ = res
-    box_actor = get_actor_from_primitive(big_verts, big_faces, big_colors)
+    prim_count = len(centers)
+    box_actor = get_actor_from_primitive(big_verts, big_faces, big_colors,
+                                         prim_count=prim_count)
     return box_actor
 
 
@@ -1940,7 +1956,9 @@ def arrow(centers, directions, colors, heights=1., resolution=10,
         res = fp.repeat_primitive(vertices, faces, directions=directions, centers=centers,
                                   colors=colors, scales=scales)
         big_vertices, big_faces, big_colors, _ = res
-        arrow_actor = get_actor_from_primitive(big_vertices, big_faces, big_colors)
+        prim_count = len(centers)
+        arrow_actor = get_actor_from_primitive(big_vertices, big_faces, big_colors,
+                                               prim_count=prim_count)
         return arrow_actor
 
     src = ArrowSource() if faces is None else None
@@ -2018,7 +2036,9 @@ def cone(centers, directions, colors, heights=1., resolution=10,
                     directions=directions, colors=colors, scales=heights)
 
     big_verts, big_faces, big_colors, _ = res
-    cone_actor = get_actor_from_primitive(big_verts, big_faces, big_colors)
+    prim_count = len(centers)
+    cone_actor = get_actor_from_primitive(big_verts, big_faces, big_colors,
+                                          prim_count=prim_count)
 
     return cone_actor
 
@@ -2059,7 +2079,9 @@ def triangularprism(centers, directions=(1, 0, 0), colors=(1, 0, 0),
     res = fp.repeat_primitive(verts, faces, directions=directions,
                               centers=centers, colors=colors, scales=scales)
     big_verts, big_faces, big_colors, _ = res
-    tprism_actor = get_actor_from_primitive(big_verts, big_faces, big_colors)
+    prim_count = len(centers)
+    tprism_actor = get_actor_from_primitive(big_verts, big_faces, big_colors,
+                                            prim_count=prim_count)
     return tprism_actor
 
 
@@ -2099,7 +2121,9 @@ def rhombicuboctahedron(centers, directions=(1, 0, 0), colors=(1, 0, 0),
     res = fp.repeat_primitive(verts, faces, directions=directions,
                               centers=centers, colors=colors, scales=scales)
     big_verts, big_faces, big_colors, _ = res
-    rcoh_actor = get_actor_from_primitive(big_verts, big_faces, big_colors)
+    prim_count = len(centers)
+    rcoh_actor = get_actor_from_primitive(big_verts, big_faces, big_colors,
+                                          prim_count=prim_count)
     return rcoh_actor
 
 
@@ -2141,7 +2165,9 @@ def pentagonalprism(centers, directions=(1, 0, 0), colors=(1, 0, 0),
                               centers=centers, colors=colors, scales=scales)
 
     big_verts, big_faces, big_colors, _ = res
-    pent_actor = get_actor_from_primitive(big_verts, big_faces, big_colors)
+    prim_count = len(centers)
+    pent_actor = get_actor_from_primitive(big_verts, big_faces, big_colors,
+                                          prim_count=prim_count)
     return pent_actor
 
 
@@ -2182,7 +2208,9 @@ def octagonalprism(centers, directions=(1, 0, 0), colors=(1, 0, 0),
                               centers=centers, colors=colors, scales=scales)
 
     big_verts, big_faces, big_colors, _ = res
-    oct_actor = get_actor_from_primitive(big_verts, big_faces, big_colors)
+    prim_count = len(centers)
+    oct_actor = get_actor_from_primitive(big_verts, big_faces, big_colors,
+                                         prim_count=prim_count)
     return oct_actor
 
 
@@ -2221,7 +2249,9 @@ def frustum(centers, directions=(1, 0, 0), colors=(0, 1, 0), scales=1):
                               centers=centers, colors=colors, scales=scales)
 
     big_verts, big_faces, big_colors, _ = res
-    frustum_actor = get_actor_from_primitive(big_verts, big_faces, big_colors)
+    prim_count = len(centers)
+    frustum_actor = get_actor_from_primitive(big_verts, big_faces, big_colors,
+                                             prim_count=prim_count)
     return frustum_actor
 
 
@@ -2281,7 +2311,9 @@ def have_2_dimensions(arr):
                                        colors=colors, scales=scales)
 
     big_verts, big_faces, big_colors, _ = res
-    spq_actor = get_actor_from_primitive(big_verts, big_faces, big_colors)
+    prim_count = len(centers)
+    spq_actor = get_actor_from_primitive(big_verts, big_faces, big_colors,
+                                         prim_count=prim_count)
     return spq_actor
 
 
@@ -2324,7 +2356,9 @@ def billboard(centers, colors=(0, 1, 0), scales=1, vs_dec=None, vs_impl=None,
 
     big_verts, big_faces, big_colors, big_centers = res
 
-    bb_actor = get_actor_from_primitive(big_verts, big_faces, big_colors)
+    prim_count = len(centers)
+    bb_actor = get_actor_from_primitive(big_verts, big_faces, big_colors,
+                                        prim_count=prim_count)
     bb_actor.GetMapper().SetVBOShiftScaleMethod(False)
     bb_actor.GetProperty().BackfaceCullingOff()
     attribute_to_actor(bb_actor, big_centers, 'center')
@@ -2975,7 +3009,9 @@ def sdf(centers, directions=(1, 0, 0), colors=(1, 0, 0), primitives='torus',
                                    scales=scales)
 
     rep_verts, rep_faces, rep_colors, rep_centers = repeated
-    box_actor = get_actor_from_primitive(rep_verts, rep_faces, rep_colors)
+    prim_count = len(centers)
+    box_actor = get_actor_from_primitive(rep_verts, rep_faces, rep_colors,
+                                         prim_count=prim_count)
     box_actor.GetMapper().SetVBOShiftScaleMethod(False)
 
     if isinstance(primitives,  (list, tuple, np.ndarray)):
@@ -3054,7 +3090,9 @@ def markers(
                               scales=scales)
 
     big_verts, big_faces, big_colors, big_centers = res
-    sq_actor = get_actor_from_primitive(big_verts, big_faces, big_colors)
+    prim_count = len(centers)
+    sq_actor = get_actor_from_primitive(big_verts, big_faces, big_colors,
+                                        prim_count=prim_count)
     sq_actor.GetMapper().SetVBOShiftScaleMethod(False)
     sq_actor.GetProperty().BackfaceCullingOff()
 

fury/tests/test_actors.py

@@ -12,7 +12,7 @@
 from fury import actor, window, primitive as fp
 from fury.actor import grid
 from fury.decorators import skip_osx, skip_win
-from fury.utils import shallow_copy, rotate
+from fury.utils import shallow_copy, rotate, primitives_count_from_actor
 from fury.testing import assert_greater, assert_greater_equal
 from fury.primitive import prim_sphere
 
@@ -1492,3 +1492,50 @@ def test_marker_actor(interactive=False):
     report = window.analyze_snapshot(arr, colors=colors)
     npt.assert_equal(report.objects, 12)
 
+
+def test_actors_primitives_count():
+    centers = np.array([[1, 1, 1], [2, 2, 2]])
+    directions = np.array([[1, 0, 0], [1, 0, 0]])
+    colors = np.array([[1, 0, 0], [1, 0, 0]])
+    lines = np.array([[[0, 0, 0], [1, 1, 1]], [[1, 1, 1], [2, 2, 2]]])
+
+    args_1 = {'centers': centers}
+    args_2 = {**args_1, 'colors': colors}
+    args_3 = {**args_2, 'directions': directions}
+
+    cen_c = len(centers)
+    lin_c = len(lines)
+
+    actors_test_cases = [
+        [actor.box, args_1, cen_c],
+        [actor.rectangle, args_1, cen_c],
+        [actor.square, args_1, cen_c],
+        [actor.cube, args_1, cen_c],
+        [actor.sphere, {**args_2, 'use_primitive': True}, cen_c],
+        [actor.sphere, {**args_2, 'use_primitive': False}, cen_c],
+        [actor.sdf, args_1, cen_c],
+        [actor.billboard, args_1, cen_c],
+        [actor.superquadric, args_1, cen_c],
+        [actor.markers, args_1, cen_c],
+        [actor.octagonalprism, args_1, cen_c],
+        [actor.frustum, args_1, cen_c],
+        [actor.pentagonalprism, args_1, cen_c],
+        [actor.triangularprism, args_1, cen_c],
+        [actor.rhombicuboctahedron, args_1, cen_c],
+        [actor.cylinder, args_3, cen_c],
+        [actor.disk, args_3, cen_c],
+        [actor.cone, {**args_3, 'use_primitive': False}, cen_c],
+        [actor.cone, {**args_3, 'use_primitive': True}, cen_c],
+        [actor.arrow, {**args_3, 'repeat_primitive': False}, cen_c],
+        [actor.arrow, {**args_3, 'repeat_primitive': True}, cen_c],
+        [actor.dot, {'points': centers}, cen_c],
+        [actor.point, {'points': centers, 'colors': colors}, cen_c],
+        [actor.line, {'lines': lines}, lin_c],
+        [actor.streamtube, {'lines': lines}, lin_c],
+    ]
+    for test_case in actors_test_cases:
+        act_func = test_case[0]
+        args = test_case[1]
+        primitives_count = test_case[2]
+        act = act_func(**args)
+        npt.assert_equal(primitives_count_from_actor(act), primitives_count)

fury/tests/test_utils.py

@@ -16,16 +16,21 @@
                         compute_bounds, set_input,
                         update_actor, get_actor_from_primitive,
                         get_bounds, update_surface_actor_colors,
-                        apply_affine_to_actor, color_check, is_ui)
+                        apply_affine_to_actor, color_check, is_ui,
+                        primitives_count_to_actor, primitives_count_from_actor,
+                        set_polydata_primitives_count,
+                        get_polydata_primitives_count)
 from fury import actor, window, utils
 from fury.lib import (numpy_support, PolyData, PolyDataMapper2D, Points,
-                      CellArray, Polygon, Actor2D, DoubleArray,
+                      CellArray, Polygon, Actor2D, DoubleArray, VTK_INT,
                       UnsignedCharArray, TextActor3D, VTK_DOUBLE, VTK_FLOAT)
+
 import fury.primitive as fp
 
 from fury.optpkg import optional_package
 dipy, have_dipy, _ = optional_package('dipy')
 
+
 def test_apply_affine_to_actor(interactive=False):
     text_act = actor.text_3d("ALIGN TOP RIGHT", justification='right',
                              vertical_justification='top')
@@ -814,12 +819,60 @@ def test_empty_list_to_polydata():
     lines = [[]]
     _, _ = utils.lines_to_vtk_polydata(lines)
 
+
 def test_empty_array_to_polydata():
     lines = np.array([[]])
     _, _ = utils.lines_to_vtk_polydata(lines)
 
+
 @pytest.mark.skipif(not have_dipy, reason="Requires DIPY")
 def test_empty_array_sequence_to_polydata():
     from dipy.tracking.streamline import Streamlines
     lines = Streamlines()
-    _, _ = utils.lines_to_vtk_polydata(lines)
+    _, _ = utils.lines_to_vtk_polydata(lines)
+
+
+def test_set_polydata_primitives_count():
+    polydata = PolyData()
+
+    set_polydata_primitives_count(polydata, 1)
+    prim_count = get_polydata_field(polydata, 'prim_count')[0]
+    npt.assert_equal(prim_count, 1)
+
+
+def test_get_polydata_primitives_count():
+    polydata = PolyData()
+    add_polydata_numeric_field(polydata, "prim_count", 1, array_type=VTK_INT)
+
+    prim_count = get_polydata_primitives_count(polydata)
+    npt.assert_equal(prim_count, 1)
+
+
+def test_primitives_count_to_actor():
+    act = actor.axes()
+    primitives_count_to_actor(act, 1)
+    polydata = act.GetMapper().GetInput()
+    prim_count = get_polydata_field(polydata, 'prim_count')[0]
+    npt.assert_equal(prim_count, 1)
+
+
+def test_primitives_count_from_actor():
+    act = actor.axes()
+    polydata = act.GetMapper().GetInput()
+    add_polydata_numeric_field(polydata, "prim_count", 1, array_type=VTK_INT)
+    prim_count = primitives_count_from_actor(act)
+    npt.assert_equal(prim_count, 1)
+
+
+def test_primitives_count():
+    # testing on actor
+    act = actor.axes()
+    primitives_count_to_actor(act, 3)
+    prim_count = primitives_count_from_actor(act)
+    npt.assert_equal(prim_count, 3)
+
+    # testing on polydata
+    polydata = PolyData()
+    set_polydata_primitives_count(polydata, 4)
+    prim_count = get_polydata_primitives_count(polydata)
+    npt.assert_equal(prim_count, 4)