リファクタリング

src/__init__.py

@@ -9,7 +9,7 @@ from src.utils import get_package_version
 
 __all__ = ["LocalTimeFormatter"]
 
-PROGRAM_NAME = 'SaliencyMapDemo'
+PROGRAM_NAME: str = 'SaliencyMapDemo'
 __version__ = get_package_version()
 
 

src/args_parser.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 """コマンドライン引数の解析"""
 from argparse import ArgumentParser, BooleanOptionalAction
-from src import PROGRAM_NAME, get_package_version
+from . import PROGRAM_NAME, get_package_version
 
 
 def parse_args():

src/reporter.py

@@ -1,6 +1,5 @@
 # -*- coding: utf-8 -*-
 """
-    Reporter
     ログハンドラーが重複登録されるのを防ぐために1箇所で生成してログハンドラーを返します。
     Example:
         from src.reporter import log
@@ -27,6 +26,7 @@ class Reporter:
 
     def __new__(cls):
         """
+            インスタンスの生成を制御します。
         """
         # インスタンスがまだ存在しない場合は新たに作成します。
         if not cls._instance:

src/saliency.py

@@ -8,7 +8,8 @@ import cv2
 
 class SaliencyMap:
     """
-    顕著性マップを計算するクラス。
+    画像から顕著性マップを計算するクラス。
+
     Example:
         from src.saliency import SaliencyMap
 
@@ -19,6 +20,15 @@ class SaliencyMap:
         self,
         algorithm: Literal["SpectralResidual", "FineGrained"] = "SpectralResidual",
     ):
+        """
+        SaliencyMapオブジェクトを初期化します。
+
+        Parameters:
+            algorithm: 使用する顕著性マップアルゴリズムの種類。
+                       有効なアルゴリズムについてはOpenCVのドキュメントを参照してください。
+                       https://docs.opencv.org/4.9.0/d8/d65/group__saliency.html
+
+        """
         self.algorithm = algorithm
         # OpenCVのsaliencyを作成します。
         if algorithm == "SpectralResidual":
@@ -28,17 +38,16 @@ class SaliencyMap:
 
     def compute(self, image: np.ndarray) -> Tuple[bool, Any]:
         """
-        入力画像から顕著性マップを作成します。
+        入力画像から顕著性マップを計算します。
 
         Parameters:
             image: 入力画像
 
         Returns:
-           bool:
-               true: SaliencyMap computed, false:NG
-           np.ndarray: 顕著性マップ               
+            Tuple[bool, Any]: 顕著性マップの計算結果。
+                              bool値がTrueの場合は計算成功、Falseの場合は失敗。
+                              顕著性マップのデータ。
         """
-        # 画像の顕著性を計算します。
         return self.saliency.computeSaliency(image)
 
 
@@ -48,19 +57,24 @@ def convert_colormap(
     colormap_name: Literal["jet", "hot", "turbo"] = "jet"
 ):
     """
-    顕著性マップをカラーマップに変換後に、入力画像に重ね合わせします。
+    入力画像と顕著性マップを合成し、指定されたカラーマップを適用します。
 
     Parameters:
         image: 入力画像
         saliency_map: 顕著性マップ
         colormap_name: カラーマップの種類
+            "jet": Jetカラーマップ
+            "hot": Hotカラーマップ
+            "turbo": Turboカラーマップ
 
     Returns:
-        np.ndarray: 重ね合わせた画像(RGBA形式)
+        np.ndarray: 合成された画像 (RGBA形式)
     """
     maps = {"jet": cv2.COLORMAP_JET, "hot": cv2.COLORMAP_HOT, "turbo": cv2.COLORMAP_TURBO}
+
+    # colormap_nameが有効かどうかをチェック
     if colormap_name not in maps:
-        raise ValueError(colormap_name)
+        raise ValueError(f"Invalid colormap name: {colormap_name}")
 
     # 顕著性マップをカラーマップに変換
     saliency_map = (saliency_map * 255).astype("uint8")

src/utils.py

@@ -6,7 +6,7 @@ import time
 
 def get_package_version() -> str:
     """
-    バージョン情報
+    バージョン情報を取得します。
     """
     return '0.0.8'
 
@@ -29,18 +29,20 @@ class Stopwatch:
     @property
     def elapsed(self) -> float:
         """
-        経過時間を取得します。
+        計測中の経過時間を取得します。
+
+        Returns:
+            float: 計測中の経過時間(小数秒)
         """
         if self._is_running:
-            end_time = time.perf_counter()
-            self._elapsed = end_time - self._start_time
+            self._elapsed = time.perf_counter() - self._start_time
 
         return self._elapsed
 
     @property
     def is_running(self) -> bool:
         """
-        実行中かどうかを取得します。
+        計測が実行中であるかどうかを取得します
         """
         return self._is_running
 
@@ -53,9 +55,12 @@ class Stopwatch:
         self._is_running = True
 
     @classmethod
-    def start_new(cls):
+    def start_new(cls) -> 'Stopwatch':
         """
-        ストップウォッチを生成し計測を開始します。
+        新しいストップウォッチを生成し、計測を開始します。
+
+        Returns:
+            Stopwatch: 新しいストップウォッチオブジェクト
         """
         stopwatch = Stopwatch()
         stopwatch.start()
@@ -63,10 +68,12 @@ class Stopwatch:
 
     def stop(self) -> float:
         """
-        計測を終了します。
+        計測を終了し、経過時間を返します。
+
+        Returns:
+            float: 計測中の経過時間
         """
         if self._is_running:
-            end_time = time.perf_counter()
-            self._elapsed = end_time - self._start_time
+            self._elapsed = time.perf_counter() - self._start_time
             self._is_running = False
         return self._elapsed