Clarify docstring

neuroinformatics-unit · Sep 12, 2024 · 0c814f5 · 0c814f5
1 parent 3d189f6
commit 0c814f5
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/movement/io/load_bboxes.py b/movement/io/load_bboxes.py
@@ -420,16 +420,16 @@ def _df_from_via_tracks_file(file_path: Path) -> pd.DataFrame:
     Read the VIA tracks .csv file as a pandas dataframe with columns:
     - ID: the integer ID of the tracked bounding box.
     - frame_number: the frame number of the tracked bounding box.
-    - x: the x-coordinate of the tracked bounding box top-left corner.
-    - y: the y-coordinate of the tracked bounding box top-left corner.
+    - x: the x-coordinate of the tracked bounding box's top-left corner.
+    - y: the y-coordinate of the tracked bounding box's top-left corner.
     - w: the width of the tracked bounding box.
     - h: the height of the tracked bounding box.
     - confidence: the confidence score of the tracked bounding box.
 
     The dataframe is sorted by ID and frame number, and for each ID,
     empty frames are filled in with NaNs. The coordinates of the bboxes
-    are assumed to be in the image coordinate system, with the origin at the
-    top-left corner of the image.
+    are assumed to be in the image coordinate system (i.e., the top-left
+    corner of a bbox is its corner with minimum x and y coordinates).
     """
     # Read VIA tracks .csv file as a pandas dataframe
     df_file = pd.read_csv(file_path, sep=",", header=0)