diff --git a/girs/GstAnalytics-1.0.gir b/girs/GstAnalytics-1.0.gir
index afa602c595..f074af230a 100644
--- a/girs/GstAnalytics-1.0.gir
+++ b/girs/GstAnalytics-1.0.gir
@@ -494,7 +494,12 @@ new struct sub-classing GstAnalyticsRelatableMtd.
- Add analytics segmentation metadata to @instance.
+ Add analytics segmentation metadata to @instance. The rectangle (@masks_loc_x,
+@mask_loc_y, @mask_loc_w, @mask_loc_h) define a area of the image that
+correspond to the segmentation masks stored in @buffer. For example if the
+segmentation masks stored in @buffer describe the segmented regions for the
+entire image the rectangular area will be (@masks_loc_x = 0, @masks_loc_y = 0,
+@masks_loc_w = image_width, @masks_loc_h = image_height).
TRUE if added successfully, otherwise FALSE
@@ -525,8 +530,24 @@ must have a #GstVideoMeta attached
+
+ Left coordinate of the rectangle corresponding to the masks in the image.
+
+
+
+ Top coordinate of the rectangle corresponding to the masks in the image.
+
+
+
+ Width of the rectangle corresponding to the masks in the image.
+
+
+
+ Height of the rectangle corresponding to the masks in the image.
+
+
- Handle update with newly added segmenation meta.
+ Handle update with newly added segmentation meta.
@@ -942,7 +963,7 @@ Ids must have been obtained a call to
Example: Associate Semantic Segmentation with Classification
Assuming the same context as for Instance Segmentation above but instead
- a semantic segmentation is performed, therfore region-id-12 and region-id-7
+ a semantic segmentation is performed, therefore region-id-12 and region-id-7
are now represented by the same region-id-12
region_ids: (here
@@ -974,7 +995,7 @@ Ids must have been obtained a call to
GST_ANALYTICS_REL_TYPE_RELATE_TO, segmtd.id, clsmtd.id);
```
- Example: Retriving class associated with a segmentation region-id-12
+ Example: Retrieving class associated with a segmentation region-id-12
This the typical case for an overlay as we visit the segmentation mask we
we find region-id values
@@ -1010,8 +1031,28 @@ identified by @id is stored.
Instance
-
+
+
+ Left coordinate of the
+rectangle corresponding to the mask in the image.
+
+
+
+ Top coordinate of the
+rectangle corresponding to the mask in the image.
+
+
+
+ Width of the rectangle
+corresponding to the mask in the image.
+
+
+
+ Height of the rectangle
+corresponding to the mask in the image.
+
+
@@ -1024,12 +1065,12 @@ identified by @id is stored.
Instance
-
+
- Get id of the region corresponding to @index. which should be
+ Get id of the region corresponding to @index, which should be
smaller than the return value of
gst_analytics_segmentation_mtd_get_region_count()
@@ -1040,7 +1081,7 @@ gst_analytics_segmentation_mtd_get_region_count()
Instance
-
+
Region index
@@ -1058,7 +1099,7 @@ gst_analytics_segmentation_mtd_get_region_count()
Instance
-
+
Region index
@@ -1083,11 +1124,13 @@ metadata type.
Enum value describing supported segmentation type
-
- Each region of the same type have the same id.
+
+ Segmentation where the belonging of each
+pixel to a class of objects is identified.
-
- Each instance of a region have different id.
+
+ Segmentation where the belonging of each
+pixel to instance of an object is identified.