refactor: コメントを追加

KatLab-MiyazakiUniv · Nov 5, 2024 · 5a0abca · 5a0abca
1 parent 7dbcd90
commit 5a0abca
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/front_camera/front_camera/color_rectangle_detector.py b/front_camera/front_camera/color_rectangle_detector.py
@@ -1,6 +1,6 @@
 """
 動画中の背景下部の指定色検出クラス
-@author: bizyutyu YKhm20020 CHIHAYATAKU
+@author: bizyutyu YKhm20020 CHIHAYATAKU takahashitom
 """
 import cv2
 import os
@@ -31,6 +31,15 @@ def detect_rectangle(self, frame):
         """対象色の矩形を検出する。
         Args:
             frame (numpy.ndarray): 処理対象の画像データ
+
+        Returns:
+            輪郭が見つかった場合:
+                int: 最大の輪郭（矩形）の左上のx座標
+                int: 最大の輪郭（矩形）の左上のy座標
+                int: 最大の輪郭（矩形）の幅
+                int: 最大の輪郭（矩形）の高さ
+
+            輪郭が見つからなかった場合: None
         """
         # HSV色空間に変換
         hsv = cv2.cvtColor(frame, cv2.COLOR_BGR2HSV)

diff --git a/module/Motion/CorrectingRotation.cpp b/module/Motion/CorrectingRotation.cpp
@@ -1,7 +1,7 @@
 /**
  * @file   CorrectingRotation.cpp
  * @brief  プラレール・背景撮影のための角度補正回頭動作
- * @author bizyutyu CHIHAYATAKU takahashitpom
+ * @author bizyutyu CHIHAYATAKU takahashitom
  */
 
 #include "CorrectingRotation.h"