Merge pull request #10 from umyuu/feature/0.0.8

app.py

@@ -2,7 +2,7 @@
 """
     SaliencyMapDemo
 """
-from argparse import ArgumentParser, BooleanOptionalAction
+
 #from datetime import datetime
 import sys
 from typing import Literal
@@ -11,6 +11,7 @@ import gradio as gr
 import numpy as np
 
 from src import PROGRAM_NAME, get_package_version
+from src.args_parser import parse_args
 from src.reporter import log
 from src.saliency import SaliencyMap, convert_colormap
 from src.utils import Stopwatch
@@ -20,25 +21,6 @@ log.info("#アプリ起動中")
 watch = Stopwatch.start_new()
 
 
-def parse_args():
-    """
-    コマンドライン引数の解析を行います
-    """
-    parser = ArgumentParser(prog=PROGRAM_NAME, description=PROGRAM_NAME)
-    parser.add_argument('--inbrowser',
-                        action=BooleanOptionalAction, default=True, help="Gradio inbrowser")
-    parser.add_argument('--share',
-                        action=BooleanOptionalAction, default=False, help="Gradio share")
-    parser.add_argument('--server_port',
-                        type=int, default=7860, help="Gradio server port")
-    parser.add_argument('--max_file_size',
-                        type=str, default="20MB", help="Gradio max file size")
-    parser.add_argument('--version', 
-                        action='version', version=f'%(prog)s {__version__}')
-
-    return parser.parse_args()
-
-
 def jet_tab_selected(image: np.ndarray):
     """
     JETタブを選択時
@@ -101,6 +83,21 @@ def submit_clicked(image: np.ndarray, algorithm: Literal["SpectralResidual", "Fi
     return jet, hot
 
 
+def gallery_selected(_, evt: gr.SelectData):
+    """
+    ギャラリーの画像が選択されたときに呼び出されるコールバック関数。
+
+    Parameters:
+        _ (Unused): 使用されない引数。
+        evt (gr.SelectData): Gradioのギャラリー選択イベントデータ。
+    Returns:
+        str: 選択されたギャラリー画像のパス。
+    """
+    image_path = evt.value['image']['path']
+
+    return image_path
+
+
 args = parse_args()
 """
 アプリの画面を作成し、Gradioサービスを起動します。
@@ -123,9 +120,15 @@ with gr.Blocks(
         """)
     with gr.Accordion("取り扱い説明書", open=False):
         gr.Markdown("""
-            1. inputタブで画像を選択します。
-            2. Submitボタンを押します。
+            ### 操作説明  
+            顕著性マップデモを使用する手順は以下の通りです：
+            1. inputタブで画像を選択します。下部の📋下部のクリップボードアイコン（コピー&ペーストアイコン）よりクリップボートから入力することも出来ます。  
+            2. Submitボタンを押すと、入力された画像が処理されます。  
             3. 結果は、JETタブとHOTタブに表示します。  
+            ### 活用アイデア🎨  
+            このデモは、創作活動の際に注目するポイントを視覚化するために役立ちます。視覚化された結果を基に、どの部分に加筆が必要かを判断することができます。  
+            例えば、目に注目するポイントが少ない場合は、目を重点的に加筆することで、作品全体の魅力を高めることができるかもしれません。  
+            ご利用いただき、ありがとうございます。  
         """)
     algorithm_type = gr.Radio(
         ["SpectralResidual", "FineGrained"],
@@ -150,6 +153,32 @@ with gr.Blocks(
             # inputs=[image_input],
             # outputs=image_overlay_hot, api_name=False)
     #
+    with gr.Accordion("Sample Image Gallery", open=False):
+        gr.Markdown("""
+            ### 画像のライセンス表示  
+            画像のライセンスはすべてCC0(パブリックドメイン)です。
+        """)
+        gallery = gr.Gallery(type="filepath",
+                             value=["assets/black_256x256.webp",
+                                    "assets/grayscale_256x256.webp",
+                                    "assets/DSC_0108.webp", 
+                                    "assets/DSC_0297.webp"], 
+                             label="Sample Gallery",
+                             interactive=False,
+                             #height=156,
+                             columns=5,
+                             allow_preview=False,
+                             selected_index=0,
+                             preview=False,
+                             show_download_button=False,
+                             show_share_button=False
+                             )
+    # ギャラリー内の画像を選択時
+    gallery.select(gallery_selected,
+                   inputs=[gallery],
+                   outputs=[image_input],
+                   show_api=False
+                   )
     submit_button.click(
         submit_clicked,
         inputs=[image_input, algorithm_type],
@@ -160,9 +189,10 @@ with gr.Blocks(
         App {get_package_version()}  
     """)
 
-    demo.queue(default_concurrency_limit=1)
+    demo.queue(default_concurrency_limit=5)
 
     log.info(f"#アプリ起動完了({watch.elapsed:.3f}s)アプリを終了するにはCtrl+Cキーを入力してください。")
+    log.debug("reload")
 
 
 if __name__ == "__main__":

docs/ThirdPartyNotices.txt

@@ -4,6 +4,14 @@ This repository uses the materials listed or described below.
 
 ---------------------------------------------------------
 
+DSC_0297 - CC0
+https://www.flickr.com/photos/layout_nu/14445520741/
+---------------------------------------------------------
+
+DSC_0108 - CC0
+https://www.flickr.com/photos/layout_nu/14239881090/
+---------------------------------------------------------
+
 Gradio - Apache-2.0
 https://github.com/gradio-app/gradio
 ---------------------------------------------------------

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

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+"""コマンドライン引数の解析"""
+from argparse import ArgumentParser, BooleanOptionalAction
+from . import PROGRAM_NAME, get_package_version
+
+
+def parse_args():
+    """
+    コマンドライン引数の解析を行います
+    """
+    parser = ArgumentParser(prog=PROGRAM_NAME, description=PROGRAM_NAME)
+    parser.add_argument('--inbrowser',
+                        action=BooleanOptionalAction, default=True, help="Gradio inbrowser")
+    parser.add_argument('--share',
+                        action=BooleanOptionalAction, default=False, help="Gradio share")
+    parser.add_argument('--server_port',
+                        type=int, default=7860, help="Gradio server port")
+    parser.add_argument('--max_file_size',
+                        type=str, default="20MB", help="Gradio max file size")
+    parser.add_argument('--version', 
+                        action='version', version=f'%(prog)s {get_package_version()}')
+
+    return parser.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,9 +6,9 @@ import time
 
 def get_package_version() -> str:
     """
-    バージョン情報
+    バージョン情報を取得します。
     """
-    return '0.0.7'
+    return '0.0.8'
 
 
 @dataclass
@@ -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