Release 0..0.2

README.md

@@ -1,35 +1,41 @@
-# SaliencyMap
-## 概要  
-gradioを使って、opencv-contribパッケージのcv2.saliency.StaticSaliencySpectralResidualを呼び出すサンプルプログラムです。  
-
-私は画像処理についてはまだ初心者ですが、興味を持っています。  
-
-## 導入方法  
-### 1. 仮想環境(venv)に必要ライブラリのインストール  
-- リポジトリ直下にある以下のバッチを実行する。  
-	~~~
-	01-installation.bat
-	~~~
-	> **NOTE**  
-	仮想環境の名称は「venv」で作成します。  
-
-### 2. 実行  
-- リポジトリ直下にある以下のバッチを実行する。  
-	~~~
-	run.bat
-	~~~
-	実行するとブラウザが起動します。  
-	> **NOTE**  
-	> デフォルトポートは9999です。  
-	> 他のポート番号例えば8888に変更したい場合は、run.bat内の以下の行を書き換えてください。  
-	> python src\launch.py --server_port 8888  
-
-## 補足事項  
-- ローカルで処理が完結します。画像を外部には送信しません。  
-
-## Uninstall  
-このアプリをアンインストールするには、以下の手順に従ってください。  
-- アプリのフォルダをフォルダ毎削除してください。  
-
-## 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)  

src/app.py

@@ -17,7 +17,16 @@ __version__ = utils.get_package_version()
 
 def compute_saliency(image: np.ndarray):
     """
-        顕著性MAP画像を作成します。
+        入力画像から顕著性マップを作成しJET画像を返します。
+        Parameters
+    ----------
+    param1 : np.ndarray
+        入力画像
+ 
+    Returns
+    -------
+    np.ndarray
+        カラーマップのJET画像
     """
     # OpenCVのsaliencyを作成
     saliency = cv2.saliency.StaticSaliencySpectralResidual_create()
@@ -40,22 +49,29 @@ def compute_saliency(image: np.ndarray):
 def run(args: argparse.Namespace, watch: utils.Stopwatch) -> None:
     """
         アプリの画面を作成し、Gradioサービスを起動します。
+    ----------
+    param1 : argparse.Namespace
+        コマンドライン引数
+    param2 : utils.Stopwatch
+        起動したスタート時間
     """
     # analytics_enabled=False
     # https://github.com/gradio-app/gradio/issues/4226
     with gr.Blocks(analytics_enabled=False, \
-    	head="""
-    	<meta name="format-detection" content="telephone=no">
-    	<meta name="robots" content="noindex, nofollow">
-    	"""
-    	, title=f"{PROGRAM_NAME} {__version__}") as demo:
+        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")