Getter and Setter methods for attribute data parameters (ImageAnnotation)

Author: Pushkar-Bhuse

forte/common/constants.py

@@ -11,6 +11,9 @@
 # The index storing entry type in the internal entry data of DataStore.
 ENTRY_TYPE_INDEX = 3
 
+# The index storing the payload ID in internal entry data of DataStore
+PAYLOAD_INDEX = 0
+
 # The index storing entry type (specific to Link and Group type). It is saved
 # in the `tid_idx_dict` in DataStore.
 ENTRY_DICT_TYPE_INDEX = 0

forte/data/ontology/top.py

@@ -32,6 +32,7 @@
     PARENT_TID_INDEX,
     CHILD_TID_INDEX,
     MEMBER_TID_INDEX,
+    PAYLOAD_INDEX,
 )
 
 __all__ = [
@@ -60,8 +61,15 @@
 make sure it available across the ontology system:
     1. Create a new top level class that inherits from `Entry` or `MultiEntry`
     2. Add the new class to `SinglePackEntries` or `MultiPackEntries`
-    3. Register a new method in `DataStore`: `add_<new_entry>_raw()`
-    4. Insert a new conditional branch in `EntryConverter.save_entry_object()`
+    3. Insert a new conditional branch in `EntryConverter.save_entry_object()`
+    4. Decide two main attributes which will qualify as your `attribute_data`
+        parameters. These parameters will be passes in your branch of
+        `EntryConverter.save_entry_object()`. If there are no such parameters,
+        you can pass None
+    5. add `getter` and `setter` functions to update `attribute_data` parameters
+        if you have any
+    6. If additional attributes are required, make the class a `dataclass` and set
+        `dataclass` attributes.
 """
 
 
@@ -1032,6 +1040,28 @@ def __init__(self, pack: PackType, image_payload_idx: int = 0):
         else:
             self._image_payload_idx = image_payload_idx
 
+    @property
+    def image_payload_idx(self):
+        r"""Getter function of ``image_payload_idx``. The function will first try to
+        retrieve the image_payload_idx index from ``DataStore`` in ``self.pack``. If
+        this attempt fails, it will directly return the value in ``_image_payload_idx``.
+        """
+        try:
+            self._image_payload_idx = self.pack.get_entry_raw(self.tid)[
+                PAYLOAD_INDEX
+            ]
+        except KeyError:
+            pass
+        return self._image_payload_idx
+
+    @image_payload_idx.setter
+    def image_payload_idx(self, val: int):
+        r"""Setter function of ``image_payload_idx``. The update will also be populated
+        into ``DataStore`` in ``self.pack``.
+        """
+        self._image_payload_idx = val
+        self.pack.get_entry_raw(self.tid)[PAYLOAD_INDEX] = val
+
     def compute_iou(self, other) -> int:
         intersection = np.sum(np.logical_and(self.image, other.image))
         union = np.sum(np.logical_or(self.image, other.image))

tests/forte/data/data_store_test.py

@@ -155,29 +155,6 @@ def setUp(self) -> None:
             },
         }
 
-        self.base_type_attributes = {
-            "forte.data.ontology.top.Generics": {"parent_class": {"Entry"}},
-            "forte.data.ontology.top.Annotation": {"parent_class": {"Entry"}},
-            "forte.data.ontology.top.Link": {"parent_class": {"BaseLink"}},
-            "forte.data.ontology.top.Group": {
-                "parent_class": {"Entry", "BaseGroup"}
-            },
-            "forte.data.ontology.top.MultiPackGeneric": {
-                "parent_class": {"Entry", "MultiEntry"}
-            },
-            "forte.data.ontology.top.MultiPackLink": {
-                "parent_class": {"MultiEntry", "BaseLink"}
-            },
-            "forte.data.ontology.top.MultiPackGroup": {
-                "parent_class": {"Entry", "MultiEntry", "BaseGroup"}
-            },
-            "forte.data.ontology.top.Query": {"parent_class": {"Generics"}},
-            "forte.data.ontology.top.AudioAnnotation": {
-                "parent_class": {"Entry"}
-            },
-            "forte.data.ontology.top.BoundingBox": {"parent_class": {"Box"}},
-        }
-
         DataStore._type_attributes["ft.onto.base_ontology.Document"] = {
             "attributes": {
                 "document_class": 4,
@@ -1124,7 +1101,7 @@ def test_get(self):
                 "forte.data.ontology.top.Annotation", range_annotation=(1, 20)
             )
         )
-        self.assertEqual(len(instances), 2)
+        self.assertEqual(len(instances), 4)
 
         # get groups with subclasses
         instances = list(self.data_store.get("forte.data.ontology.top.Group"))

tests/forte/image_annotation_test.py

@@ -23,6 +23,7 @@
 from sortedcontainers import SortedList
 from forte.data.ontology.top import ImageAnnotation, BoundingBox, Box, Region
 from forte.data.data_pack import DataPack
+from forte.common import constants
 
 
 class ImageAnnotationTest(unittest.TestCase):
@@ -108,8 +109,10 @@ def setUp(self):
             width=2,
             image_payload_idx=0,
         )
+        self.datapack_2.add_entry(self.box1)
 
         self.region1 = Region(pack=self.datapack_2, image_payload_idx=1)
+        self.datapack_2.add_entry(self.region1)
 
     def test_entry_methods(self):
         bb_type = "forte.data.ontology.top.BoundingBox"
@@ -191,6 +194,21 @@ def test_update_image_annotation(self):
         # Check new value
         self.assertEqual(bb1_height, 5)
 
+        # Updating Non-Dataclass fields
+
+        # Check current value
+        self.assertEqual(self.bb4.image_payload_idx, 1)
+
+        # Change a parameter of the entry object
+        self.bb4.image_payload_idx = 2
+
+        # Fetch attribute value from data store
+        bb4_payload = self.datapack_1._data_store.get_entry(
+            self.bb4.tid
+        )[0][constants.PAYLOAD_INDEX]
+        # Check new value
+        self.assertEqual(bb4_payload, 2)
+
     def test_compute_iou(self):
         box1 = self.bb1
         box2 = self.bb2