Diff of /README.md [000000] .. [094e4c]

Switch to unified view

a b/README.md
1
## Background
2
### TigerHx: Tissue Mask Generation for Heart
3
* This repo provides deep learning methods with pretrained models for brain extraction.
4
* We also provided the stand-alone application working on Windows, Mac, and Linux.
5
* The software has been exclusively designed for research purposes and is not intended for any commercial application.
6
* The software should not be used in clinical applications.
7
8
![tigerhx](./doc/tigerhx.png)
9
10
### Install stand-alone version
11
    https://github.com/htylab/tigerhx/releases
12
### Install package
13
    pip install onnxruntime #for gpu version: onnxruntime-gpu
14
    pip install https://github.com/htylab/tigerhx/archive/main.zip
15
    
16
## Usage
17
    import tigerhx
18
    tigerhx.run('', r'C:\sample\cine4d.nii.gz', r'c:\temp') #Segmentation only
19
    tigerhx.run('r', r'C:\sample\cine4d.nii.gz', r'c:\temp')
20
    tigerhx.run('rg', r'C:\sample\cine4d.nii.gz', r'c:\temp') # with GPU
21
22
### As a command line tool:
23
24
    tigerhx -r c:\data\*.nii.gz -o c:\output
25
26
27
# Label names:
28
29
## cine4d
30
| Label No. | Structure Name            |
31
| --------- | ------------------------- |
32
| 1         | Left Ventricle blood      |
33
| 2         | Left Ventricle Myocardium |
34
| 3         | Right Ventricle blood     |
35
36
## Disclaimer
37
38
The software has been exclusively designed for research purposes and has not undergone review or approval by the Food and Drug Administration or any other agency. By using this software, you acknowledge and agree that it is not recommended nor advised for clinical applications.  You also agree to use, reproduce, create derivative works of, display, and distribute the software in compliance with all applicable governmental laws, regulations, and orders, including but not limited to those related to export and import control.
39
40
The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. In no event shall the contributors be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software. Use of the software is at the recipient's own risk.
41