Merge pull request #61 from QuantStack/improve_data_components

Improve Data and Component widgets

Author: martinRenou

ipygany/ipygany.py

@@ -47,7 +47,15 @@ class Component(_GanyWidgetBase):
     min = CFloat(allow_none=True, default_value=None)
     max = CFloat(allow_none=True, default_value=None)
 
-    # TODO Compute min and max in the constructor?
+    def __init__(self, name, array, **kwargs):
+        """Create a new Component instance given its name and array."""
+        super(Component, self).__init__(name=name, array=array, **kwargs)
+
+        if self.min is None:
+            self.min = np.min(self.array)
+
+        if self.max is None:
+            self.max = np.max(self.array)
 
 
 class Data(_GanyWidgetBase):
@@ -56,7 +64,11 @@ class Data(_GanyWidgetBase):
     _model_name = Unicode('DataModel').tag(sync=True)
 
     name = Unicode().tag(sync=True)
-    components = List(Instance(Component)).tag(sync=True, **widget_serialization)
+    components = Union((Dict(), List(Instance(Component)))).tag(sync=True, **widget_serialization)
+
+    def __init__(self, name, components, **kwargs):
+        """Create a new Data instance given its name and components."""
+        super(Data, self).__init__(name=name, components=components, **kwargs)
 
     def __getitem__(self, key):
         """Get a component by name or index."""
@@ -71,6 +83,15 @@ def __getitem__(self, key):
 
         raise KeyError('Invalid key {}.'.format(key))
 
+    @validate('components')
+    def _validate_components(self, proposal):
+        components = proposal['value']
+
+        if isinstance(components, dict):
+            return [Component(name, array) for name, array in components.items()]
+
+        return components
+
 
 def _grid_data_to_data_widget(grid_data):
     """Turn a vtk grid into Data widgets."""
@@ -136,7 +157,7 @@ def _validate_data(self, proposal):
         data = proposal['value']
 
         if isinstance(data, dict):
-            return [Data(name=name, components=components) for name, components in data.items()]
+            return [Data(name, components) for name, components in data.items()]
 
         return data
 

tests/test_input.py

@@ -0,0 +1,58 @@
+import pytest
+
+import numpy as np
+
+from ipygany import PolyMesh, Data, Component
+
+
+vertices = np.array([
+    [0., 0., 0.],
+    [0., 0., 0.],
+    [0., 0., 0.],
+])
+
+triangles = np.array([
+    [0, 1, 2],
+])
+
+data_1d = Data(name='1d', components=[Component('x', np.array([0., 0., 0.]))])
+data_3d = Data('3d', [
+    Component(name='x', array=np.array([1., 1., 1.])),
+    Component('y', np.array([2., 2., 2.])),
+    Component('z', np.array([3., 3., 3.])),
+])
+
+
+def test_data_access():
+    poly = PolyMesh(vertices=vertices, triangle_indices=triangles, data=[data_1d, data_3d])
+
+    assert np.all(np.equal(poly['1d', 'x'].array, np.array([0., 0., 0.])))
+    assert np.all(np.equal(poly['3d', 'y'].array, np.array([2., 2., 2.])))
+
+
+def test_mesh_data_creation():
+    poly = PolyMesh(vertices=vertices, triangle_indices=triangles, data={
+        '1d': [Component('x', np.array([0., 0., 0.]))],
+        '2d': [Component('x', np.array([1., 1., 1.])), Component('y', np.array([2., 2., 2.]))]
+    })
+
+    assert np.all(np.equal(poly['1d', 'x'].array, np.array([0., 0., 0.])))
+    assert np.all(np.equal(poly['2d', 'x'].array, np.array([1., 1., 1.])))
+    assert np.all(np.equal(poly['2d', 'y'].array, np.array([2., 2., 2.])))
+
+    poly = PolyMesh(vertices=vertices, triangle_indices=triangles, data={
+        '1d': {'x': np.array([0., 0., 0.])},
+        '2d': {'x': np.array([1., 1., 1.]), 'y': np.array([2., 2., 2.])}
+    })
+
+    assert np.all(np.equal(poly['1d', 'x'].array, np.array([0., 0., 0.])))
+    assert np.all(np.equal(poly['2d', 'x'].array, np.array([1., 1., 1.])))
+    assert np.all(np.equal(poly['2d', 'y'].array, np.array([2., 2., 2.])))
+
+
+def test_component_creation():
+    comp = Component('z', np.array([1., 2., 3.]))
+
+    assert comp.name == 'z'
+    assert comp.min == 1.
+    assert comp.max == 3.