rename to raster to draw

Matt Sokoloff · Matt Sokoloff · commit 2275bd0da179 · 2021-08-12T15:39:59.000-04:00
diff --git a/examples/annotation_types/basics.ipynb b/examples/annotation_types/basics.ipynb
@@ -652,7 +652,7 @@
     "##### Geometry Utilities\n",
     "* All of the previous objects except TextEntity inherit from the Geometry base class\n",
     "* They have the following properties and functions\n",
-    "    1. raster(height width, kwargs)\n",
+    "    1. draw(height width, kwargs)\n",
     "    2. shape - property\n",
     "    3. geometry - property"
    ]
@@ -714,7 +714,7 @@
    "outputs": [],
    "source": [
     "color = (255,255,255)\n",
-    "np_mask = polygon_annotation.value.raster(height = im.size[1], width = im.size[0], color = color)\n",
+    "np_mask = polygon_annotation.value.draw(height = im.size[1], width = im.size[0], color = color)\n",
     "Image.fromarray(np.hstack([np_mask, np_data]))"
    ]
   },
@@ -767,9 +767,9 @@
     "    Polygon(points = [Point(x=x,y=y) for x,y in [[82, 180], [83, 184], [88, 184], [86, 180]]]),\n",
     "    Polygon(points = [Point(x=x,y=y) for x,y in [[97, 182], [99, 184], [102, 183], [101, 180], [98, 180]]]),    \n",
     "]\n",
-    "eye_masks = np.max([eye.raster(height = h, width = w) for eye in eyes], axis = 0)\n",
+    "eye_masks = np.max([eye.draw(height = h, width = w) for eye in eyes], axis = 0)\n",
     "nose = Polygon(points =[ Point(x=x,y=y) for x,y in [[95, 192], [93, 197], [96, 198], [100, 197], [100, 194], [100, 192], [96, 192]]])\n",
-    "nose_mask = nose.raster(height = h, width = w, color = nose_color)\n",
+    "nose_mask = nose.draw(height = h, width = w, color = nose_color)\n",
     "# Picks the brighter color if there is overlap. \n",
     "# If you don't want overlap then just simply create separate masks\n",
     "np_seg_mask = np.max([nose_mask, eye_masks], axis = 0)\n",
@@ -801,7 +801,7 @@
    "id": "swiss-storm",
    "metadata": {},
    "source": [
-    "* Calling `mask.raster()` will return a mask with pixels equal to the specified color"
+    "* Calling `mask.draw()` will return a mask with pixels equal to the specified color"
    ]
   },
   {
@@ -811,8 +811,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "eye_raster = eye_mask.raster()\n",
-    "nose_raster = nose_mask.raster()\n",
+    "eye_raster = eye_mask.draw()\n",
+    "nose_raster = nose_mask.draw()\n",
     "Image.fromarray(np.hstack([eye_raster,nose_raster, np_data]))"
    ]
   },
diff --git a/examples/annotation_types/converters.ipynb b/examples/annotation_types/converters.ipynb
@@ -367,7 +367,7 @@
     "            \n",
     "        for annotation in annotation_lookup[idx]:\n",
     "            if isinstance(annotation.value, Rectangle):\n",
-    "                frame = annotation.value.raster(canvas = frame.astype(np.uint8), thickness = 10, color= (255,0,0))\n",
+    "                frame = annotation.value.draw(canvas = frame.astype(np.uint8), thickness = 10, color= (255,0,0))\n",
     "                \n",
     "        im = Image.fromarray(frame)\n",
     "        w,h = im.size\n",
@@ -439,7 +439,7 @@
     "canvas = np.zeros((h, w, 3), dtype = np.uint8)\n",
     "for annotation in label_list[0].annotations:\n",
     "    if isinstance(annotation.value, Geometry):\n",
-    "        canvas = annotation.value.raster(canvas = canvas)\n",
+    "        canvas = annotation.value.draw(canvas = canvas)\n",
     "Image.fromarray(canvas)"
    ]
   },
diff --git a/examples/annotation_types/label_containers.ipynb b/examples/annotation_types/label_containers.ipynb
@@ -132,10 +132,10 @@
     "    im_h, im_w = 300, 200\n",
     "    image_url = \"https://picsum.photos/id/1003/200/300\"\n",
     "    nose_color, eye_color = (0,255,0), (255,0,0)\n",
-    "    nose_mask = Point(x = 96, y = 194).raster(im_h, im_w, thickness = 3)\n",
+    "    nose_mask = Point(x = 96, y = 194).draw(im_h, im_w, thickness = 3)\n",
     "    eye_masks = [\n",
-    "         Point(x = 84, y = 182).raster(im_h, im_w, thickness = 3),\n",
-    "        Point(x = 99, y = 181).raster(im_h, im_w, thickness = 3),\n",
+    "         Point(x = 84, y = 182).draw(im_h, im_w, thickness = 3),\n",
+    "        Point(x = 99, y = 181).draw(im_h, im_w, thickness = 3),\n",
     "    ]\n",
     "    mask_arr = np.max([*eye_masks,nose_mask] , axis = 0)\n",
     "    mask = MaskData(arr = mask_arr)\n",
diff --git a/examples/label_export/images.ipynb b/examples/label_export/images.ipynb
@@ -165,7 +165,7 @@
     "# Draw the annotations onto the source image\n",
     "for annotation in label.annotations:\n",
     "    if isinstance(annotation.value, Geometry):\n",
-    "        image_np = annotation.value.raster(canvas = image_np, color = colors[annotation.name], thickness = 5)\n",
+    "        image_np = annotation.value.draw(canvas = image_np, color = colors[annotation.name], thickness = 5)\n",
     "Image.fromarray(image_np.astype(np.uint8))"
    ]
   },
diff --git a/labelbox/data/annotation_types/geometry/geometry.py b/labelbox/data/annotation_types/geometry/geometry.py
@@ -35,10 +35,10 @@ def geometry(self) -> geojson:
         pass
 
     @abstractmethod
-    def raster(self,
-               height: Optional[int] = None,
-               width: Optional[int] = None,
-               canvas: Optional[np.ndarray] = None,
-               color: Optional[Union[int, Tuple[int, int, int]]] = None,
-               thickness: Optional[int] = 1) -> np.ndarray:
+    def draw(self,
+             height: Optional[int] = None,
+             width: Optional[int] = None,
+             canvas: Optional[np.ndarray] = None,
+             color: Optional[Union[int, Tuple[int, int, int]]] = None,
+             thickness: Optional[int] = 1) -> np.ndarray:
         pass
diff --git a/labelbox/data/annotation_types/geometry/line.py b/labelbox/data/annotation_types/geometry/line.py
@@ -16,12 +16,12 @@ def geometry(self) -> geojson.MultiLineString:
         return geojson.MultiLineString(
             [[[point.x, point.y] for point in self.points]])
 
-    def raster(self,
-               height: Optional[int] = None,
-               width: Optional[int] = None,
-               canvas: Optional[np.ndarray] = None,
-               color: Union[int, Tuple[int, int, int]] = (255, 255, 255),
-               thickness: int = 1) -> np.ndarray:
+    def draw(self,
+             height: Optional[int] = None,
+             width: Optional[int] = None,
+             canvas: Optional[np.ndarray] = None,
+             color: Union[int, Tuple[int, int, int]] = (255, 255, 255),
+             thickness: int = 1) -> np.ndarray:
         """
         Draw the line onto a 3d mask
         Args:
diff --git a/labelbox/data/annotation_types/geometry/mask.py b/labelbox/data/annotation_types/geometry/mask.py
@@ -11,32 +11,28 @@
 
 
 class Mask(Geometry):
-    # Raster data can be shared across multiple masks... or not
+    # Mask data can be shared across multiple masks
     mask: MaskData
-    # RGB or Grayscale
     color: Tuple[int, int, int]
 
     @property
     def geometry(self):
-        mask = self.raster(color=1)
+        mask = self.draw(color=1)
         polygons = (
             shape(shp)
             for shp, val in shapes(mask, mask=None)
             # ignore if shape is area of smaller than 1 pixel
             if val >= 1)
         return MultiPolygon(polygons).__geo_interface__
 
-    def raster(self,
-               height: Optional[int] = None,
-               width: Optional[int] = None,
-               canvas: Optional[np.ndarray] = None,
-               color: Optional[Union[int, Tuple[int, int, int]]] = None,
-               thickness=None) -> np.ndarray:
+    def draw(self,
+             height: Optional[int] = None,
+             width: Optional[int] = None,
+             canvas: Optional[np.ndarray] = None,
+             color: Optional[Union[int, Tuple[int, int, int]]] = None,
+             thickness=None) -> np.ndarray:
         """
-        # TODO: Optionally use the color. a color of 1 will result in a binary canvas
-
-
-        Removes all pixels from the segmentation mask that do not equal self.color
+        Converts the Mask object into a numpy array
 
         Args:
             height (int): Optionally resize mask height before drawing.
diff --git a/labelbox/data/annotation_types/geometry/point.py b/labelbox/data/annotation_types/geometry/point.py
@@ -15,12 +15,12 @@ class Point(Geometry):
     def geometry(self) -> geojson.Point:
         return geojson.Point([self.x, self.y])
 
-    def raster(self,
-               height: Optional[int] = None,
-               width: Optional[int] = None,
-               canvas: Optional[np.ndarray] = None,
-               color: Union[int, Tuple[int, int, int]] = (255, 255, 255),
-               thickness: int = 10) -> np.ndarray:
+    def draw(self,
+             height: Optional[int] = None,
+             width: Optional[int] = None,
+             canvas: Optional[np.ndarray] = None,
+             color: Union[int, Tuple[int, int, int]] = (255, 255, 255),
+             thickness: int = 10) -> np.ndarray:
         """
         Draw the point onto a 3d mask
         Args:
diff --git a/labelbox/data/annotation_types/geometry/polygon.py b/labelbox/data/annotation_types/geometry/polygon.py
@@ -18,12 +18,12 @@ def geometry(self) -> geojson.MultiPolygon:
             self.points.append(self.points[0])
         return geojson.Polygon([[[point.x, point.y] for point in self.points]])
 
-    def raster(self,
-               height: Optional[int] = None,
-               width: Optional[int] = None,
-               canvas: Optional[np.ndarray] = None,
-               color: Union[int, Tuple[int, int, int]] = (255, 255, 255),
-               thickness: int = -1) -> np.ndarray:
+    def draw(self,
+             height: Optional[int] = None,
+             width: Optional[int] = None,
+             canvas: Optional[np.ndarray] = None,
+             color: Union[int, Tuple[int, int, int]] = (255, 255, 255),
+             thickness: int = -1) -> np.ndarray:
         """
         Draw the polygon onto a 3d mask
         Args:
diff --git a/labelbox/data/annotation_types/geometry/rectangle.py b/labelbox/data/annotation_types/geometry/rectangle.py
@@ -28,12 +28,12 @@ def geometry(self) -> geojson.geometry.Geometry:
             [self.start.x, self.start.y],
         ]])
 
-    def raster(self,
-               height: Optional[int] = None,
-               width: Optional[int] = None,
-               canvas: Optional[np.ndarray] = None,
-               color: Union[int, Tuple[int, int, int]] = (255, 255, 255),
-               thickness: int = -1) -> np.ndarray:
+    def draw(self,
+             height: Optional[int] = None,
+             width: Optional[int] = None,
+             canvas: Optional[np.ndarray] = None,
+             color: Union[int, Tuple[int, int, int]] = (255, 255, 255),
+             thickness: int = -1) -> np.ndarray:
         """
         Draw the rectangle onto a 3d mask
         Args:
diff --git a/labelbox/data/metrics/iou.py b/labelbox/data/metrics/iou.py
@@ -128,10 +128,10 @@ def mask_miou(ground_truths: List[ObjectAnnotation],
     Returns:
         float representing the iou score for the masks
     """
-    prediction_np = np.max([pred.value.raster(color=1) for pred in predictions],
+    prediction_np = np.max([pred.value.draw(color=1) for pred in predictions],
                            axis=0)
     ground_truth_np = np.max(
-        [ground_truth.value.raster(color=1) for ground_truth in ground_truths],
+        [ground_truth.value.draw(color=1) for ground_truth in ground_truths],
         axis=0)
     if prediction_np.shape != ground_truth_np.shape:
         raise ValueError(
diff --git a/tests/data/annotation_types/geometry/test_line.py b/tests/data/annotation_types/geometry/test_line.py
@@ -19,5 +19,5 @@ def test_line():
     expected['coordinates'] = tuple([tuple([tuple(x) for x in points])])
     assert line.shapely.__geo_interface__ == expected
 
-    raster = line.raster(height=32, width=32, thickness=1)
+    raster = line.draw(height=32, width=32, thickness=1)
     assert (cv2.imread("tests/data/assets/line.png") == raster).all()
diff --git a/tests/data/annotation_types/geometry/test_mask.py b/tests/data/annotation_types/geometry/test_mask.py
@@ -41,18 +41,18 @@ def test_mask():
     assert (gt_mask == mask1.mask.arr).all()
     assert (gt_mask == mask2.mask.arr).all()
 
-    raster1 = mask1.raster()
-    raster2 = mask2.raster()
+    raster1 = mask1.draw()
+    raster2 = mask2.draw()
 
     assert (raster1 != raster2).any()
 
     gt1 = Rectangle(start=Point(x=0, y=0),
-                    end=Point(x=10, y=10)).raster(height=raster1.shape[0],
-                                                  width=raster1.shape[1],
-                                                  color=(255, 255, 255))
+                    end=Point(x=10, y=10)).draw(height=raster1.shape[0],
+                                                width=raster1.shape[1],
+                                                color=(255, 255, 255))
     gt2 = Rectangle(start=Point(x=20, y=20),
-                    end=Point(x=30, y=30)).raster(height=raster2.shape[0],
-                                                  width=raster2.shape[1],
-                                                  color=(0, 255, 255))
+                    end=Point(x=30, y=30)).draw(height=raster2.shape[0],
+                                                width=raster2.shape[1],
+                                                color=(0, 255, 255))
     assert (raster1 == gt1).all()
     assert (raster2 == gt2).all()
diff --git a/tests/data/annotation_types/geometry/test_point.py b/tests/data/annotation_types/geometry/test_point.py
@@ -18,5 +18,5 @@ def test_point():
     expected['coordinates'] = tuple(expected['coordinates'])
     assert point.shapely.__geo_interface__ == expected
 
-    raster = point.raster(height=32, width=32, thickness=1)
+    raster = point.draw(height=32, width=32, thickness=1)
     assert (cv2.imread("tests/data/assets/point.png") == raster).all()
diff --git a/tests/data/annotation_types/geometry/test_polygon.py b/tests/data/annotation_types/geometry/test_polygon.py
@@ -23,5 +23,5 @@ def test_polygon():
         [tuple([tuple(x) for x in points + [points[0]]])])
     assert polygon.shapely.__geo_interface__ == expected
 
-    raster = polygon.raster(10, 10)
+    raster = polygon.draw(10, 10)
     assert (cv2.imread("tests/data/assets/polygon.png") == raster).all()
diff --git a/tests/data/annotation_types/geometry/test_rectangle.py b/tests/data/annotation_types/geometry/test_rectangle.py
@@ -16,5 +16,5 @@ def test_rectangle():
     expected['coordinates'] = tuple([tuple([tuple(x) for x in points[0]])])
     assert rectangle.shapely.__geo_interface__ == expected
 
-    raster = rectangle.raster(height=32, width=32)
+    raster = rectangle.draw(height=32, width=32)
     assert (cv2.imread("tests/data/assets/rectangle.png") == raster).all()

Original file line number	Diff line number	Diff line change
`@@ -165,7 +165,7 @@`
`165`	`165`	`"# Draw the annotations onto the source image\n",`
`166`	`166`	`"for annotation in label.annotations:\n",`
`167`	`167`	`" if isinstance(annotation.value, Geometry):\n",`
`168`		`- " image_np = annotation.value.raster(canvas = image_np, color = colors[annotation.name], thickness = 5)\n",`
	`168`	`+ " image_np = annotation.value.draw(canvas = image_np, color = colors[annotation.name], thickness = 5)\n",`
`169`	`169`	`"Image.fromarray(image_np.astype(np.uint8))"`
`170`	`170`	`]`
`171`	`171`	`},`