Merge pull request #2 from umyuu/feature/0.0.2

README.md

@@ -1,26 +1,41 @@
-# saliencymap
-## Introduction  
-gradioを使って、opencv-contribパッケージのcv2.saliency.StaticSaliencySpectralResidualを呼び出すサンプルプログラムです。  
-私は画像処理についてはまだ初心者ですが、興味を持っています。  
-以下から導入方法です。  
-
-## 1. 仮想環境(venv)に必要ライブラリのインストール  
-- リポジトリ直下にある以下のバッチを実行する。  
-	~~~
-	01-installation.bat
-	~~~
-	> **NOTE**  
-	仮想環境の名称は「venv」で作成します。  
-
-## 2. 実行  
-- リポジトリ直下にある以下のバッチを実行する。  
-	~~~
-	run.bat
-	~~~
-	> **NOTE**  
-	> デフォルトポートは9999です。  
-	> 他のポート番号例えば8888に変更したい場合は、run.bat内の以下の行を書き換えてください。  
-	> python src\app.py --server_port 8888  
-
-## Source code License.  
+# SaliencyMap
+## 概要  
+顕著性マップを表示するデモアプリです。  
+私は画像処理についてはまだ初心者ですが、興味を持っています。  
+> **技術的なお話**  
+> opencv-contribパッケージの`cv2.saliency.StaticSaliencySpectralResidual`を呼び出すラッパーアプリです。  
+
+## 導入方法  
+### 1. セットアップ  
+- 以下のファイルをダブルクリックします。  
+~~~
+01-installation.bat
+~~~
+### 2. 実行  
+1. 以下のファイルをダブルクリックします。  
+~~~
+run.bat
+~~~
+2. 実行するとブラウザが起動し[http://127.0.0.1:9999](http://127.0.0.1:9999)を開きます。
+> **NOTE**  
+> デフォルトポート番号は、9999です。  
+> アプリが起動せずポート番号を変更する時は、メモ帳で`run.bat`を開きの以下行の9999を別の数字(8888)などに変更し保存してください。  
+> python src\launch.py --server_port 9999  
+> REM 変更後  
+> python src\launch.py --server_port 8888
+
+## 補足事項  
+- ローカルで処理が完結します。画像を外部には送信しません。  
+
+## Uninstall  
+このアプリをアンインストールするには、以下の手順に従ってください。  
+- アプリのフォルダをフォルダ毎削除してください。  
+- アプリで処理した画像ファイルが一時フォルダに残ります。不要な場合は削除をお願いします。  
+	- 一時フォルダの場所  
+	パソコンの画面左下の「検索するには、ここに入力します」に以下をコピペしてEnterを押します。  
+	~~~
+	C:\Users\%USERNAME%\AppData\Local\Temp\gradio
+	~~~
+	
+## Source code License.  
 [MIT License](LICENSE)  

ThirdPartyNotices.txt

@@ -0,0 +1,18 @@
+NOTICES
+
+This repository uses the materials listed or described below.
+
+---------------------------------------------------------
+
+Gradio - Apache-2.0
+https://github.com/gradio-app/gradio
+---------------------------------------------------------
+
+---------------------------------------------------------
+
+opencv-python - MIT
+https://github.com/opencv/opencv-python
+
+LICENSE-3RD-PARTY.txt
+https://github.com/opencv/opencv-python/blob/master/LICENSE-3RD-PARTY.txt
+---------------------------------------------------------

run.bat

@@ -2,6 +2,6 @@
 
 cd %~dp0
 call venv\Scripts\activate
-python src\app.py --server_port 9999
+python src\launch.py --server_port 9999
 
 TIMEOUT /T 10

src/app.py

@@ -3,15 +3,31 @@
     SaliencyMapDemo
 """
 import argparse
+from datetime import datetime
+import sys
+
 import cv2
 import gradio as gr
 import numpy as np
-import sys
+
+import utils
 
 PROGRAM_NAME = 'SaliencyMapDemo'
-__version__ = '0.0.1'
+__version__ = utils.get_package_version()
 
 def compute_saliency(image: np.ndarray):
+    """
+        入力画像から顕著性マップを作成しJET画像を返します。
+        Parameters
+    ----------
+    param1 : np.ndarray
+        入力画像
+ 
+    Returns
+    -------
+    np.ndarray
+        カラーマップのJET画像
+    """
     # OpenCVのsaliencyを作成
     saliency = cv2.saliency.StaticSaliencySpectralResidual_create()
     # 画像の顕著性を計算
@@ -21,23 +37,41 @@ def compute_saliency(image: np.ndarray):
         # 顕著性マップをカラーマップに変換
         saliencyMap = (saliencyMap * 255).astype("uint8")
         saliencyMap = cv2.applyColorMap(saliencyMap, cv2.COLORMAP_JET)
+        
+        #overlay = saliencyMap
         # 元の画像とカラーマップを重ね合わせ
         overlay = cv2.addWeighted(image, 0.5, saliencyMap, 0.5, 0)
+        
         return overlay
     else:
         return image  # エラーが発生した場合は元の画像を返す
 
-def main(args):    
+def run(args: argparse.Namespace, watch: utils.Stopwatch) -> None:
     """
-        Entry Point
+        アプリの画面を作成し、Gradioサービスを起動します。
+    ----------
+    param1 : argparse.Namespace
+        コマンドライン引数
+    param2 : utils.Stopwatch
+        起動したスタート時間
     """
-    with gr.Blocks() as demo:
+    # analytics_enabled=False
+    # https://github.com/gradio-app/gradio/issues/4226
+    with gr.Blocks(analytics_enabled=False, \
+        title=f"{PROGRAM_NAME} {__version__}", \
+        head="""
+        <meta name="format-detection" content="telephone=no">
+        <meta name="robots" content="noindex, nofollow, noarchive">
+        <meta name="referrer" content="no-referrer" />
+        """) as demo:
+    	
         gr.Markdown(
         """
         # Saliency Map demo.
         1. inputタブで画像を選択します。
-        2. Submitボタンを押します。※外部送信していません。ローカルで完結しています。
-        3. 結果がoverlayタブに表示されます。
+        2. Submitボタンを押します。
+           ※画像は外部送信していません。ローカルで処理が完結します。
+        3. 結果は、overlayタブに表示します。
         """)
 
         submit_button = gr.Button("submit")
@@ -46,26 +80,20 @@ def main(args):
             with gr.Tab("input"):
                 image_input = gr.Image()
             with gr.Tab("overlay"):
-                image_overlay = gr.Image()
+                image_overlay = gr.Image(interactive=False)
 
         
         submit_button.click(compute_saliency, inputs=image_input, outputs=image_overlay)
-        sys.version
+
         gr.Markdown(
         f"""
         Python {sys.version}  
         App {__version__}  
         """)
-        demo.queue(default_concurrency_limit=5).launch(max_file_size=args.max_file_size, server_port=args.server_port)
-
-if __name__ == "__main__":
-    """
-        コマンドライン引数の解析
-    """
-    parser = argparse.ArgumentParser(prog=PROGRAM_NAME, description="SaliencyMapDemo")
-    parser.add_argument('--server_port', type=int, default=9999, help="Gradio server port")
-    parser.add_argument('--max_file_size', type=int, default=20 * gr.FileSize.MB, help="Gradio max file size")
-    parser.add_argument('--version', action='version', version='%(prog)s {0}'.format(__version__))
-
-    main(parser.parse_args())
-
+        
+        demo.queue(default_concurrency_limit=5)
+        
+        print(f"{datetime.now()}:アプリ起動完了({watch.stop():.3f}s)")
+        
+        # https://www.gradio.app/docs/gradio/blocks#blocks-launch
+        demo.launch(max_file_size=args.max_file_size, server_port=args.server_port, inbrowser=True, share=False)

src/launch.py

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+"""
+    SaliencyMapDemo
+"""
+import argparse
+from datetime import datetime
+
+from utils import get_package_version, Stopwatch
+
+def main():
+	"""
+		エントリーポイント
+		コマンドライン引数の解析を行います
+	"""
+	print(f"{datetime.now()}:アプリ起動中")
+	watch = Stopwatch.startNew()
+
+	import app
+
+	parser = argparse.ArgumentParser(prog=app.PROGRAM_NAME, description="SaliencyMapDemo")
+	parser.add_argument('--server_port', type=int, default=9999, help="Gradio server port")
+	parser.add_argument('--max_file_size', type=int, default=20 * 1024 * 1024, help="Gradio max file size")
+	parser.add_argument('--version', action='version', version=f'%(prog)s {get_package_version()}')
+	
+	app.run(parser.parse_args(), watch)
+
+if __name__ == "__main__":
+	main()

src/utils.py

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+import time
+
+def get_package_version() -> str:
+    return '0.0.2'
+
+class Stopwatch:
+    """
+    Stopwatch 経過時間を計測するためのクラスです。
+    """
+
+    def __init__(self):
+        self._start_time = None
+        self._elapsed = 0;
+
+    @property
+    def Elapsed(self):
+        return self._elapsed
+
+    def start(self) -> None:
+        self._start_time = time.perf_counter()
+        self._elapsed = 0;
+
+    @classmethod
+    def startNew(cls):
+        stopwatch = Stopwatch()
+        stopwatch.start()
+        return stopwatch
+
+    def stop(self):
+        end_time = time.perf_counter()
+        self._elapsed = end_time - self._start_time
+        return self._elapsed
+