Docs

Author: alexanderswerdlow

src/image_utils/im.py

@@ -340,16 +340,17 @@ def get_opencv(self):
 
     @property
     def copy(self):
+        """Returns a deep copy of the image."""
         return copy.deepcopy(self)
 
     @property
     def height(self):
-        """Returns the height of the image"""
+        """Returns the height of the image."""
         return self.image_shape[0]
 
     @property
     def width(self):
-        """Returns the width of the image"""
+        """Returns the width of the image."""
         return self.image_shape[1]
 
     @property
@@ -632,6 +633,7 @@ def concat_horizontal(*args, **kwargs) -> Im:
         return concat_variable(concat_horizontal_, *args, **kwargs)
 
     def save_video(self, filepath: Optional[Path] = None, fps: int = 4, format="mp4", use_pyav: bool = False):
+        """Saves a video to disk. If filepath is not specified, the video will be saved to $CWD/outputs with a timestamp as the filename."""
         if filepath is None:
             filepath = Path(get_date_time_str())
 
@@ -650,13 +652,16 @@ def save_video(self, filepath: Optional[Path] = None, fps: int = 4, format="mp4"
 
     @_convert_to_datatype(desired_datatype=ndarray, desired_order=ChannelOrder.HWC, desired_range=ChannelRange.UINT8)
     def encode_video(self, fps: int, format="mp4") -> BytesIO:
-        """Encodes a batched image to a video."""
+        """Encodes a batched image to a video. Requires ImageIO."""
         assert len(self.arr.shape) == 4, "Video data must be 4D (time, height, width, channels)"
         byte_stream = BytesIO()
 
         # TODO: We shouldn't need to write -> read. An imageio/ffmpeg issue is causing this.
         with tempfile.NamedTemporaryFile(suffix=f".{format}") as ntp:
-            import imageio
+            try:
+                import imageio
+            except ImportError:
+                raise ImportError("ImageIO is required to encode videos. Please install it with `pip install imageio[ffmpeg]`.")
 
             if format == "webm":
                 writer = imageio.get_writer(ntp.name, format="webm", codec="libvpx-vp9", pixelformat="yuv420p", output_params=["-lossless", "1"], fps=fps)  # type: ignore
@@ -740,6 +745,7 @@ def show(self):
 
     @_convert_to_datatype(desired_datatype=Tensor, desired_order=ChannelOrder.HWC, desired_range=ChannelRange.UINT8)
     def bool_to_rgb(self) -> Im:
+        """Converts a boolean array to a RGB image (B / W)."""
         return self
 
     pil = property(get_pil)