Added comments to 23 functions across 5 files

Author: komment-ai[bot]

insect/environment_object_perception/src/ByteTrack/basetrack.py

@@ -34,11 +34,41 @@ def end_frame(self):
 
     @staticmethod
     def next_id():
+        """
+        This function increments the count of `BaseTrack` objects by one and returns
+        the new value of `BaseTrack._count`. It can be used to generate a unique
+        ID for each object instance.
+
+        Returns:
+            int: The output returned by the `next_id()` function is an integer
+            representing the next available ID value in the `BaseTrack` class
+            instance, incremented by 1 each time the function is called.
+
+        """
         BaseTrack._count += 1
         return BaseTrack._count
 
     @staticmethod
     def next_class_id(clase):
+        """
+        This function increments the class id for a given class when it's encountered
+        for the first time in a `BaseTrack` instance, and sets the class count to
+        1 if the class is not already known. It returns the updated class count
+        for that class.
+
+        Args:
+            clase (str): The `clase` input parameter in the given function is used
+                to identify the class for which the next class ID should be
+                generated. It is a key component of the function's logic, as it
+                determines which class the ID should be assigned to.
+
+        Returns:
+            int: The `next_class_id` function increments a count for a class each
+            time it's called, and stores the resulting count as the ID for that
+            class in the `_class_count` dictionary. Therefore, the output of the
+            function is the unique ID for the given class.
+
+        """
         if clase in BaseTrack._class_count.keys():
             BaseTrack._class_count[clase] += 1
         else: