diff --git a/docs/hyperdatasets/annotations.md b/docs/hyperdatasets/annotations.md index dd5c2bb2..fe6eb307 100644 --- a/docs/hyperdatasets/annotations.md +++ b/docs/hyperdatasets/annotations.md @@ -55,3 +55,15 @@ Use [`SingleFrame.add_annotation()`](../references/hyperdataset/singleframe.md#a # labels for the whole frame frame.add_annotation(labels=['frame level label one','frame level label two']) ``` + +### Adding a Global Annotation + +Add a global annotation that will apply to all frames in a FrameGroup. + +Use [`FrameGroup.add_global_annotation()`](../references/hyperdataset/framegroup.md#add_global_annotation) and specify +the [Annotation](../references/hyperdataset/annotation.md) object to add to each frame: + +```python +annotation = ImageAnnotation(labels=["cityscape"], confidence=1.0000,) +frame_group.add_global_annotation(annotation=annotation) +``` diff --git a/docs/hyperdatasets/webapp/webapp_datasets_frames.md b/docs/hyperdatasets/webapp/webapp_datasets_frames.md index a4eb01e3..144d43b3 100644 --- a/docs/hyperdatasets/webapp/webapp_datasets_frames.md +++ b/docs/hyperdatasets/webapp/webapp_datasets_frames.md @@ -95,6 +95,14 @@ a dropdown list in the **Current Source** section. ![Frame dropdown menu in FrameGroup](../../img/hyperdatasets/framegroup_01.png) +If an annotation applies to all frames in a FrameGroup, it is displayed with a `Multi Source` indicator: + +
+ +![Multi-source ROI](../../img/hyperdatasets/multi_source_annotation.png) + +
+ ## Masks Use the **MASKS** panel to select which masks to apply over the frame. diff --git a/docs/img/hyperdatasets/multi_source_annotation.png b/docs/img/hyperdatasets/multi_source_annotation.png new file mode 100644 index 00000000..7f8d9e2e Binary files /dev/null and b/docs/img/hyperdatasets/multi_source_annotation.png differ