Skip to content

Commit a3e8fd0

Browse files
BenzeneHexBenzeneHex
authored
Merge pull request #16 from InteractiveGraphicsLab/README
Create README
2 parents 1d1e265 + 27bff9f commit a3e8fd0

11 files changed

Lines changed: 217 additions & 1 deletion

‎README.md‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/HowToBuild.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
[TOPページ](README.md)
2+
3+
# 自分でビルドする
4+
以下の手順でビルドできます．
5+
6+
1. Visual Studio 2022をインストール．
7+
2. Visual Studio Installer を起動し，"Visual Studio 2022"の"変更"を選択する．
8+
3. "Desktop development with C++"の"C++/CLI support for v143 build tools"と"MSVC v143 - VS 2022 C++ x64/x86 build tools"にチェックをつけてインストールする．
9+
4. [こちら](https://github.com/InteractiveGraphicsLab/RoiPainter)からソースコードをダウンロードするか，以下のリポジトリをクローンする．
10+
```https://github.com/InteractiveGraphicsLab/RoiPainter.git```
11+
5. ソースコードの"RoiPainter4D/RoiPainter4D.sln"を開き，ビルド設定を"Release"でビルドを実行する ("Debug"ではないことに注意)．
12+
6. "RoiPainter4D/x64/Release/RoiPainter4D.exe"を実行する．

‎docs/HowToBuild_en.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
[TOP Page](README_en.md)
2+
3+
# How to build
4+
You can build the project by following these steps:
5+
6+
1. Install Visual Studio 2022.
7+
2. Launch the Visual Studio Installer and select "Modify" for "Visual Studio 2022."
8+
3. Check "C++/CLI support for v143 build tools" and "MSVC v143 - VS 2022 C++ x64/x86 build tools" under "Desktop development with C++" and install them.
9+
4. Download the source code [here](https://github.com/InteractiveGraphicsLab/RoiPainter) or clone the following repository:
10+
```https://github.com/InteractiveGraphicsLab/RoiPainter.git```
11+
5. Open the source code file "RoiPainter4D/RoiPainter4D.sln" and build it with the build configuration set to "Release" (make sure it is not set to "Debug").
12+
6. Run "RoiPainter4D/x64/Release/RoiPainter4D.exe."

‎docs/ModeCurveDeform.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
[TOPページ](README.md)
2+
3+
# 曲線制約によるマスク編集（Ref Curve Deform モード）
4+
このモードでは，関心領域の正確な境界を曲線で直接指定することにより，マスク画像を編集できます．
5+
6+
## 前準備
7+
8+
1. まだ4DCT画像を読み込んでいない場合は，[こちら](ModeVisNormal.md)を参考に4DCT画像を読み込んでください．
9+
2. まだマスク画像を読み込んでいない場合は，[こちら](ModeVisMask.md)を参考にマスク画像を読み込んでください．
10+
3. ウィンドウ左上の"mode switch"から，"Ref Curve Deform"モードを選択してください．
11+
4. 編集の対象とするマスクを選択し，"OK"をクリックしてください．
12+
13+
## 使い方
14+
15+
<!-- ref_curve_deform_demo.mp4 -->
16+
https://github.com/user-attachments/assets/ac83da3b-0555-48ea-95de-bb3ac88154b1
17+
18+
1. 「Convert mask -> mesh」ボタンを押し，マスクをメッシュに変換します．
19+
2. 関心領域の正しい境界に曲線制約を配置します．曲線制約は制御点により配置でき，制御点はSHIFT+左クリックで配置できます．
20+
3. 曲線制約を十分に配置したら，「Deform」ボタンを押します．これにより，関心領域が配置した曲線に沿うように変形されます．
21+
4. 編集が完了したら，「Convert mesh -> mask」ボタンを押し，メッシュをマスクに戻します．
22+
23+
<!-- ## 曲線の操作
24+
Coming Soon... -->

‎docs/ModeRGrow.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[TOPページ](README.md)
2+
3+
# 領域成長法による領域分割
4+
Coming Soon...

‎docs/ModeStrokeFfd.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[TOPページ](README.md)
2+
3+
# 曲線制約によるテンプレート変形
4+
Coming Soon...

‎docs/ModeStrokeTrim.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[TOPページ](README.md)
2+
3+
# マスク画像から特定の領域を削除
4+
Coming Soon...

‎docs/ModeVisMask.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
[TOPページ](README.md)
2+
3+
# マスク画像を読込・表示する
4+
5+
## 1. 4DCT画像を読み込む
6+
まだ4DCT画像を読み込んでいない場合は，[こちら](ModeVisNormal.md)を参考に4DCT画像を読み込んでください．
7+
8+
## 2. マスク画像を読み込む
9+
4DCT画像を読み込んだら，以下の手順でマスク画像を読み込みます．
10+
11+
1. メインウィンドウ左上のFileメニューから，ファイルの形式に応じた`Load Mask`を選択します．
12+
2. ファイル選択ウィンドウより，読み込むマスク画像のファイルを**すべて**選択します．
13+
3. スタック方向を逆転するか選択するダイアログが出現します．基本的に「いいえ」を選択します．
14+
読み込むファイルによってはスタック方向が逆になっているので，「いいえ」を選択して上手くいかなかった場合は1.からやり直して「はい」を選択してください．
15+
4. しばらくすると，読み込みが完了します．
16+
17+
<!-- load_mask.mp4 -->
18+
https://github.com/user-attachments/assets/6b62e3ce-066b-4600-831f-f1a7ff8aa3ba
19+
20+
## マスク操作
21+
22+
<!-- dialog_mask.png -->
23+
![dialog_mask](https://github.com/user-attachments/assets/1cb90ed9-0e8d-4ba4-b674-d2dd81f1cd95)
24+
25+
### 1. マスク選択（赤枠）
26+
管理・編集の対象とするマスクをクリックして選択します．
27+
28+
### 2. マスク管理（青枠）
29+
30+
| 操作 | 説明 |
31+
| --- | --- |
32+
| Lock | オンにすると，選択中のマスクが他のマスクに対する操作によって編集されなくなります． |
33+
| color | 選択中のマスクの色を変更できます． |
34+
| alpha | 選択中のマスクの透明度を変更できます． |
35+
| DELETE | 選択中のマスクが削除されます． |
36+
| MARGE TO | 選択中のマスクと新たに選択するもう1つのマスクが，1つのマスクとして結合されます． |
37+
38+
39+
### 3. マスク編集（緑枠）
40+
左側が現在のフレームに対する操作，右側が全フレームに対する操作となります．
41+
42+
| 操作 | 説明 |
43+
| --- | --- |
44+
| erode | 選択中のマスク領域が収縮します． |
45+
| dilate | 選択中のマスク領域が膨張します． |
46+
| fill hole | 選択中のマスク領域に存在する穴を埋めようと試みます． |
47+
| Exp Obj | 選択中のマスクをメッシュ(.obj)として出力します． |
48+
| Imp Obj | メッシュ(.obj)を取り込み新たなマスクとして登録します． |
49+
50+
## 関連ページ
51+
52+
* 読み込んだマスク画像を編集したい → [曲線制約によるマスク編集](ModeCurveDeform.md)・[マスク画像から特定の領域を削除](ModeStrokeTrim.md)

‎docs/ModeVisNormal.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
[TOPページ](README.md)
2+
3+
# 4DCT画像を読込・表示する
4+
5+
## 4DCT画像を読み込む
6+
以下の手順で4DCT画像を読み込みます．
7+
8+
1. メインウィンドウ左上のFileメニューから，ファイルの形式に応じた`Open 4DCT`を選択します．
9+
2. ファイル選択ウィンドウより，読み込む4DCT画像のファイルを**すべて**選択します．
10+
3. ファイルの読み込む順番を変更できます．特に問題が無ければ，`Import Files`を選択します．
11+
4. しばらくすると，読み込みが完了します．
12+
13+
<!-- load_4dct.mp4 -->
14+
https://github.com/user-attachments/assets/56f91993-9653-4ff7-8520-21586ac0674f
15+
16+
## 操作方法
17+
4DCT画像を読み込んだ後は，様々な操作を行うことができます．
18+
19+
### 視点操作
20+
視点の移動：マウス左ボタンを押したまま移動
21+
視点の角度変更：マウス右ボタンを押したまま移動
22+
ズーム：マウスホイールを押したまま上下でズームイン/ズームアウト
23+
24+
<!-- move_viewpoint.mp4 -->
25+
https://github.com/user-attachments/assets/383bd147-4309-473f-a88d-71893f192565
26+
27+
### 断面操作
28+
断面にカーソルを合わせてマウスホイールを転がすと可視化する断面を変更できます．
29+
また，右上のダイアログでどの断面を可視化するか選択できます．
30+
31+
<!-- move_slice.mp4 -->
32+
https://github.com/user-attachments/assets/08278b4f-ce9b-4670-bdb6-c1c857fcea40
33+
34+
## その他の操作
35+
36+
<!-- dialog_param.png -->
37+
![dialog_param](https://github.com/user-attachments/assets/f597ac35-7bff-455f-9403-c3cd724c3c2e)
38+
39+
### 1. 全体設定（赤枠）
40+
41+
| 操作 | 説明 |
42+
| --- | --- |
43+
| frame | オンにすると，4DCT画像の周囲に外枠フレームが表示されます． |
44+
| volume | オンにすると，4DCT画像中の物体が3次元可視化されたボリュームが表示されます． |
45+
| pseudo | オンにすると，輝度に応じてカラー表示されるようになります． |
46+
| indicator | オンにすると，画面左下に視点の向きを示すインディケーターが現れます． |
47+
| Plane | 各チェックボックスをオンにすると，その断面が表示されます． |
48+
| Background | 背景色を変更できます． |
49+
50+
### 2. ボリューム可視化設定（青枠）
51+
52+
| 操作 | 説明 |
53+
| --- | --- |
54+
| Opacify | ボリュームの透明度を変更できます． |
55+
| Num of slice | ボリュームの細かさを変更できます． |
56+
| ヒストグラム | マウスでドラッグすると，表示する範囲を変更できます． |
57+
58+
### 3. フレーム移動（緑枠）
59+
このスライダーを動かすと，4DCT画像のフレームを移動できます．
60+
61+
## 関連ページ
62+
63+
* マスク画像を読み込みたい → [マスク画像の読込・表示](ModeVisMask.md)
64+
* 輝度の差により関心領域を分割したい → [領域成長法による領域分割](ModeRGrow.md)
65+
* テンプレート形状に基づいて組織形状を作成したい → [曲線制約によるテンプレート変形](ModeStrokeFfd.md)

‎docs/README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
[日本語](README.md) | [English](README_en.md)
2+
3+
# RoiPainter
4+
5+
## 導入方法
6+
[こちら](https://github.com/InteractiveGraphicsLab/RoiPainter/releases)より，最新のRoiPainter4Dをダウンロードできます．
7+
1. [ダウンロードページ](https://github.com/InteractiveGraphicsLab/RoiPainter/releases)のAssets → `RoiPainter4D.zip`をダウンロードし，解凍します．
8+
2. 解凍したフォルダ中の`RoiPainter4D.exe`を起動します．
9+
10+
または，ソースコードから[自分でビルド](HowToBuild.md)することもできます．
11+
12+
## 使い方
13+
14+
### データの読み込み
15+
16+
* 4DCT画像を読み込みたい → [4DCT画像の読込・表示](ModeVisNormal.md)
17+
* マスク画像を読み込みたい → [マスク画像の読込・表示](ModeVisMask.md)
18+
19+
### 領域の編集
20+
21+
* 読み込んだマスク画像を編集したい → [曲線制約によるマスク編集](ModeCurveDeform.md)
22+
23+
※他の機能の説明は後日追加予定
24+
25+
<!-- * 輝度の差により関心領域を分割したい → [領域成長法による領域分割](ModeRGrow.md)
26+
* テンプレート形状に基づいて組織形状を作成したい → [曲線制約によるテンプレート変形](ModeStrokeFfd.md)
27+
* 読み込んだマスク画像を編集したい → [曲線制約によるマスク編集](ModeCurveDeform.md)・[マスク画像から特定の領域を削除](ModeStrokeTrim.md) -->

0 commit comments

Comments
 (0)