From cea913c7b826e5f65ebdd3a34e21779978cdb107 Mon Sep 17 00:00:00 2001 From: Alexander Druz Date: Tue, 20 Feb 2024 14:04:16 +0100 Subject: [PATCH] Adjust BB lens docstring --- renumics/spotlight/layout/lenses.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/renumics/spotlight/layout/lenses.py b/renumics/spotlight/layout/lenses.py index bba4e7bb..a7216f0b 100644 --- a/renumics/spotlight/layout/lenses.py +++ b/renumics/spotlight/layout/lenses.py @@ -178,18 +178,19 @@ def image(column: str, name: Optional[str] = None) -> Lens: def bounding_box( - column: str, + image_column: str, bounding_box_column: str, category_column: Optional[str] = None, name: Optional[str] = None, ) -> Lens: """ - Add audio viewer to Spotlight inspector widget. + Add bounding box viewer to Spotlight inspector widget. - Supports a single column of type `spotlight.Audio` with optional second - column of type `spotlight.Window`. + Supports a single column of type image, a second column of type bounding box + or sequence of bounding boxes and a third optional column of type category + or sequence of categories (according to bounding box column). """ - columns = [column, bounding_box_column] + columns = [image_column, bounding_box_column] if category_column is not None: columns.append(category_column) return Lens(type="BoundingBoxView", columns=columns, name=name)